发现.puppetdb

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

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

资源地址是该资源的 certname，可以在重标签过程中更改。

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

用法

discovery.puppetdb "LABEL" {
  url = PUPPET_SERVER
}

参数

以下参数被支持：

以下之一最多可以提供一项

• 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.puppetdb 定义中受支持。

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

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

组件健康状态

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

调试信息

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

调试指标

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

示例

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

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：用于对远程write API进行身份验证的用户名。
• PASSWORD：用于对远程write API进行身份验证的密码。

兼容组件

discovery.puppetdb有可以由以下组件使用的导出

• 消费者目标的组件