All Products
Search
Document Center

Application Real-Time Monitoring Service:Use Terraform to manage the integration center of a Prometheus instance

Last Updated:Dec 04, 2023

You can use Terraform to manage the exporters and remote write resources in the integration center of Managed Service for Prometheus. This topic describes how to use Terraform to manage the integration center of a Prometheus instance.

Prerequisites

  • A Prometheus instance for Container Service or ECS is created. For more information, see Use Terraform to manage Prometheus instances.

  • Terraform is installed.

    Note

    You must install Terraform 0.12.28 or later. You can run the terraform --version command to query the Terraform version.

    • By default, Cloud Shell is preinstalled with Terraform and configured with your account information. You do not need to modify the configurations.

    • If you do not use Cloud Shell, you can directly install Terraform. For more information, see Install and configure Terraform in the local PC.

  • Your Alibaba Cloud account information is configured. You can use one of the following methods to configure Alibaba Cloud account information:

    Note

    To improve the flexibility and security of permission management, we recommend that you create a Resource Access Management (RAM) user named Terraform. Then, create an AccessKey pair for the RAM user and grant permissions to the RAM user. For more information, see Create a RAM user and Grant permissions to a RAM user.

    • Method 1: Add environment variables to store authentication information.

      export ALICLOUD_ACCESS_KEY="************"
      export ALICLOUD_SECRET_KEY="************"
      export ALICLOUD_REGION="cn-beijing"
      Note

      Specify the value of the export ALICLOUD_REGION parameter based on your business requirements.

    • Method 2: Specify identity information in the provider section of the configuration file.

      provider "alicloud" {
        access_key = "************"
        secret_key = "************"
        region     = "cn-beijing"
      }
      Note

      Specify the value of the export ALICLOUD_REGION parameter based on your business requirements.

