discovery.consulagent
discovery.consulagent
allows you to retrieve scrape targets from Consul’s Agent API.
Only the services registered with the local agent running on the same host are watched.
This is suitable for very large Consul clusters for which using the Catalog API would be too slow or resource intensive.
Usage
discovery.consulagent "<LABEL>" {
server = "<CONSUL_SERVER>"
}
Arguments
You can use the following arguments with discovery.consulagent
:
Blocks
You can use the following blocks with discovery.consulagent
:
tls_config
The tls_config
block configures TLS settings for connecting to the endpoint.
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_file
When configuring client authentication, both the client certificate (using cert_pem
or cert_file
) and the client key (using key_pem
or key_file
) must be provided.
When min_version
isn’t provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2.
If min_version
is provided, it must be set to one of the following strings:
"TLS10"
(TLS 1.0)"TLS11"
(TLS 1.1)"TLS12"
(TLS 1.2)"TLS13"
(TLS 1.3)
Exported fields
The following fields are exported and can be referenced by other components:
Each target includes the following labels:
__meta_consulagent_address
: The address of the target.__meta_consulagent_dc
: The data center name for the target.__meta_consulagent_health
: The health status of the service.__meta_consulagent_metadata_<key>
: Each node metadata key value of the target.__meta_consulagent_node
: The node name defined for the target.__meta_consulagent_service_address
: The service address of the target.__meta_consulagent_service_id
: The service ID of the target.__meta_consulagent_service_metadata_<key>
: Each service metadata key value of the target.__meta_consulagent_service_port
: The service port of the target.__meta_consulagent_service
: The name of the service the target belongs to.__meta_consulagent_tagged_address_<key>
: Each node tagged address key value of the target.__meta_consulagent_tags
: The list of tags of the target joined by the tag separator.
Component health
discovery.consulagent
is only reported as unhealthy when given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
discovery.consulagent
doesn’t expose any component-specific debug information.
Debug metrics
discovery_consulagent_rpc_duration_seconds
(SummaryVec): The duration of a Consul Agent RPC call in seconds.discovery_consulagent_rpc_failures_total
(Counter): The number of Consul Agent RPC call failures.
Example
This example discovers targets from a Consul Agent for the specified list of services:
Replace the following:
<PROMETHEUS_REMOTE_WRITE_URL>
: The URL of the Prometheus remote_write-compatible server to send metrics to.<USERNAME>
: The username to use for authentication to theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
Compatible components
discovery.consulagent
has exports that can be consumed by the following components:
- Components that consume Targets
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.