Documentation Grafana Alloy Reference Components discovery discovery.consul

discovery.consul

discovery.consul allows you to retrieve scrape targets from Consul’s Catalog API.

Usage

alloy Copy

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 block
• basic_auth block
• bearer_token_file argument
• bearer_token argument
• oauth2 block

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.

basic_auth

The basic_auth block configures basic authentication to the endpoint.

oauth2

The oauth2 block configures OAuth 2.0 authentication to the endpoint.

tls_config

The tls_config block configures TLS settings for connecting to the endpoint.

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:

alloy Copy

discovery.consul "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.consul has exports that can be consumed by the following components:

• Components that consume Targets