Configure a component in the integration center of a Prometheus instance

  1. Create a working directory and a file named main.tf in the directory.

    provider "alicloud" {
    }
  2. Run the following command to initialize the environment for Terraform:

    terraform init

    Expected output:

    Initializing the backend...
    
    Initializing provider plugins...
    - Checking for available provider plugins...
    - Downloading plugin for provider "alicloud" (hashicorp/alicloud) 1.90.1...
    ...
    
    You may now begin working with Terraform. Try running "terraform plan" to see
    any changes that are required for your infrastructure. All Terraform commands
    should now work.
    
    If you ever set or change modules or backend configuration for Terraform,
    rerun this command to reinitialize your working directory. If you forget, other
    commands will detect it and remind you to do so if necessary.
  3. Import the component resources of the integration center.

    1. Add the component resources to the main.tf file.

      # The exporter of the component. The exporter of the Kafka component is used as an example. 
      resource "alicloud_arms_integration_exporter" "myKafkaExporter" 
      {
          cluster_id       = "c77e1106f429e4b46b0ee1720c*****"   # The ID of the Prometheus instance.
          integration_type = "kafka"  # The type of the component. Valid values: mysql, redis, node_exporter_for_vpc, kafka, emr, nebula, tidb, windows, snmp, ahpa, and knative.
          # Configure the JSON parameters of the param field based on the component type. For more information about the param field, see the "Parameters of the param field for various components" section. 
          param  = jsonencode(
          {
            name                         = "kafka1"
            ip_ports                     = "abc11:1889"
            sasl_enabled                 = "none=sasl.enabled"
            sasl_mechanism               = ""
            scrape_interval              = 33
            tls_enabled                  = "none=tls.enabled"
            tls_insecure-skip-tls-verify = "none=tls.insecure-skip-tls-verify"
            version                      = "0.10.1.0"
          }
        )
      }
      Note

      You must configure the JSON parameters of the param field based on the component type. For more information about the param field, see Parameters of the param field for various components.

    2. Run the following command to create an execution plan:

      terraform plan

      Expected output:

      Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
        + create
      
      Terraform will perform the following actions:
      
        # alicloud_arms_integration_exporter.myKafkaExporter will be created
        + resource "alicloud_arms_integration_exporter" "myKafkaExporter" {
            + cluster_id       = "c77e1106f429e4b46b0ee1720c9*****"
            + id               = (known after apply)
            + instance_id      = (known after apply)
            + integration_type = "kafka"
            + param            = jsonencode(
                  {
                    + ip_ports                     = "abc:8881"
                    + name                         = "myKafka1"
                    + sasl_enabled                 = "none=sasl.enabled"
                    + sasl_mechanism               = ""
                    + scrape_interval              = 30
                    + tls_enabled                  = "none=tls.enabled"
                    + tls_insecure-skip-tls-verify = "none=tls.insecure-skip-tls-verify"
                    + version                      = "0.10.1.0"
                  }
              )
          }
      
      Plan: 1 to add, 0 to change, 0 to destroy.
                                      
    3. Run the following command to create an exporter:

      terraform apply

      Expected output:

      Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
        + create
      
      Terraform will perform the following actions:
      
        # alicloud_arms_integration_exporter.myKafkaExporter will be created
        + resource "alicloud_arms_integration_exporter" "myKafkaExporter" {
            + cluster_id       = "c77e1106f429e4b46b0ee1720c*****"
            + id               = (known after apply)
            + instance_id      = (known after apply)
            + integration_type = "kafka"
            + param            = jsonencode(
                  {
                    + ip_ports                     = "abc:8881"
                    + name                         = "my-kafka1"
                    + sasl_enabled                 = "none=sasl.enabled"
                    + sasl_mechanism               = ""
                    + scrape_interval              = 30
                    + tls_enabled                  = "none=tls.enabled"
                    + tls_insecure-skip-tls-verify = "none=tls.insecure-skip-tls-verify"
                    + version                      = "0.10.1.0"
                  }
              )
          }
      
      Plan: 1 to add, 0 to change, 0 to destroy.
      
      Do you want to perform these actions?
        Terraform will perform the actions described above.
        Only 'yes' will be accepted to approve.
      
        Enter a value: yes
                                      

      If yes is returned, the Kafka component is integrated into the Prometheus instance.

Verify the result

You can log on to the Managed Service for Prometheus console and view the Kafka component on the Integration Center page of the Prometheus instance. To do this, perform the following steps:

  1. Log on to the ARMS console.
  2. In the left-side navigation pane, choose Prometheus Service > Prometheus Instances.
  3. Click the name of the Prometheus instance instance that you want to manage to go to the Integration Center page.

  4. Click the Kafka component in the Installed section. In the panel that appears, click the Exporter tab.

Delete a component from the integration center of a Prometheus instance

Procedure

You can run the following command to delete a cluster created by using Terraform:

terraform destroy

Expected output

...
Do you really want to destroy all resources?
  Terraform will destroy all your managed infrastructure, as shown above.
  There is no undo. Only 'yes' will be accepted to confirm.

  Enter a value: yes
...
Destroy complete! Resources: 1 destroyed.

Verify the result

You can log on to the Managed Service for Prometheus console and go to the Integration Center page of the Prometheus instance to check that the component is deleted.

  1. Log on to the ARMS console.
  2. In the left-side navigation pane, choose Prometheus Service > Prometheus Instances.
  3. Click the name of the Prometheus instance instance that you want to manage to go to the Integration Center page.

  4. Click the Kafka component in the Installed section. In the panel that appears, click the Exporter tab. If the corresponding exporter does not exist, the component is deleted.

Parameters of the param field for various components

Kafka (Basic Edition)

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

my-kafka1

ip_ports

kafka address

Yes

String

The Kafka address. Format: service:port or ip:port. Separate multiple addresses with semicolons (;).

my_kafka1.ns:9092

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

version

kafka version

Yes

String

The version of the Kafka kernel.

