discovery.consul
discovery.consul
allows you to retrieve scrape targets from Consul’s Catalog API.
Usage
discovery.consul "<LABEL>" {
server = "<CONSUL_SERVER>"
}
Arguments
You can use the following arguments with discovery.consul
:
At most, one of the following can be provided:
authorization
blockbasic_auth
blockbearer_token_file
argumentbearer_token
argumentoauth2
block
no_proxy
can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers.
proxy_url
must be configured if no_proxy
is configured.
proxy_from_environment
uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof).
Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.
proxy_url
and no_proxy
must not be configured if proxy_from_environment
is configured.
proxy_connect_header
should only be configured if proxy_url
or proxy_from_environment
are configured.
Blocks
You can use the following blocks with discovery.consul
:
The > symbol indicates deeper levels of nesting.
For example, oauth2 > tls_config
refers to a tls_config
block defined inside an oauth2
block.
authorization
The authorization
block configures generic authorization to the endpoint.
credential
and credentials_file
are mutually exclusive, and only one can be provided inside an authorization
block.
basic_auth
The basic_auth
block configures basic authentication to the endpoint.
password
and password_file
are mutually exclusive, and only one can be provided inside a basic_auth
block.
oauth2
The oauth
block configures OAuth 2.0 authentication to the endpoint.
client_secret
and client_secret_file
are mutually exclusive, and only one can be provided inside an oauth2
block.
The oauth2
block may also contain a separate tls_config
sub-block.
no_proxy
can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers.
proxy_url
must be configured if no_proxy
is configured.
proxy_from_environment
uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof).
Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.
proxy_url
and no_proxy
must not be configured if proxy_from_environment
is configured.
proxy_connect_header
should only be configured if proxy_url
or proxy_from_environment
are configured.
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_consul_address
: The address of the target.__meta_consul_metadata_<key>
: Each node metadata key value of the target.__meta_consul_node
: The node name defined for the target.__meta_consul_partition
: The administrator partition name where the service is registered.__meta_consul_service_address
: The service address of the target.__meta_consul_service_id
: The service ID of the target.__meta_consul_service_metadata_<key>
: Each service metadata key value of the target.__meta_consul_service_port
: The service port of the target.__meta_consul_service
: The name of the service the target belongs to.__meta_consul_tagged_address_<key>
: Each node tagged address key value of the target.__meta_consul_tags
: The list of tags of the target joined by the tag separator.
Component health
discovery.consul
is only reported as unhealthy when given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
discovery.consul
doesn’t expose any component-specific debug information.
Debug metrics
discovery.consul
doesn’t expose any component-specific debug metrics.
Example
This example discovers targets from Consul 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.consul
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.