文档 Grafana Alloy 参考 组件 发现 discovery.kubernetes

发现 kubernetes

discovery.kubernetes 允许您从 Kubernetes 资源中找到抓取目标。它监视集群状态，并确保目标与集群中当前运行的内容持续同步。

如果您未提供连接信息，则此组件默认为集群内配置。可以使用 kubeconfig 文件或手动连接设置来覆盖默认值。

用法

alloy 复制

discovery.kubernetes "LABEL" {
  role = DISCOVERY_ROLE
}

参数

以下参数被支持

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

• 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_connect_header 应仅当配置了 proxy_url 或 proxy_from_environment 时配置。

role 参数是必需的，用于指定要发现的目标类型。role 必须是 node、pod、service、endpoints、endpointslice 或 ingress 之一。

node角色

node 角色在每个集群节点上发现一个目标，地址默认为Kubelet守护进程的HTTP端口。目标地址默认为Kubernetes节点对象在地址类型顺序中的第一个现有地址，地址类型顺序为 NodeInternalIP、NodeExternalIP、NodeLegacyHostIP 和 NodeHostName。

以下标签包括在发现的节点中

• __meta_kubernetes_node_name：节点对象的名称。
• __meta_kubernetes_node_provider_id：云提供商为节点对象命名的名称。
• __meta_kubernetes_node_label_<labelname>：节点对象中的每个标签。
• __meta_kubernetes_node_labelpresent_<labelname>：对于节点对象中的每个标签设置为 true。
• __meta_kubernetes_node_annotation_<annotationname>：节点对象中的每个注释。
• __meta_kubernetes_node_annotationpresent_<annotationname>：对于节点对象中的每个注释设置为 true。
• __meta_kubernetes_node_address_<address_type>：如果存在，每个节点地址类型的第一个地址。

此外，节点实例标签将被设置为从API服务器检索到的节点名称。

service角色

service 角色为每个服务的每个服务端口发现一个目标。这通常用于外部监控服务。地址将设置为服务的Kubernetes DNS名称和相应的服务端口。

以下标签包括在发现的服务的标签中

• __meta_kubernetes_namespace：服务对象的命名空间。
• __meta_kubernetes_service_annotation_<annotationname>：服务对象中的每个注释。
• __meta_kubernetes_service_annotationpresent_<annotationname>：服务对象中的每个注释为 true。
• __meta_kubernetes_service_cluster_ip：服务的集群IP地址。这不适用于类型为 ExternalName 的服务。
• __meta_kubernetes_service_external_name：服务的DNS名称。这仅适用于类型为 ExternalName 的服务。
• __meta_kubernetes_service_label_<labelname>：服务对象中的每个标签。
• __meta_kubernetes_service_labelpresent_<labelname>：服务对象中的每个标签为 true。
• __meta_kubernetes_service_name：服务对象的名称。
• __meta_kubernetes_service_port_name：目标服务端口的名称。
• __meta_kubernetes_service_port_number：目标服务端口的编号。
• __meta_kubernetes_service_port_protocol：目标服务端口的协议。
• __meta_kubernetes_service_type：服务的类型。

Pod 角色

Pod 角色发现所有 Pod，并将它们的容器作为目标。对于每个容器的声明端口，生成一个目标。

如果容器没有指定端口，则每个容器创建一个无端口的目标。在使用 discovery.relabel 组件 手动注入端口之前，无法从这些目标收集指标。

以下标签包含在发现的 Pod 中