2.0.1

sasl_enabled

SASL enabled

Yes

String

  • Enable SASL: sasl.enabled

  • Disable SASL: none=sasl.enabled

sasl.enabled

sasl_username

SASL username

No

String

The username of the Simple Authentication and Security Layer (SASL) user.

user1

sasl_password

SASL password

No

String

The password of the SASL user.

pwd1

sasl_mechanism

SASL mechanism

Yes

String

Valid values:

  • Null

  • plain

  • scram-sha512

  • scram-sha256

Null

tls_enabled

TLS enabled

Yes

String

  • Enable TLS: tls.enabled

  • Disable TLS: none=tls.enabled

none=tls.enabled

tls_insecure-skip-tls-verify

insecure skip TLS verify

Yes

String

  • Enable TLS verification: tls.insecure-skip-tls-verify

  • Disable Enable TLS verification: none=tls.insecure-skip-tls-verify

none=tls.insecure-skip-tls-verify

Kafka (Advanced Edition)

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Intance name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

kafka-exporter1

kafka_instance

Kafka instance name

Yes

String

Managed Service for Prometheus uses this name to identify the corresponding Kafka Producer, Kafka Server, and Kafka Consumer.

myKafka1

__label_key

Pod/ECS Label Key (service discovery)

Yes

String

The key of the pod tag or ECS tag used for service discovery.

kafka

__label_value

Pod/ECS Label value

Yes

String

The value of the pod tag or ECS tag used for service discovery.

myKafka1

port

JMX Agent listening port

Yes

Integer

The listening port of the JMX agent.

5556

metrics_path

Metrics path

Yes

String

The path in which monitoring data is stored.

/metrics

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Windows

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

win-exporter1

__label_key

Pod/ECS Label Key (service discovery)

Yes

String

The key of the pod tag or ECS tag used for service discovery.

win

__label_value

Pod/ECS Label value

Yes

String

The value of the pod tag or ECS tag used for service discovery.

myWin1

port

Exporter listening port

Yes

Integer

The listening port of the exporter.

9182

metrics_path

Scrape path

Yes

String

The path in which monitoring data is stored.

/metrics

scrape_interval

Scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Nebula

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

nebula-exporter1

__label_key_metad

MetaD ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for MetaD service discovery.

nebula

__label_value_metad

Label value of MetaD monitor

Yes

String

The value of the ECS tag used for MetaD service discovery.

myNebula1

metad_port

MetaD metrics listening port

Yes

Integer

The listening port of the MetaD exporter.

19559

__label_key_graphd

GraphD ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for GraphD service discovery.

nebula

__label_value_graphd

ECS tag value of GraphD

Yes

String

The value of the ECS tag used for GraphD service discovery.

myNebula1

graphd_port

GraphD metrics listening port

Yes

Integer

The listening port of the GraphD exporter.

19669

__label_key_storaged

StorageD ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for StorageD service discovery.

nebula

__label_value_storaged

Label value of StorageD monitor

Yes

String

The value of the ECS tag used for StorageD service discovery.

myNebula1

storaged_port

StorageD metrics listening port

Yes

Integer

The listening port of the StorageD exporter.

19779

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

TiDB

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

tidb-exporter1

__label_key_tidb

TiDBServer Pod/ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for TiDBServer service discovery.

nebula

__label_value_tidb

Label value of TiDBServer monitor

Yes

String

The value of the ECS tag used for TiDBServer service discovery.

myNebula1

tidb_port

TiDBServer metrics listening port

Yes

Integer

The listening port of the TiDBServer.

10080

tidb_metrics_path

TiDBServer Metrics path

Yes

String

The path in which the TiDBServer monitoring data is stored.

/metrics

__label_key_tikv

TiKVServer Pod/ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for TiKVServer service discovery.

nebula

__label_value_tikv

Label value of TiKVServer monitor

Yes

String

The value of the ECS tag used for TiKVServer service discovery.

