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

prometheus.operator.servicemonitors

prometheus.operator.servicemonitors 组件会发现 Kubernetes 集群中的 ServiceMonitor 资源并抓取它们引用的目标。此组件主要执行以下三个功能：

1. 发现 Kubernetes 集群中的 ServiceMonitor 资源。
2. 发现集群中与这些 ServiceMonitor 匹配的 Service 和 Endpoint。
3. 从这些 Endpoint 抓取指标，并将它们转发到接收器。

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

ServiceMonitor 可以引用用于目标认证的 Secrets 来抓取它们。在这种情况下，仅当 ServiceMonitor 更新或此组件刷新其内部状态（每 5 分钟刷新一次）时，才会加载和刷新 Secret。

用法

alloy 复制

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

参数

您可以将以下参数用于 prometheus.operator.servicemonitors

块

您可以将以下块用于 prometheus.operator.servicemonitors

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

client

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

支持以下参数：

最多只能提供以下之一：

• 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（或其小写形式）。请求使用与其 scheme 匹配的环境变量中的代理，除非被 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（或其小写形式）。请求使用与其 scheme 匹配的环境变量中的代理，除非被 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.servicemonitors 组件在一个抓取间隔内具有相同的配置。

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

如果 Alloy 未在集群模式下运行，则此块不执行任何操作，prometheus.operator.servicemonitors 将抓取其参数中接收到的每个目标。

rule

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

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

您可以使用以下操作：

• drop - 丢弃 regex 匹配使用 source_labels 和 separator 提取的字符串的指标。
• dropequal - 丢弃串联的 source_labels 与 target_label 匹配的目标。
• hashmod - 哈希串联的标签，计算其对 modulus 的模数，并将结果写入 target_label。
• keep - 保留 regex 匹配使用 source_labels 和 separator 提取的字符串的指标。
• 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 块描述了 ServiceMonitor 的 Kubernetes 标签选择器。

支持以下参数：

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

match_expression

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

支持以下参数：

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

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

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

导出的字段

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

组件健康状态

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

调试信息

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

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

调试指标

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

示例

以下示例发现集群中的所有 ServiceMonitor，并将收集到的指标转发到 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.servicemonitors "services" {
    forward_to = [prometheus.remote_write.staging.receiver]
}

以下示例将发现的 ServiceMonitor 限制为特定命名空间 my-app 中带有标签 team=ops 的 ServiceMonitor。

alloy 复制

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

以下示例对发现的目标应用额外的重新标记规则，以按主机名进行过滤。这在将 Alloy 作为 DaemonSet 运行时可能很有用。

alloy 复制

prometheus.operator.servicemonitors "services" {
    forward_to = [prometheus.remote_write.staging.receiver]
    rule {
      action = "keep"
      regex = sys.env("HOSTNAME")
      source_labels = ["__meta_kubernetes_pod_node_name"]
    }
}

兼容的组件

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

• 导出 Prometheus MetricsReceiver 的组件