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

发现dockerswarm

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和域名可以包含端口号。proxy_url 必须配置，如果配置了 no_proxy。

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

proxy_connect_header 应仅当配置了 proxy_url 或 proxy_from_environment 时进行配置。

块

以下块可以在 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和域名可以包含端口号。proxy_url 必须配置，如果配置了 no_proxy。

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

proxy_connect_header 应仅当配置了 proxy_url 或 proxy_from_environment 时进行配置。

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）

导出字段

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

Roles

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_：节点的每个标签。
• __meta_dockerswarm_node_platform_architecture：节点的架构。
• __meta_dockerswarm_node_platform_os：节点的操作系统。
• __meta_dockerswarm_node_role：节点的角色。
• __meta_dockerswarm_node_status：节点的状态。

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

节点

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_：节点的每个标签。
• __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远程写入兼容服务器的URL。
• USERNAME：用于远程写入API认证的用户名。
• PASSWORD：用于远程写入API认证的密码。

兼容组件

discovery.dockerswarm导出的内容可以被以下组件消费

• 消费目标的组件