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

Docker 发现

discovery.docker 发现 Docker Engine 容器并将其公开为目标。

用法

alloy 复制

discovery.docker "LABEL" {
  host = DOCKER_ENGINE_HOST
}

参数

支持以下参数

最多只能提供以下一项

• 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.docker 的定义中支持以下块

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

filter 块

filter 块配置要传递给 Docker Engine 的过滤器，以限制返回的容器数量。可以多次指定 filter 块以提供多个过滤器。

有关支持的过滤器的列表及其含义，请参阅 Docker Engine API 文档中的 列出容器。

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）

导出字段

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

每个目标都包含以下标签

• __meta_docker_container_id：容器的 ID。
• __meta_docker_container_name：容器的名称。
• __meta_docker_container_network_mode：容器的网络模式。
• __meta_docker_container_label_<labelname>：容器中的每个标签。
• __meta_docker_network_id：容器所在的 Docker 网络的 ID。
• __meta_docker_network_name：容器所在的 Docker 网络的名称。
• __meta_docker_network_ingress：如果 Docker 网络是入口网络，则设置为 true。
• __meta_docker_network_internal：如果 Docker 网络是内部网络，则设置为 true。
• __meta_docker_network_label_<labelname>：容器所在的网络中的每个标签。
• __meta_docker_network_scope：容器所在的网络的范围。
• __meta_docker_network_ip：容器在网络中的 IP。
• __meta_docker_port_private：容器上的私有端口。
• __meta_docker_port_public：容器公开的端口（如果存在端口映射）。
• __meta_docker_port_public_ip：容器的公共 IP（如果存在端口映射）。

每个发现的容器都映射到每个容器使用的网络和端口映射的唯一组合的一个目标。

组件健康状况

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

调试信息

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

调试指标

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

示例

Linux 或 macOS 主机

此示例在主机是 macOS 或 Linux 时发现 Docker 容器

alloy 复制

discovery.docker "containers" {
  host = "unix:///var/run/docker.sock"
}

prometheus.scrape "demo" {
  targets    = discovery.docker.containers.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 进行身份验证的密码。

Windows 主机

此示例在主机是 Windows 时发现 Docker 容器

alloy 复制

discovery.docker "containers" {
  host = "tcp://127.0.0.1:2375"
}

prometheus.scrape "demo" {
  targets    = discovery.docker.containers.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 进行身份验证的密码。

注意：此示例要求在 Docker Engine 设置中启用“在 tcp://127.0.0.1:2375 上公开守护程序，不使用 TLS”设置。

兼容组件

discovery.docker 具有可由以下组件使用的导出项

• 使用 目标 的组件