菜单
文档breadcrumb arrow Grafana Alloybreadcrumb arrow 参考breadcrumb arrow 组件breadcrumb arrow lokibreadcrumb arrow loki.source.kubernetes
开源

loki.source.kubernetes

loki.source.kubernetes 利用 Kubernetes API 从 Kubernetes 容器中读取日志,与 loki.source.file 相比,有以下优点:

  • 无需特权容器即可运行。
  • 无需 root 用户即可运行。
  • 无需访问 Kubernetes 节点的文件系统即可运行。
  • 不需要 DaemonSet 收集日志,因此一个 Alloy 可以收集整个集群的日志。

注意

由于 loki.source.kubernetes 使用 Kubernetes API 来跟踪日志,因此比 loki.source.file 使用更多的网络流量和 Kubelets 的 CPU 消耗。

可以通过指定不同的标签来指定多个 loki.source.kubernetes 组件。

用法

alloy
loki.source.kubernetes "LABEL" {
  targets    = TARGET_LIST
  forward_to = RECEIVER_LIST
}

参数

该组件为给定的每个 targets 启动一个新的读取器,并将日志条目广播到 forward_to 中传入的接收器列表。

loki.source.kubernetes 支持以下参数

名称类型描述默认必需
targetslist(map(string))要读取的文件列表。
forward_tolist(LogsReceiver)要发送日志条目的接收器列表。

targets 中的每个目标必须有以下标签

  • __meta_kubernetes_namespace__pod_namespace__ 指定要跟踪的 pod 的命名空间。
  • __meta_kubernetes_pod_name__pod_name__ 指定要跟踪的 pod 的名称。
  • __meta_kubernetes_pod_container_name__pod_container_name__ 指定 pod 内要跟踪的容器。
  • __meta_kubernetes_pod_uid__pod_uid__ 指定要跟踪的 pod 的 UID。

默认情况下,当使用输出 discovery.kubernetes 时,所有这些标签都是存在的。

targets 中的每个唯一目标启动一个日志跟踪器。如果日志流在容器永久终止之前返回,则日志跟踪器将以指数退避的方式重新连接到 Kubernetes。

loki.source.kubernetes 的定义中支持以下块

层次结构描述必需
clientclient配置用于跟踪日志的 Kubernetes 客户端。
client > basic_authbasic_auth配置用于端点的基本身份验证。
client > authorizationauthorization配置端点的通用身份验证。
client > oauth2oauth2配置用于端点的 OAuth2 身份验证。
client > oauth2 > tls_configtls_config配置连接到端点的 TLS 设置。
client > tls_configtls_config配置连接到端点的 TLS 设置。
clusteringclustering配置 alloy 集群模式下运行的组件。

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

client 块

client 块用于配置 Kubernetes 客户端,它用于跟踪容器的日志。如果没有提供 client 块,则使用默认的集群配置,该配置使用运行 Alloy pod 的服务账号进行。

以下参数得到了支持

名称类型描述默认必需
api_server字符串Kubernetes API 服务器的 URL。
kubeconfig_file字符串用于连接到 Kubernetes 的 kubeconfig 文件的路径。
bearer_token_file字符串包含用于身份验证的 bearer token 的文件。
bearer_token秘密用于身份验证的 bearer token。
enable_http2布尔类型是否支持 HTTP2 用于请求。
follow_redirects布尔类型是否应遵循服务器返回的重定向。
proxy_url字符串通过其发送请求的 HTTP 代理。
no_proxy字符串以逗号分隔的 IP 地址、CIDR 表示法和域名列表,不包括代理。
proxy_from_environment布尔类型使用环境变量指示的代理 URL。
proxy_connect_headermap(list(secret))指定在连接请求期间发送到代理的头信息。

以下参数中最多可以提供其中一个

no_proxy 可以包含 IPs、CIDR 表示法和域名。IP 和域名可以包含端口号。《proxy_url》必须配置,如果配置了 no_proxy

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或它们的草写形式)。请求使用与它们的方案相匹配的环境变量中的代理,除非被 NO_PROXY 排除。《proxy_url》和 no_proxy 必须未配置,如果配置了 proxy_from_environment

proxy_connect_header 应仅在配置了 proxy_urlproxy_from_environment 时配置。

basic_auth 块

