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

discovery.dockerswarm

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

用法

alloy 复制

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

参数

您可以将以下参数用于 discovery.dockerswarm

最多只能提供以下其中一项

• authorization 块
• basic_auth 块
• bearer_token_file 参数
• bearer_token 参数
• 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 块。

authorization

authorization 块配置到端点的通用授权。

credential 和 credentials_file 相互排斥，authorization 块内部只能提供其中之一。

basic_auth

basic_auth 块配置到端点的基本身份验证。

password 和 password_file 相互排斥，basic_auth 块内部只能提供其中之一。

filter

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

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

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

oauth2

oauth 块配置到端点的 OAuth 2.0 身份验证。

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

tls_config 块配置连接到端点的 TLS 设置。

以下参数对相互排斥，不能同时设置

• 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_network_id: 网络的 ID。
• __meta_dockerswarm_network_ingress: 网络是否为 ingress。
• __meta_dockerswarm_network_internal: 网络是否为 internal。
• __meta_dockerswarm_network_label_<labelname>: 网络的每个标签。
• __meta_dockerswarm_network_name: 网络的名称。
• __meta_dockerswarm_network_scope: 网络的范围。
• __meta_dockerswarm_service_endpoint_port_name: 端点端口的名称，如果可用。
• __meta_dockerswarm_service_endpoint_port_publish_mode: 端点端口的发布模式。
• __meta_dockerswarm_service_id: 服务的 ID。
• __meta_dockerswarm_service_label_<labelname>: 服务的每个标签。
• __meta_dockerswarm_service_mode: 服务的模式。
• __meta_dockerswarm_service_name: 服务的名称。
• __meta_dockerswarm_service_task_container_hostname: 目标的容器主机名，如果可用。
• __meta_dockerswarm_service_task_container_image: 目标的容器镜像。
• __meta_dockerswarm_service_updating_status: 服务的状态，如果可用。

tasks

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

可用元标签

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

__meta_dockerswarm_network_* 元标签不会为以 mode=host 发布模式发布的端口填充。

nodes

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: 节点的 manager 组件的地址。
• __meta_dockerswarm_node_manager_leader: 节点的 manager 组件的领导状态 (true 或 false)。
• __meta_dockerswarm_node_manager_reachability: 节点的 manager 组件的可达性。
• __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 具有可被以下组件消费的导出

• 消费 Targets 的组件