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

discovery.puppetdb

discovery.puppetdb 允许您从 PuppetDB 资源中检索抓取目标。

此 SD 发现资源并为 API 返回的每个资源创建一个目标。

资源地址是资源的 certname，可以在重新标记期间更改。

此组件的查询应为有效的 PQL (Puppet 查询语言)。

用法

alloy 复制

discovery.puppetdb "<LABEL>" {
  url = "<PUPPET_SERVER>"
}

参数

您可以将以下参数与 discovery.puppetdb 一起使用

最多只能提供以下之一

• 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.puppetdb 一起使用

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

authorization

authorization 块配置通用端点授权。

credential 和 credentials_file 是互斥的，在 authorization 块中只能提供其中之一。

basic_auth

basic_auth 块配置对端点进行基本身份验证。

password 和 password_file 是互斥的，在 basic_auth 块中只能提供其中之一。

oauth2

oauth2 块配置对端点进行 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)

导出字段

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

每个目标包含以下标签

• __meta_puppetdb_certname: 与资源关联的节点名称。
• __meta_puppetdb_environment: 与资源关联的节点环境。
• __meta_puppetdb_exported: 资源是否已导出，值为 true 或 false。
• __meta_puppetdb_file: 声明资源的清单文件。
• __meta_puppetdb_parameter_<parametername>: 资源的参数。
• __meta_puppetdb_query: Puppet 查询语言 (PQL) 查询。
• __meta_puppetdb_resource: 资源的类型、标题和参数的 SHA-1 哈希值，用于标识。
• __meta_puppetdb_tags: 资源标签的逗号分隔列表。
• __meta_puppetdb_title: 资源标题。
• __meta_puppetdb_type: 资源类型。

组件健康状态

仅当配置无效时，discovery.puppetdb 才会被报告为不健康。在这种情况下，导出字段会保留其上次健康时的值。

调试信息

discovery.puppetdb 不暴露任何组件特定的调试信息。

调试指标

discovery.puppetdb 不暴露任何组件特定的调试指标。

示例

此示例从 PuppetDB 中发现定义了特定软件包的所有服务器的目标

alloy 复制

discovery.puppetdb "example" {
    url   = "http://puppetdb.local:8080"
    query = "resources { type = \"Package\" and title = \"node_exporter\" }"
    port  = 9100
}

prometheus.scrape "demo" {
    targets    = discovery.puppetdb.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.puppetdb 具有可由以下组件使用的导出字段

• 使用 Targets 的组件