This is documentation for the next version of Agent. For the latest stable release, go to the latest version.

DocumentationGrafana AgentFlow modeReferenceComponents referencediscovery.consulagent

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 will be watched. This is suitable for very large Consul clusters for which using the Catalog API would be too slow or resource intensive.

Usage

river Copy

discovery.consulagent "LABEL" {
  server = CONSUL_SERVER
}

Arguments

The following arguments are supported:

Blocks

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

tls_config block

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:

Each target includes the following labels:

• __meta_consulagent_address: the address of the target.
• __meta_consulagent_dc: the datacenter 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: the name of the service the target belongs to.
• __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_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 does not expose any component-specific debug information.

Debug metrics

• discovery_consulagent_rpc_failures_total (Counter): The number of Consul Agent RPC call failures.
• discovery_consulagent_rpc_duration_seconds (SummaryVec): The duration of a Consul Agent RPC call in seconds.

Example

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

river Copy

discovery.consulagent "example" {
  server = "localhost:8500"
  services = [
    "service1",
    "service2",
  ]
}

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

prometheus.remote_write "demo" {
  endpoint {
    url = PROMETHEUS_REMOTE_WRITE_URL

    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.

Compatible components

discovery.consulagent has exports that can be consumed by the following components:

• Components that consume Targets