文档 Grafana Alloy 参考 组件 发现 discovery.dockerswarm

Docker Swarm 发现

discovery.dockerswarm 允许您从 Docker Swarm 检索抓取目标。

用法

alloy 复制

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

参数

支持以下参数

最多只能提供以下一项

• bearer_token 参数.
• bearer_token_file 参数.
• basic_auth 块.
• authorization 块.
• oauth2 块.

no_proxy 可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy，则必须配置 proxy_url。

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY（或其小写版本）。请求使用与它们的方案匹配的环境变量中的代理，除非被 NO_PROXY 排除。如果配置了 proxy_from_environment，则不得配置 proxy_url 和 no_proxy。

仅当配置了 proxy_url 或 proxy_from_environment 时，才应配置 proxy_connect_header。

块

在 discovery.dockerswarm 的定义中支持以下块

> 符号表示更深层次的嵌套。例如，oauth2 > tls_config 指的是在 oauth2 块中定义的 tls_config 块。

filter 块

过滤器可用于将发现过程限制到可用资源的子集。可以在 discovery.dockerswarm 块中定义多个 filter 块。可用过滤器的列表取决于 role

• services 过滤器
• tasks 过滤器
• nodes 过滤器

以下参数可用于配置过滤器。

basic_auth 块

password 和 password_file 是互斥的，并且在 basic_auth 块中只能提供一个。

authorization 块

credential 和 credentials_file 是互斥的，并且在 authorization 块中只能提供一个。

oauth2 块

client_secret 和 client_secret_file 是互斥的，并且在 oauth2 块中只能提供一个。

oauth2 块还可以包含一个单独的 tls_config 子块。

no_proxy 可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy，则必须配置 proxy_url。

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY（或其小写版本）。请求使用与它们的方案匹配的环境变量中的代理，除非被 NO_PROXY 排除。如果配置了 proxy_from_environment，则不得配置 proxy_url 和 no_proxy。

仅当配置了 proxy_url 或 proxy_from_environment 时，才应配置 proxy_connect_header。

tls_config 块

以下参数对是互斥的，不能同时设置

• ca_pem 和 ca_file
• cert_pem 和 cert_file
• key_pem 和 key_file

配置客户端身份验证时，必须同时提供客户端证书（使用 cert_pem 或 cert_file）和客户端密钥（使用 key_pem 或 key_file）。

当未提供 min_version 时，可接受的最小 TLS 版本将从 Go 的默认最小版本 TLS 1.2 继承。如果提供了 min_version，则必须将其设置为以下字符串之一

• "TLS10" (TLS 1.0)
• "TLS11" (TLS 1.1)
• "TLS12" (TLS 1.2)
• "TLS13" (TLS 1.3)

导出字段

以下字段已导出，可以被其他组件引用

角色

role 属性决定要检索的目标的角色。

services

services 角色发现所有 Swarm 服务 并将其端口公开为目标。对于服务的每个已发布端口，都会生成一个目标。如果服务没有已发布端口，则会使用参数中定义的 port 属性为每个服务创建一个目标。

可用的元标签

• __meta_dockerswarm_service_id：服务的 ID。
• __meta_dockerswarm_service_name：服务的名称。
• __meta_dockerswarm_service_mode：服务的模式。
• __meta_dockerswarm_service_endpoint_port_name：端点端口的名称（如果可用）。
• __meta_dockerswarm_service_endpoint_port_publish_mode：端点端口的发布模式。
• __meta_dockerswarm_service_label_<labelname>：服务的每个标签。
• __meta_dockerswarm_service_task_container_hostname：目标的容器主机名（如果可用）。
• __meta_dockerswarm_service_task_container_image：目标的容器镜像。
• __meta_dockerswarm_service_updating_status：服务的状体（如果可用）。
• __meta_dockerswarm_network_id：网络的 ID。
• __meta_dockerswarm_network_name：网络的名称。
• __meta_dockerswarm_network_ingress：网络是否为入口。
• __meta_dockerswarm_network_internal：网络是否为内部网络。
• __meta_dockerswarm_network_label_<labelname>：网络的每个标签。
• __meta_dockerswarm_network_scope：网络的范围。