• __meta_kubernetes_namespace：Pod 对象的命名空间。
• __meta_kubernetes_pod_name：Pod 对象的名称。
• __meta_kubernetes_pod_ip：Pod 对象的 Pod IP。
• __meta_kubernetes_pod_label_<labelname>：Pod 对象的每个标签。
• __meta_kubernetes_pod_labelpresent_<labelname>：对于 Pod 对象的每个标签，值为 true。
• __meta_kubernetes_pod_annotation_<annotationname>：Pod 对象的每个注解。
• __meta_kubernetes_pod_annotationpresent_<annotationname>：对于 Pod 对象的每个注解，值为 true。
• __meta_kubernetes_pod_container_init：如果容器是 InitContainer，则值为 true。
• __meta_kubernetes_pod_container_name：指向目标地址的容器的名称。
• __meta_kubernetes_pod_container_id：指向目标地址的容器的 ID。ID 的形式为 <type>://<container_id>。
• __meta_kubernetes_pod_container_image：容器使用的镜像。
• __meta_kubernetes_pod_container_port_name：容器端口的名称。
• __meta_kubernetes_pod_container_port_number：容器端口的编号。
• __meta_kubernetes_pod_container_port_protocol：容器端口的协议。
• __meta_kubernetes_pod_ready：根据 Pod 的就绪状态设置为 true 或 false。
• __meta_kubernetes_pod_phase：在生命周期中设置为 Pending、Running、Succeeded、Failed 或 Unknown。
• __meta_kubernetes_pod_node_name：Pod 调度的节点的名称。
• __meta_kubernetes_pod_host_ip：Pod 对象的当前主机 IP。
• __meta_kubernetes_pod_uid：Pod 对象的 UID。
• __meta_kubernetes_pod_controller_kind：Pod 控制器的对象类型。
• __meta_kubernetes_pod_controller_name：Pod 控制器的名称。

端点角色

端点角色从服务的列出端点发现目标。对于每个端点地址，每个端口发现一个目标。如果端点由 Pod 支持，则发现 Pod 的所有容器端口作为目标，即使它们未绑定到端点端口。

以下标签包含在发现的端点中

• __meta_kubernetes_namespace: 端点对象的命名空间。
• __meta_kubernetes_endpoints_name: 端点对象的名称。
• __meta_kubernetes_endpoints_label_<labelname>：端点对象的每个标签。
• __meta_kubernetes_endpoints_labelpresent_<labelname>：对于端点对象的每个标签，值为 true。
• 以下标签附加到从端点列表直接发现的所有目标上
  • __meta_kubernetes_endpoint_hostname：端点的主机名。
  • __meta_kubernetes_endpoint_node_name：托管端点的节点的名称。
  • __meta_kubernetes_endpoint_ready：将端点的就绪状态设置为true或false。
  • __meta_kubernetes_endpoint_port_name：端点端口的名称。
  • __meta_kubernetes_endpoint_port_protocol：端点端口的协议。
  • __meta_kubernetes_endpoint_address_target_kind：端点地址目标的类型。
  • __meta_kubernetes_endpoint_address_target_name：端点地址目标的名称。
• 如果端点属于服务，则会附加服务角色发现的全部标签。
• 对于由Pod支持的全部目标，会附加Pod角色发现的全部标签。

endpointslice 角色名

endpointslice 角色从现有的Kubernetes端点切片中发现目标。对于每个在EndpointSlice对象中引用的端点地址，都会发现一个目标。如果端点由Pod支持，即使它们没有绑定到端点端口，也会发现Pod的所有容器端口作为目标。

以下标签包括在发现的端点切片中

• __meta_kubernetes_namespace：端点对象的命名空间。
• __meta_kubernetes_endpointslice_name：端点切片对象的名称。
• 以下标签附加在直接从端点切片列表中发现的全部目标上
  • __meta_kubernetes_endpointslice_address_target_kind：引用对象的类型。
  • __meta_kubernetes_endpointslice_address_target_name：引用对象的名称。
  • __meta_kubernetes_endpointslice_address_type：目标地址的IP协议族。
  • __meta_kubernetes_endpointslice_endpoint_conditions_ready：将引用端点的就绪状态设置为true或false。
  • __meta_kubernetes_endpointslice_endpoint_topology_kubernetes_io_hostname：托管引用端点的节点的名称。
  • __meta_kubernetes_endpointslice_endpoint_topology_present_kubernetes_io_hostname：如果引用对象有kubernetes.io/hostname注解，则为true。
  • __meta_kubernetes_endpointslice_port：引用端点的端口。
  • __meta_kubernetes_endpointslice_port_name：引用端点的命名端口。
  • __meta_kubernetes_endpointslice_port_protocol：引用端点的协议。
• 如果端点属于服务，则会附加服务角色发现的全部标签。
• 对于由Pod支持的全部目标，会附加Pod角色发现的全部标签。

ingress 角色名

ingress 角色为每个Ingress的每个路径发现一个目标。这通常用于对外部监控Ingress。地址将设置为Kubernetes Ingress的spec块中指定的主机。

以下标签包括在发现的Ingress对象中