myNebula1

tikv_port

TiKVServer metrics listening port

Yes

Integer

The listening port of the TiKVServer.

20180

tikv_metrics_path

TiKVServer Metrics path

Yes

String

The path in which TiKVServer monitoring data is stored.

/metrics

__label_key_tipd

TiPDServer Pod/ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for TiPDServer service discovery.

nebula

__label_value_tipd

Label value of TiPDServer monitor

Yes

String

The value of the ECS tag used for TiPDServer service discovery.

myNebula1

tipd_port

TiPDServer metrics listening port

Yes

Integer

The listening port of the TiPDServer.

2379

tipd_metrics_path

TiPDServer Metrics path

Yes

String

The path in which TiPDServer monitoring data is stored.

/metrics

__label_key_ting

TiControlServer Pod/ECS Label Key(Service Discovery)

Yes

String

The key of the ECS tag used for TiControlServer service discovery.

nebula

__label_value_ting

Label value of ControlServer monitor

Yes

String

The value of the ECS tag used for TiControlServer service discovery.

myNebula1

ting_port

TiControlServer metrics listening port

Yes

Integer

The listening port of the TiControlServer.

12020

ting_metrics_path

TiControlServer Metrics path

Yes

String

The path in which TiControlServer monitoring data is stored.

/metrics

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

E-MapReduce

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Intance name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

taihao-exporter

cluster_id

EMR cluster id

Yes

String

You can obtain the cluster ID from the E-MapReduce (EMR) console.

c-7ea355e06e9*****

cluster_name

EMR cluster name

Yes

String

You can obtain the cluster name from the EMR console.

emr-demo

port

exporter port

Yes

Integer

The listening port of the exporter.

9712

metrics_path

Scrape path

Yes

String

The path in which monitoring data is stored.

/metrics_preget

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

__label_key

ECS Label Key (service discovery)

Yes

String

The key of the ECS tag used for service discovery.

acs:emr:nodeGroupType

__label_value

ECS Label value

Yes

String

The value of the ECS tag used for service discovery. Separate multiple tag values with commas (,). If a tag value is matched, the monitoring data is collected.

CORE,MASTER

Knative

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

knative-exporter

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Jenkins

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Intance name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

jenkins-exporter1

jenkins_server_endpoint

Jenkins server endpoint

Yes

String

The address must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

jenkins-server1

jenkins_server_username

Jenkins server username

Yes

String

The username must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

jenkins_server_password

Jenkins server password

Yes

String

The password must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

port

Jenkins exporter listening port

Yes

Integer

The listening port of the Jenkins exporter.

9118

metrics_path

Metrics path

Yes

String

The path in which monitoring data is stored.

/metrics

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

AHPA

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

ahpa-exporter

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

SNMP

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Intance name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

snmp-exporter

device_addr

SNMP device IP ADDR

Yes

String

The IPv4 address of the SNMP device.

127.0.0.1

metrics_path

Metrics path

Yes

String

The path in which monitoring data is stored.

/snmp

dev_community

community for snmp device

Yes

String

The community of the SNMP device.

public

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Nginx Ingress Gateway Monitor

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Config Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

ingressv2-exporter

pod_selector_key

Ingress Controller Label Selector Key

Yes

String

The key must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The key must start with a lowercase letter.

app

pod_selector_value

Ingress Controller Label Selector Value

Yes

String

The value must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The value must start with a lowercase letter.

ingress-nginx

pod_namespace_value

Ingress Controller Namespace

Yes

String

The namespace must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The namespace must start with a lowercase letter.

kube-system

ingress_class_name_value

Ingress Class Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

nginx

Clickhouse

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Intance name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

clickhouse-exporter

ip_port

clickhouse scrape address

Yes

String

The address of the ClickHouse service. Format: ip:port.

127.0.0.1:80

clickhouse_user

clickhouse user name

Yes

String

The username must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