tasks

tasks 角色发现所有 Swarm 任务 并将其端口公开为目标。对于任务的每个已发布端口，都会生成一个目标。如果任务没有已发布端口，则会使用参数中定义的 port 属性为每个任务创建一个目标。

可用的元标签

• __meta_dockerswarm_container_label_<labelname>：容器的每个标签。
• __meta_dockerswarm_task_id：任务的 ID。
• __meta_dockerswarm_task_container_id：任务的容器 ID。
• __meta_dockerswarm_task_desired_state：任务的所需状体。
• __meta_dockerswarm_task_slot：任务的槽位。
• __meta_dockerswarm_task_state：任务的状体。
• __meta_dockerswarm_task_port_publish_mode：任务端口的发布模式。
• __meta_dockerswarm_service_id：服务的 ID。
• __meta_dockerswarm_service_name：服务的名称。
• __meta_dockerswarm_service_mode：服务的模式。
• __meta_dockerswarm_service_label_<labelname>：服务的每个标签。
• __meta_dockerswarm_network_id：网络的 ID。
• __meta_dockerswarm_network_name：网络的名称。
• __meta_dockerswarm_network_ingress：网络是否为入口。
• __meta_dockerswarm_network_internal：网络是否为内部网络。
• __meta_dockerswarm_network_label_<labelname>：网络的每个标签。
• __meta_dockerswarm_network_label：网络的每个标签。
• __meta_dockerswarm_network_scope：网络的范围。
• __meta_dockerswarm_node_id：节点的 ID。
• __meta_dockerswarm_node_hostname：节点的主机名。
• __meta_dockerswarm_node_address：节点的地址。
• __meta_dockerswarm_node_availability：节点的可用性。
• __meta_dockerswarm_node_label_<labelname>：节点的每个标签。
• __meta_dockerswarm_node_platform_architecture：节点的架构。
• __meta_dockerswarm_node_platform_os：节点的操作系统。
• __meta_dockerswarm_node_role：节点的角色。
• __meta_dockerswarm_node_status：节点的状态。

如果端口使用 mode=host 模式发布，则不会填充 __meta_dockerswarm_network_* 元标签。

节点

nodes 角色用于发现 Swarm 节点。

可用的元标签

• __meta_dockerswarm_node_address：节点的地址。
• __meta_dockerswarm_node_availability：节点的可用性。
• __meta_dockerswarm_node_engine_version：节点引擎的版本。
• __meta_dockerswarm_node_hostname：节点的主机名。
• __meta_dockerswarm_node_id：节点的 ID。
• __meta_dockerswarm_node_label_<labelname>：节点的每个标签。
• __meta_dockerswarm_node_manager_address：节点管理器组件的地址。
• __meta_dockerswarm_node_manager_leader：节点管理器组件的领导者状态（true 或 false）。
• __meta_dockerswarm_node_manager_reachability：节点管理器组件的可达性。
• __meta_dockerswarm_node_platform_architecture：节点的架构。
• __meta_dockerswarm_node_platform_os：节点的操作系统。
• __meta_dockerswarm_node_role：节点的角色。
• __meta_dockerswarm_node_status：节点的状态。

组件健康状况

只有在给出无效配置时，discovery.dockerswarm 才会报告为不健康。在这些情况下，导出字段会保留其最后健康的值。

调试信息

discovery.dockerswarm 不会公开任何特定于组件的调试信息。

调试指标

discovery.dockerswarm 不会公开任何特定于组件的调试指标。

示例

此示例从 Docker Swarm 任务中发现目标。

alloy 复制

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
    }
  }
}

替换以下内容

• PROMETHEUS_REMOTE_WRITE_URL：要将指标发送到的与 Prometheus remote_write 兼容的服务器的 URL。
• USERNAME：用于对 remote_write API 进行身份验证的用户名。
• PASSWORD：用于对 remote_write API 进行身份验证的密码。

兼容组件

discovery.dockerswarm 具有可被以下组件使用的导出内容

• 使用 目标 的组件