• __meta_kubernetes_namespace：Ingress对象的命名空间。
• __meta_kubernetes_ingress_name：Ingress对象的名称。
• __meta_kubernetes_ingress_label_<labelname>：Ingress对象中的每个标签。
• __meta_kubernetes_ingress_labelpresent_<labelname>：Ingress对象中的每个标签为true。
• __meta_kubernetes_ingress_annotation_<annotationname>：Ingress对象中的每个注解。
• __meta_kubernetes_ingress_annotationpresent_<annotationname>：Ingress对象中的每个注解为true。
• __meta_kubernetes_ingress_class_name：如果存在，来自Ingress spec的类名。
• __meta_kubernetes_ingress_scheme：Ingress的协议方案，如果设置了TLS配置，则为https。默认为http。
• __meta_kubernetes_ingress_path：来自Ingress spec的路径。默认为/。

块

以下块在discovery.kubernetes的定义内部受支持

“>” 符号表示更深的嵌套层级。例如，oauth2 > tls_config 指的是在 oauth2 块内部定义的 tls_config 块。

namespaces 块

namespaces 块限制了发现资源时要搜索的命名空间。如果省略，则搜索所有命名空间。

selectors 块

selectors 块包含可选的标签和字段选择器，以将发现过程限制为资源子集。

有关可以使用哪些过滤器的更多信息，请参阅 Kubernetes 的文档：字段选择器 和 标签和选择器。

端点角色支持 Pod、服务和端点选择器。Pod 角色在配置了 attach_metadata: {node: true} 时支持节点选择器。其他角色仅支持与自身匹配的选择器（例如，节点角色只能包含节点选择器）。

attach_metadata 块

attach_metadata 块允许将节点元数据附加到发现的目标。适用于角色：pod、endpoints、endpointslice。

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_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）

导出字段

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

组件健康状态

当提供无效配置时，discovery.kubernetes 被报告为不健康。在这些情况下，导出字段保留其最后健康的值。

调试信息

discovery.kubernetes 不公开任何组件特定的调试信息。

调试指标

discovery.kubernetes 不公开任何组件特定的调试指标。

示例

集群内发现

此示例使用集群内身份验证来发现所有 pod

alloy 复制

discovery.kubernetes "k8s_pods" {
  role = "pod"
}

prometheus.scrape "demo" {
  targets    = discovery.kubernetes.k8s_pods.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 远程_write 兼容服务器的 URL。
• USERNAME：用于远程_write API 身份验证的用户名。
• PASSWORD：用于远程_write API 身份验证的密码。

Kubeconfig 身份验证

此示例使用 Kubeconfig 文件来对 Kubernetes API 进行身份验证

alloy 复制

discovery.kubernetes "k8s_pods" {
  role = "pod"
  kubeconfig_file = "/etc/k8s/kubeconfig.yaml"
}

prometheus.scrape "demo" {
  targets    = discovery.kubernetes.k8s_pods.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 远程_write 兼容服务器的 URL。
• USERNAME：用于远程_write API 身份验证的用户名。
• PASSWORD：用于远程_write API 身份验证的密码。

限制搜索命名空间并按标签值过滤

此示例限制搜索命名空间，并且只选择具有特定标签值的 pod

alloy 复制

discovery.kubernetes "k8s_pods" {
  role = "pod"

  selectors {
    role = "pod"
    label = "app.kubernetes.io/name=prometheus-node-exporter"
  }

  namespaces {
    names = ["myapp"]
  }
}

prometheus.scrape "demo" {
  targets    = discovery.kubernetes.k8s_pods.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 远程_write 兼容服务器的 URL。
• USERNAME：用于远程_write API 身份验证的用户名。
• PASSWORD：用于远程_write API 身份验证的密码。

仅限于同一节点上的 pod

此示例将搜索限制在与此 Alloy 同一节点上的 pod。如果您将 Alloy 作为 DaemonSet 运行，此配置可能很有用。

alloy 复制

discovery.kubernetes "k8s_pods" {
  role = "pod"
  selectors {
    role = "pod"
    field = "spec.nodeName=" + coalesce(sys.env("HOSTNAME"), constants.hostname)
  }
}

prometheus.scrape "demo" {
  targets    = discovery.kubernetes.k8s_pods.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 远程_write 兼容服务器的 URL。
• USERNAME：用于远程_write API 身份验证的用户名。
• PASSWORD：用于远程_write API 身份验证的密码。

兼容组件

discovery.kubernetes 导出可以被以下组件消费的字段

• 消耗 Targets 的组件