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

prometheus.operator.servicemonitors

prometheus.operator.servicemonitors 在您的 Kubernetes 集群中查找 ServiceMonitor 资源，并抓取它们引用的目标。此组件执行三个主要功能

1. 从您的 Kubernetes 集群中查找 ServiceMonitor 资源。
2. 查找与这些 ServiceMonitors 匹配的集群中的服务和端点。
3. 从这些端点抓取指标，并将它们转发到接收器。

默认配置假设 Alloy 在 Kubernetes 集群内部运行，并使用集群内部配置来访问 Kubernetes API。可以通过在 client 块中提供连接信息在集群外部运行，但需要网络级别访问已发现端点以从它们抓取指标。

ServiceMonitors 可能会引用秘密以验证到目标以抓取它们。在这些情况下，只有在 ServiceMonitor 更新或此组件刷新其内部状态时（每5分钟刷新一次周期）才会加载和刷新秘密。

用法

alloy 复制

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

参数

支持以下参数

块

以下块在prometheus.operator.servicemonitors的定义内受支持

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

客户端块

client块配置用于发现ServiceMonitors的Kubernetes客户端。如果没有提供client块，则使用默认的集群配置，即使用运行Alloy的Pod的服务账户。

支持以下参数

以下之一最多只能提供一项

• 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时才应配置。

基本认证块

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

授权块

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)

rule 块

rule 块包含可以应用于输入指标的任何重命名规则的定义。如果定义了多个 rule 块，则变换将按从上到下的顺序应用。

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

可以使用以下操作

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

抓取块

选择器块

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

支持以下参数

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

match_expression块

match_expression块描述了ServiceMonitors发现时使用的Kubernetes标签匹配器表达式。

支持以下参数

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

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

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

集群块

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

集群假设所有集群节点都使用相同的配置文件，并且所有选择加入使用集群的prometheus.operator.servicemonitors组件在抓取间隔期间具有相同的配置。

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

如果Alloy未以集群模式运行，则此块是无效操作，并且prometheus.operator.servicemonitors将抓取其参数中接收到的每个目标。

导出字段

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限制为具有特定命名空间中team=ops标签的ServiceMonitor：my-app。

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的组件