文档 Grafana Alloy 参考 组件 prometheus prometheus.operator.scrapeconfigs

prometheus.operator.scrapeconfigs

实验性：这是一个实验性组件。实验性组件可能会频繁发生破坏性更改，并且可能在移除时没有等效的替代方案。必须将 stability.level 标志设置为 experimental 才能使用该组件。

prometheus.operator.scrapeconfigs 发现您的 Kubernetes 集群中的ScrapeConfig 资源并抓取它们引用的目标。此组件执行两个主要功能

1. 从 Kubernetes 集群发现 ScrapeConfig 资源。
2. 从目标抓取指标，并将其转发到接收器。

默认配置假定 Alloy 在 Kubernetes 集群内运行，并使用集群内配置访问 Kubernetes API。您可以通过在 client 块中提供连接信息，在集群外部运行 Alloy，但需要网络级别的访问权限才能从 scrapeconfigs 中抓取指标。

scrapeconfigs 可以引用密钥来对目标进行身份验证以进行抓取。在这些情况下，密钥仅在 ScrapeConfig 更新或此组件刷新其内部状态时（每 5 分钟刷新一次）加载和刷新。

用法

alloy 复制

prometheus.operator.scrapeconfigs "<LABEL>" {
    forward_to = <RECEIVER_LIST>
}

参数

您可以将以下参数与 prometheus.operator.scrapeconfigs 一起使用

块

您可以将以下块与 prometheus.operator.scrapeconfigs 一起使用

> 符号表示更深的嵌套级别。例如，client > basic_auth 指的是在 client 块内定义的 basic_auth 块。

client

client 块配置用于发现 scrapeconfigs 的 Kubernetes client。如果未提供 client 块，则使用运行 Alloy Pod 的服务帐户的默认集群内配置。

支持以下参数

最多只能提供以下之一

• authorization 块
• basic_auth 块
• bearer_token 参数
• bearer_token_file 参数
• 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。

authorization

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

basic_auth

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

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)

clustering

当 Alloy 使用集群并且 enabled 设置为 true 时，此组件实例选择加入集群以在所有集群节点之间分配抓取负载。

集群假定所有集群节点都运行相同的配置文件，并且所有选择使用集群的 prometheus.operator.scrapeconfigs 组件实例在抓取间隔内具有相同的配置。

所有选择加入集群的 prometheus.operator.scrapeconfigs 组件实例使用目标标签和一致性哈希算法来确定每个目标在集群对等体之间的所有权。然后，每个对等体只抓取其负责的目标子集，从而分配抓取负载。当一个节点加入或离开集群时，每个对等体重新计算所有权并继续使用新的目标集进行抓取。这比 hashmod 分片表现更好，因为 hashmod 分片需要重新分配*所有*节点，而这里只转移了目标所有权的 1/N，并且是最终一致的（而不是像 hashmod 分片那样的完全一致）。

如果 Alloy *未*以集群模式运行，则该块不起作用，并且 prometheus.operator.scrapeconfigs 会抓取其参数中接收到的每个目标。

rule

rule 块包含可应用于输入指标的任何 Relabeling 规则的定义。如果定义了多个 rule 块，转换将按自上而下的顺序应用。

可以使用以下参数来配置 rule。所有参数都是可选的。省略的字段采用其默认值。

您可以使用以下操作

• drop - 丢弃通过 source_labels 和 separator 提取的字符串与 regex 匹配的指标。
• dropequal - 丢弃串联的 source_labels 与 target_label *不*匹配的目标。
• hashmod - 哈希串联的标签，计算其模数 modulus，并将结果写入 target_label。
• keep - 保留通过 source_labels 和 separator 提取的字符串与 regex 匹配的指标。
• keepequal - 丢弃串联的 source_labels 与 target_label 匹配的目标。
• labeldrop - 将 regex 与所有标签名称匹配。任何匹配的标签都将从指标的标签集中移除。
• labelkeep - 将 regex 与所有标签名称匹配。任何不匹配的标签都将从指标的标签集中移除。
• labelmap - 将 regex 与所有标签名称匹配。任何匹配的标签将根据 replacement 字段的内容重命名。
• lowercase - 将 target_label 设置为串联的 source_labels 的小写形式。
• replace - 将 regex 与串联的标签匹配。如果匹配，则使用 replacement 字段的内容替换 target_label 的内容。
• uppercase - 将 target_label 设置为串联的 source_labels 的大写形式。

scrape

selector

selector 块描述了 scrapeconfigs 的 Kubernetes 标签选择器。

支持以下参数

当 match_labels 参数为空时，将匹配所有 ScrapeConfig 资源。

match_expression

match_expression 块描述了用于 scrapeconfigs 发现的 Kubernetes 标签匹配器表达式。

支持以下参数

operator 参数必须是以下字符串之一

• "In"
• "NotIn"
• "Exists"
• "DoesNotExist"

如果在 selector 块内有多个 match_expressions 块，它们将通过 AND 子句组合在一起。

导出的字段

prometheus.operator.scrapeconfigs 不导出任何字段。它将抓取的所有指标转发到使用 forward_to 参数配置的接收器。

组件健康状态

当给定无效配置、Prometheus 组件初始化失败或与 Kubernetes API 的连接未正确建立时，prometheus.operator.scrapeconfigs 会报告为不健康。

调试信息

prometheus.operator.scrapeconfigs 在组件的调试端点上报告每个已配置抓取作业的上次抓取状态，包括发现的标签和上次抓取时间。

它还为它发现的每个 ScrapeConfig 公开一些调试信息，包括在协调 ScrapeConfig 中的抓取配置时发现的任何错误。

调试指标

prometheus.operator.scrapeconfigs 不公开任何特定于组件的调试指标。

示例

此示例发现集群中的所有 scrapeconfigs，并将收集到的指标转发到 prometheus.remote_write 组件。

alloy 复制

prometheus.remote_write "staging" {
  // Send metrics to a locally running Mimir.
  endpoint {
    url = "http://mimir:9009/api/v1/push"

    basic_auth {
      username = "example-user"
      password = "example-password"
    }
  }
}

prometheus.operator.scrapeconfigs "scrapeconfigs" {
    forward_to = [prometheus.remote_write.staging.receiver]
}

此示例将发现的 scrapeconfigs 限制为特定命名空间 my-app 中带有标签 team=ops 的那些。

alloy 复制

prometheus.operator.scrapeconfigs "scrapeconfigs" {
    forward_to = [prometheus.remote_write.staging.receiver]
    namespaces = ["my-app"]
    selector {
        match_expression {
            key = "team"
            operator = "In"
            values = ["ops"]
        }
    }
}

额外的指标标签

prometheus.operator.scrapeconfigs 会为 ScrapeConfig 对象抓取的所有指标添加以下额外标签。

兼容组件

prometheus.operator.scrapeconfigs 可以接受来自以下组件的参数

• 导出 Prometheus MetricsReceiver 的组件