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

发现PuppetDB

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

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

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

此组件的查询预计将是有效的 PQL (Puppet Query Language)。

用法

alloy 复制

discovery.puppetdb "LABEL" {
  url = PUPPET_SERVER
}

参数

支持以下参数

以下之一最多提供一次

• 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_from_environment，则不得配置proxy_url和no_proxy。

proxy_connect_header 应仅配置为配置了proxy_url或proxy_from_environment。

块

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

proxy_from_environment 使用环境变量HTTP_PROXY、HTTPS_PROXY和NO_PROXY（或其小写版本）。请求使用与其方案匹配的环境变量中的代理，除非被NO_PROXY排除。如果配置了proxy_from_environment，则不得配置proxy_url和no_proxy。

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）

导出字段

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

每个目标包括以下标签

• __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 中的所有具有特定软件包定义的服务器目标

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：用于远程_write API 认证的用户名。
• PASSWORD：用于远程_write API 认证的密码。

兼容组件

discovery.puppetdb 的导出可以被以下组件消费

• 消费 目标 的组件