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.

Documentation Grafana Agent Flow mode Reference Components reference discovery.dockerswarm

discovery.dockerswarm

discovery.dockerswarm allows you to retrieve scrape targets from Docker Swarm.

Usage

river Copy

discovery.dockerswarm "LABEL" {
  host = "DOCKER_DAEMON_HOST"
  role = "SWARM_ROLE"
}

Arguments

The following arguments are supported:

Blocks

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

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

filter block

Filters can be used to limit the discovery process to a subset of available resources. It is possible to define multiple filter blocks within the discovery.dockerswarm block. The list of available filters depends on the role:

• services filters
• tasks filters
• nodes filters

The following arguments can be used to configure a filter.

basic_auth block

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

authorization block

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

oauth2 block

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

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:

Roles

The role attribute decides the role of the targets to retrieve.

services

The services role discovers all Swarm services and exposes their ports as targets. For each published port of a service, a single target is generated. If a service has no published ports, a target per service is created using the port attribute defined in the arguments.

Available meta labels:

• __meta_dockerswarm_service_id: the ID of the service.
• __meta_dockerswarm_service_name: the name of the service.
• __meta_dockerswarm_service_mode: the mode of the service.
• __meta_dockerswarm_service_endpoint_port_name: the name of the endpoint port, if available.
• __meta_dockerswarm_service_endpoint_port_publish_mode: the publish mode of the endpoint port.
• __meta_dockerswarm_service_label_<labelname>: each label of the service.
• __meta_dockerswarm_service_task_container_hostname: the container hostname of the target, if available.
• __meta_dockerswarm_service_task_container_image: the container image of the target.
• __meta_dockerswarm_service_updating_status: the status of the service, if available.
• __meta_dockerswarm_network_id: the ID of the network.
• __meta_dockerswarm_network_name: the name of the network.
• __meta_dockerswarm_network_ingress: whether the network is ingress.
• __meta_dockerswarm_network_internal: whether the network is internal.
• __meta_dockerswarm_network_label_<labelname>: each label of the network.
• __meta_dockerswarm_network_scope: the scope of the network.

tasks

The tasks role discovers all Swarm tasks and exposes their ports as targets. For each published port of a task, a single target is generated. If a task has no published ports, a target per task is created using the port attribute defined in the arguments.

Available meta labels:

• __meta_dockerswarm_container_label_<labelname>: each label of the container.
• __meta_dockerswarm_task_id: the ID of the task.
• __meta_dockerswarm_task_container_id: the container ID of the task.
• __meta_dockerswarm_task_desired_state: the desired state of the task.
• __meta_dockerswarm_task_slot: the slot of the task.
• __meta_dockerswarm_task_state: the state of the task.
• __meta_dockerswarm_task_port_publish_mode: the publish mode of the task port.
• __meta_dockerswarm_service_id: the ID of the service.
• __meta_dockerswarm_service_name: the name of the service.
• __meta_dockerswarm_service_mode: the mode of the service.
• __meta_dockerswarm_service_label_<labelname>: each label of the service.
• __meta_dockerswarm_network_id: the ID of the network.
• __meta_dockerswarm_network_name: the name of the network.
• __meta_dockerswarm_network_ingress: whether the network is ingress.
• __meta_dockerswarm_network_internal: whether the network is internal.
• __meta_dockerswarm_network_label_<labelname>: each label of the network.
• __meta_dockerswarm_network_label: each label of the network.
• __meta_dockerswarm_network_scope: the scope of the network.
• __meta_dockerswarm_node_id: the ID of the node.
• __meta_dockerswarm_node_hostname: the hostname of the node.
• __meta_dockerswarm_node_address: the address of the node.
• __meta_dockerswarm_node_availability: the availability of the node.
• __meta_dockerswarm_node_label_<labelname>: each label of the node.
• __meta_dockerswarm_node_platform_architecture: the architecture of the node.
• __meta_dockerswarm_node_platform_os: the operating system of the node.
• __meta_dockerswarm_node_role: the role of the node.
• __meta_dockerswarm_node_status: the status of the node.

The __meta_dockerswarm_network_* meta labels are not populated for ports which are published with mode=host.

nodes

The nodes role is used to discover Swarm nodes.

Available meta labels:

• __meta_dockerswarm_node_address: the address of the node.
• __meta_dockerswarm_node_availability: the availability of the node.
• __meta_dockerswarm_node_engine_version: the version of the node engine.
• __meta_dockerswarm_node_hostname: the hostname of the node.
• __meta_dockerswarm_node_id: the ID of the node.
• __meta_dockerswarm_node_label_<labelname>: each label of the node.
• __meta_dockerswarm_node_manager_address: the address of the manager component of the node.
• __meta_dockerswarm_node_manager_leader: the leadership status of the manager component of the node (true or false).
• __meta_dockerswarm_node_manager_reachability: the reachability of the manager component of the node.
• __meta_dockerswarm_node_platform_architecture: the architecture of the node.
• __meta_dockerswarm_node_platform_os: the operating system of the node.
• __meta_dockerswarm_node_role: the role of the node.
• __meta_dockerswarm_node_status: the status of the node.

Component health

discovery.dockerswarm is only reported as unhealthy when given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

discovery.dockerswarm does not expose any component-specific debug information.

Debug metrics

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

Example

This example discovers targets from Docker Swarm tasks:

river Copy

discovery.dockerswarm "example" {
  host = "unix:///var/run/docker.sock"
  role = "tasks"

  filter {
    name = "id"
    values = ["0kzzo1i0y4jz6027t0k7aezc7"]
  }

  filter {
    name = "desired-state"
    values = ["running", "accepted"]
  }
}

prometheus.scrape "demo" {
  targets    = discovery.dockerswarm.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.dockerswarm has exports that can be consumed by the following components:

• Components that consume Targets