When you manage monitoring integrations manually through the console, configuration drift and inconsistency across environments become difficult to track. The alicloud_arms_integration_exporter Terraform resource lets you define exporters as code, version-control them, and apply changes consistently. This covers creating and deleting integration center exporters for a Managed Service for Prometheus instance.
Quick start
The following minimal configuration creates a Kafka exporter in an existing Prometheus instance:
provider "alicloud" {}
resource "alicloud_arms_integration_exporter" "kafka" {
cluster_id = "c77e1106f429e4b46b0ee1720c*****"
integration_type = "kafka"
param = jsonencode({
name = "my-kafka1"
ip_ports = "broker1.example.com:9092"
scrape_interval = 30
version = "0.10.1.0"
sasl_enabled = "none=sasl.enabled"
sasl_mechanism = ""
tls_enabled = "none=tls.enabled"
tls_insecure-skip-tls-verify = "none=tls.insecure-skip-tls-verify"
})
}
Run terraform init && terraform apply to provision the exporter. For the full walkthrough, see Create an integration exporter. For all supported component parameters, see Component parameter reference.
Supported components
The integration_type attribute accepts the following values: mysql, redis, node_exporter_for_vpc, kafka, emr, nebula, tidb, windows, snmp, ahpa, and knative.
The following table lists all supported components and their integration_type values:
Component |
| Authentication |
Kafka (Basic Edition) |
| Optional SASL/TLS |
Kafka (Advanced Edition) |
| JMX Agent |
MySQL |
| Username/password |
Redis |
| Optional password |
Windows |
| Service discovery |
NebulaGraph |
| Service discovery |
TiDB |
| Service discovery |
E-MapReduce |
| Service discovery |
Knative |
| None |
AHPA |
| None |
SNMP |
| Community string |
Nginx Ingress Gateway Monitor |
| Label selector |
Jenkins | -- | Username/password |
ClickHouse | -- | Username/password |
Fluid | -- | None |
CoreDNS (ASK) | -- | None |
Managed CoreDNS (ASK) | -- | None |
Ingress performance monitoring (ASK) | -- | None |
RabbitMQ | -- | Username/password |
RocketMQ | -- | Optional access key |
ZooKeeper | -- | None |
MongoDB | -- | Optional username/password |
PostgreSQL | -- | Optional username/password |
Micrometer | -- | Service discovery |
Cassandra | -- | Service discovery |
Memcached | -- | None |
SQL Server | -- | Username/password |
Components marked with -- have parameter tables documented below but their integration_type values are not explicitly listed in the API documentation. Refer to the console or API documentation for the exact values.
Create an integration exporter
The following steps walk through initializing Terraform, defining an exporter resource, and applying the configuration. A Kafka exporter is used as the example, but you can substitute any component type from the Component parameter reference.
Step 1: Set up credentials
Create a dedicated Resource Access Management (RAM) user named Terraform and grant it the required permissions. See Create a RAM user and Grant permissions to a RAM user.
Provide credentials using one of the following methods:
Environment variables (recommended)
export ALICLOUD_ACCESS_KEY="<your-access-key-id>"
export ALICLOUD_SECRET_KEY="<your-access-key-secret>"
export ALICLOUD_REGION="<region-id>"
Variable | Description | Example |
| AccessKey ID of your RAM user |
|
| AccessKey Secret of your RAM user |
|
| Region where your Prometheus instance resides |
|
Provider block
provider "alicloud" {
access_key = "<your-access-key-id>"
secret_key = "<your-access-key-secret>"
region = "<region-id>"
}
Hardcoding credentials in configuration files is less secure than using environment variables. Do not commit credentials to version control.
Step 2: Initialize the working directory
This step sets up the Terraform working environment and downloads the Alibaba Cloud provider plugin.
-
Verify you have Terraform 0.12.28 or later installed:
terraform --versionCloud Shell comes with Terraform preinstalled and preconfigured. To install locally, see Install and configure Terraform.
NoteResource Orchestration Service (ROS) is a native infrastructure-as-code (IaC) service provided by Alibaba Cloud that also supports Terraform template integration. By using Terraform with ROS, you can define and manage resources in Alibaba Cloud, Amazon Web Services (AWS), or Microsoft Azure, specify resource parameters, and configure dependency relationships. For more information, see Create a Terraform template and Create a Terraform stack.
-
Create a working directory and a file named
main.tfwith a provider block:provider "alicloud" { } -
Initialize Terraform:
terraform initA successful output ends with:
You may now begin working with Terraform. Try running "terraform plan" to see any changes that are required for your infrastructure.
You also need a Prometheus instance for Container Service for Kubernetes or Elastic Compute Service (ECS). If you have not created one, see .
Step 3: Define the exporter resource
Add an alicloud_arms_integration_exporter resource to main.tf. The following example configures a Kafka exporter:
resource "alicloud_arms_integration_exporter" "kafka" {
cluster_id = "<prometheus-instance-id>"
integration_type = "kafka"
param = jsonencode({
name = "my-kafka1"
ip_ports = "<kafka-host>:<kafka-port>"
scrape_interval = 30
version = "0.10.1.0"
sasl_enabled = "none=sasl.enabled"
sasl_mechanism = ""
tls_enabled = "none=tls.enabled"
tls_insecure-skip-tls-verify = "none=tls.insecure-skip-tls-verify"
})
}
Replace the placeholders:
Placeholder | Description | Example |
| ID of your Prometheus instance |
|
| Kafka broker address in |
|
Resource attributes:
Attribute | Required | Description |
| Yes | ID of the Prometheus instance |
| Yes | Component type. See Supported components for valid values. |
| Yes | JSON-encoded object with component-specific parameters. Use |
Step 4: Preview and apply
-
Preview the changes:
terraform planThe output shows the resources to be created:
Plan: 1 to add, 0 to change, 0 to destroy. -
Apply the configuration:
terraform applyType
yeswhen prompted. After completion, the exporter is added to the integration center.
Verify the result
Log on to the ARMS console.
In the left-side navigation pane, choose Managed Service for Prometheus > Instances.
Click the name of your Prometheus instance to open the Integration Center page.
In the Installed section, click the Kafka component, then click the Exporter tab. The exporter you created appears in the list.
Delete an integration exporter
Run the following command to destroy all Terraform-managed resources in the current working directory:
terraform destroy
Type yes when prompted. The output confirms:
Destroy complete! Resources: 1 destroyed.
Verify the result
Log on to the ARMS console.
In the left-side navigation pane, choose Managed Service for Prometheus > Instances.
Click the name of your Prometheus instance to open the Integration Center page.
In the Installed section, click the Kafka component, then click the Exporter tab. If the exporter is no longer listed, the deletion succeeded.
Component parameter reference
Each component type requires a different set of parameters in the param field. Pass the value as a JSON-encoded HCL map using jsonencode().
Common parameters: Most components share these parameters:
Parameter | Description | Type | Example |
| Exporter name. Lowercase letters, digits, and hyphens. Must start with a lowercase letter. Length varies by component: 3-32 characters for most components, 1-32 characters for MySQL, Redis, RabbitMQ, RocketMQ, ZooKeeper, MongoDB, PostgreSQL, Micrometer, Cassandra, Memcached, and SQL Server. | String |
|
| Metrics collection interval in seconds. | Integer |
|
The following sections list component-specific parameters.
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: |
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 |
|
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 |
|
tls_enabled |
TLS enabled |
Yes |
String |
|
none=tls.enabled |
|
tls_insecure-skip-tls-verify |
insecure skip TLS verify |
Yes |
String |
|
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 |
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 |
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 |
NebulaGraph
|
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 |
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 |
SQL Server
|
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 |
Related topics
Use Terraform to manage Prometheus instances -- Create and manage Prometheus instances with Terraform.
Create a Terraform template -- Use Resource Orchestration Service (ROS) to manage Terraform templates across Alibaba Cloud, AWS, or Microsoft Azure.
Create a Terraform stack -- Deploy Terraform templates through ROS.