clickhouse_password

clickhouse password

Yes

String

The password must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Fluid

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 3 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

fluid-exporter

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

CoreDNS (ASK)

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

Set the value to default.

default

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Managed CoreDNS (ASK)

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

Set the value to default.

default

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Ingress performance monitoring (ASK)

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

Set the value to default.

default

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

MySQL

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

mysql-exporter

ip

MySQL Address

Yes

String

Separate multiple addresses with commas (,).

127.0.0.1

port

MySQL Port

Yes

String

The port of the MySQL instance.

3306

userName

Username

Yes

String

The username must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

password

Password

Yes

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

cpu

CPU (Cores)

No

String

The number of vCPUs.

100m

memory

memory

No

String

The memory of the exporter.

50Mi

Redis

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

redis-exporter

ip

Redis Address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

redis-server

port

Redis Port

Yes

String

The port of the Redis instance.

6379

password

Password

No

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

RabbitMQ

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

rabbitmq-exporter

ip

RabbitMQ Address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

rabbitmq-server

port

RabbitMQ Port

Yes

String

The port of the RabbitMQ service.

15672

userName

Username

Yes

String

The username must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

password

Password

Yes

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

RocketMQ

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

rocketmq-exporter

namesrvAddr

RocketMQ Address

Yes

String

Separate multiple addresses with semicolons (;).

rocketmq-server:8976

accessKey

Username

No

String

The username must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

secretKey

Password

No

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

Zookeeper

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

zk-exporter

ip

Zookeeper Address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

zk-server

port

Zookeeper Port

Yes

String

The port of the ZooKeeper service.

2181

MongoDB

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

mongodb-exporter

ip

MongoDB Address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

mongodb-server

port

MongoDB Port

Yes

String

The port of the MongoDB instance.

3717

userName

Username

No

String

The username must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

password

Password

No

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

PostgreSQL

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

pgsql-exporter

ip

PostgreSQL Address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

pgsql-server

port

PostgreSQL Port

Yes

String

The port of the PostgreSQL instance.

5432

userName

Username

No

String

The username must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

password

Password

No

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

MicroMeter

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

my-exporter1

__label_key

Pod/ECS Label Key (service discovery)

Yes

String

The tag key used to collect metrics from the ECS instance or the pod.

my-app

__label_value

Pod/ECS Label value

Yes

String

The tag value used to collect metrics from the ECS instance or the pod.

java-micrometer1

port

MicroMeter listening port

Yes

Integer

The listening port.

8080

metrics_path

Metrics path

Yes

String

The path in which monitoring data is stored.

/actuator/prometheus

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Cassandra

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Intance name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

my-exporter-1

__label_key

ECS Label Key (service discovery)

Yes

String

The key of the ECS tag used for service discovery.

cassandra-prom-jmx

__label_value

ECS Label value

Yes

String

The value of the ECS tag used for service discovery.

my-cassandra-1

port

JMX Agent listening port

Yes

Integer

The JMX listening port.

9103

metrics_path

Metrics path

Yes

String

The path in which monitoring data is stored.

/metrics

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

Memcached

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

my-exporter-1

ip_host

memcached address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

memcached-server

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30

SQLServer

Parameter of the param field

Parameter in the console

Required

Type

Description

Example

name

Exporter Name

Yes

String

The name must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.

my-exporter-1

ip

sqlserver address

Yes

String

The address must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The address must start with a lowercase letter.

sql-server

port

sqlserver port

Yes

String

The listening port.

4000

username

sqlserver username

Yes

String

The username must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The username must start with a lowercase letter.

user1

password

sqlserver password

Yes

String

The password must be 1 to 32 characters in length, and can contain lowercase letters, digits, and hyphens (-). The password must start with a lowercase letter.

pwd

scrape_interval

Metrics scrape interval (seconds)

Yes

Integer

The interval at which monitoring data is collected. Unit: seconds.

30