名称类型描述默认必需
password_file字符串包含基本认证密码的文件。
password秘密基本认证密码。
username字符串基本认证用户名。

passwordpassword_file 是互斥的,并且在一个 basic_auth 块内只能提供一个。

authorization 块

名称类型描述默认必需
credentials_file字符串包含机密值的文件。
credentials秘密机密值。
type字符串授权类型,例如,“Bearer”。

credentialcredentials_file 是互斥的,并且在一个 authorization 块内只能提供一个。

oauth2 块

名称类型描述默认必需
client_id字符串OAuth2 客户端 ID。
client_secret_file字符串包含 OAuth2 客户端密钥的文件。
client_secret秘密OAuth2 客户端密钥。
endpoint_paramsmap(string)追加到令牌 URL 的可选参数。
proxy_url字符串通过其发送请求的 HTTP 代理。
no_proxy字符串以逗号分隔的 IP 地址、CIDR 表示法和域名列表,不包括代理。
proxy_from_environment布尔类型使用环境变量指示的代理 URL。
proxy_connect_headermap(list(secret))指定在连接请求期间发送到代理的头信息。
scopeslist(string)用于身份验证的作用域列表。
token_url字符串从中获取令牌的 URL。

client_secretclient_secret_file 是互斥的,并且在一个 oauth2 块内只能提供一个。

oauth2 块还可以包含一个独立的 tls_config 子块。

no_proxy 可以包含 IPs、CIDR 表示法和域名。IP 和域名可以包含端口号。《proxy_url》必须配置,如果配置了 no_proxy

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或它们的草写形式)。请求使用与它们的方案相匹配的环境变量中的代理,除非被 NO_PROXY 排除。《proxy_url》和 no_proxy 必须未配置,如果配置了 proxy_from_environment

proxy_connect_header 应仅在配置了 proxy_urlproxy_from_environment 时配置。

tls_config 块

名称类型描述默认必需
ca_pem字符串用于验证服务器的 PEM 编码的 CA 文本。
ca_file字符串用于验证服务器的 CA 证书。
cert_pem字符串用于客户端认证的 PEM 编码的证书文本。
cert_file字符串客户端认证的证书文件。
insecure_skip_verify布尔类型禁用服务器证书的验证。
key_file字符串客户端认证的密钥文件。
key_pem秘密用于客户端认证的 PEM 编码的密钥文本。
min_version字符串最小可接受的 TLS 版本。
server_name字符串ServerName 扩展,表示服务器名称。

以下参数对是互斥的,不能同时设置

  • ca_pemca_file
  • cert_pemcert_file
  • key_pemkey_file

在配置客户端身份验证时,必须提供客户端证书(使用 cert_pemcert_file)和客户端密钥(使用 key_pemkey_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)

集群块

名称类型描述默认必需
启用布尔类型与其他集群节点一起分发日志收集。

当 Alloy 使用集群 并将 enabled 设置为 true 时,则此 loki.source.kubernetes 组件实例登记参与集群,以便在所有集群节点之间分配日志收集的负载。

如果 Alloy 未以集群模式运行,则此块无效,且 loki.source.kubernetes 会从它在参数中收到的每个目标收集日志。

导出的字段

loki.source.kubernetes 不导出任何字段。

组件健康状态

loki.source.kubernetes 只有在给出无效配置时才会报告为不健康。

调试信息

loki.source.kubernetes 每个目标都会暴露一些目标级别的调试信息

  • 与目标关联的标签。
  • 在服务发现期间找到的全部标签集合。
  • 读取并转发到管道中下一个组件的最新日志行的时间。
  • 如果有的话,追踪日志的最新错误。

调试指标

loki.source.kubernetes 不暴露任何特定于组件的调试指标。

示例

此示例收集所有 Kubernetes 容器的日志并将它们转发到 loki.write 组件,以便将它们写入 Loki。

alloy
discovery.kubernetes "pods" {
  role = "pod"
}

loki.source.kubernetes "pods" {
  targets    = discovery.kubernetes.pods.targets
  forward_to = [loki.write.local.receiver]
}

loki.write "local" {
  endpoint {
    url = env("LOKI_URL")
  }
}

兼容组件

loki.source.kubernetes 可以接受来自以下组件的参数

注意

连接某些组件可能不合理,或者组件可能需要进一步的配置才能正确连接。请参阅相关文档以获取更多详细信息。