Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source


discovery.consul allows retrieving scrape targets from Consul’s Catalog API.


discovery.consul "LABEL" {
  server = CONSUL_SERVER


The following arguments are supported:

serverstringHost and port of the Consul API.localhost:8500no
tokensecretSecret token used to access the Consul
datacenterstringDatacenter to query. If not provided, the default is
namespacestringNamespace to use (only supported in Consul Enterprise).no
partitionstringAdmin partition to use (only supported in Consul Enterprise).no
tag_separatorstringThe string by which Consul tags are joined into the tag label.,no
schemestringThe scheme to use when talking to Consul.httpno
usernamestringThe username to use (deprecated in favor of the basic_auth configuration).no
passwordsecretThe password to use (deprecated in favor of the basic_auth configuration).no
allow_staleboolAllow stale Consul results (see official documentation). Will reduce load on Consul.trueno
serviceslist(string)A list of services for which targets are retrieved. If omitted, all services are
tagslist(string)An optional list of tags used to filter nodes for a given service. Services must contain all tags in the
node_metamap(string)Node metadata key/value pairs to filter nodes for a given
refresh_intervaldurationFrequency to refresh list of containers."30s"no
bearer_tokensecretBearer token to authenticate
bearer_token_filestringFile containing a bearer token to authenticate
proxy_urlstringHTTP proxy to proxy requests
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
enable_http2boolWhether HTTP2 is supported for requests.trueno

At most one of the following can be provided:


The following blocks are supported inside the definition of discovery.consul:

basic_authbasic_authConfigure basic_auth for authenticating to the
authorizationauthorizationConfigure generic authorization to the
oauth2oauth2Configure OAuth2 for authenticating to the
oauth2 > tls_configtls_configConfigure TLS settings for connecting to the

The > symbol indicates deeper levels of nesting. For example, oauth2 > tls_config refers to a tls_config block defined inside an oauth2 block.

basic_auth block

password_filestringFile containing the basic auth
passwordsecretBasic auth
usernamestringBasic auth

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

authorization block

credentials_filestringFile containing the secret
typestringAuthorization type, for example, “Bearer”.no

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

oauth2 block

client_idstringOAuth2 client
client_secret_filestringFile containing the OAuth2 client
client_secretsecretOAuth2 client
endpoint_paramsmap(string)Optional parameters to append to the token
proxy_urlstringOptional proxy URL for OAuth2
scopeslist(string)List of scopes to authenticate
token_urlstringURL to fetch the token

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.

tls_config block

ca_pemstringCA PEM-encoded text to validate the server
ca_filestringCA certificate to validate the server
cert_pemstringCertificate PEM-encoded text for client
cert_filestringCertificate file for client
insecure_skip_verifyboolDisables validation of the server
key_filestringKey file for client
key_pemsecretKey PEM-encoded text for client
min_versionstringMinimum acceptable TLS
server_namestringServerName extension to indicate the name of the

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

  • ca_pem and ca_file
  • cert_pem and cert_file
  • key_pem and key_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 is not 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:

targetslist(map(string))The set of targets discovered from the Consul catalog API.

Each target includes the following labels:

  • __meta_consul_address: the address of the target.
  • __meta_consul_dc: the datacenter name for the target.
  • __meta_consul_health: the health status of the service.
  • __meta_consul_partition: the admin partition name where the service is registered.
  • __meta_consul_metadata_<key>: each node metadata key value of the target.
  • __meta_consul_node: the node name defined for the target.
  • __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 does not expose any component-specific debug information.

Debug metrics

discovery.consul does not expose any component-specific debug metrics.


This example discovers targets from Consul for the specified list of services:

discovery.consul "example" {
  server = "localhost:8500"
  services = [

prometheus.scrape "demo" {
  targets    = discovery.consul.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]

prometheus.remote_write "demo" {
  endpoint {

    basic_auth {
      username = USERNAME
      password = PASSWORD

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 the remote_write API.
  • PASSWORD: The password to use for authentication to the remote_write API.