菜单
文档breadcrumb arrow Grafana Alloybreadcrumb arrow 参考breadcrumb arrow 组件breadcrumb arrow lokibreadcrumb arrow loki.source.kubernetes_events
正式发布 (GA) 开源

loki.source.kubernetes_events

loki.source.kubernetes_events 从 Kubernetes API 追踪事件,并将其转换为日志行,以便转发到其他 loki 组件。

您可以通过为每个 loki.source.kubernetes_events 组件分配不同的标签来指定多个此类组件。

用法

alloy
loki.source.kubernetes_events "<LABEL>" {
  forward_to = <RECEIVER_LIST>
}

参数

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

您可以将以下参数与 loki.source.kubernetes_events 一起使用

名称类型描述默认值必需
forward_tolist(LogsReceiver)要发送日志条目到的接收器列表。
job_namestring用于生成日志的 job 标签的值。"loki.source.kubernetes_events"
log_formatstring日志的格式。"logfmt"
namespaceslist(string)要监听 Events 的命名空间。[]

默认情况下,loki.source.kubernetes_events 监听所有命名空间中的事件。可以在 namespaces 参数中提供要监听的明确命名空间列表。

默认情况下,生成的日志行采用 logfmt 格式。使用 log_format 参数将其更改为 json。这些格式也是 LogQL 解析器的名称,可用于处理日志。

注意

当监听所有命名空间时,Alloy 必须具有在集群范围(例如使用 ClusterRoleBinding)监听事件的权限。如果提供了明确的命名空间列表,Alloy 只需具有对这些命名空间监听事件的权限。

loki.source.kubernetes_events 生成的日志行具有以下标签

  • namespace: 参与事件的 Kubernetes 对象的命名空间。
  • job: 由 job_name 参数指定的值。
  • instance: 与组件 ID 匹配的值。

如果 job_name 参数为空字符串,组件将无法加载。要移除 job 标签,请将 loki.source.kubernetes_events 的输出转发到 一个 loki.relabel 组件

为了与静态模式下的 eventhandler 集成兼容,job_name 可以设置为 "integrations/kubernetes/eventhandler"

您可以将以下块与 loki.source.kubernetes_events 一起使用

描述必需
client配置用于追踪日志的 Kubernetes 客户端。
client > authorization配置到端点的通用授权。
client > basic_auth配置 basic_auth 以向端点进行认证。
client > oauth2配置 OAuth 2.0 以向端点进行认证。
client > oauth2 > tls_config配置连接到端点的 TLS 设置。
client > [tls_config][]配置连接到端点的 TLS 设置。

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

client

client 块配置用于从容器追踪日志的 Kubernetes 客户端。如果未提供 client 块,则使用运行 Alloy Pod 的服务帐户的默认集群内配置。

支持以下参数

名称类型描述默认值必需
api_serverstringKubernetes API 服务器的 URL。
bearer_token_filestring包含用于认证的持有者令牌的文件。
bearer_tokensecret用于认证的持有者令牌。
enable_http2bool请求是否支持 HTTP2。true
follow_redirectsbool是否应遵循服务器返回的重定向。true
http_headersmap(list(secret))随每个请求一起发送的自定义 HTTP 标头。map 键是标头名称。
kubeconfig_filestring用于连接到 Kubernetes 的 kubeconfig 文件的路径。
no_proxystring逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送到代理的标头。
proxy_from_environmentbool使用环境变量指示的代理 URL。false
proxy_urlstring用于发送请求的 HTTP 代理。

最多可提供以下之一

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

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或其小写版本)。请求使用与其方案匹配的环境变量中的代理,除非被 NO_PROXY 排除。如果配置了 proxy_from_environment,则不得配置 proxy_urlno_proxy

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

authorization

名称类型描述默认值必需
credentials_filestring包含秘密值的文件。
credentialssecret秘密值。
typestring授权类型,例如“Bearer”。

credentialcredentials_file 是互斥的,在 authorization 块中只能提供其中之一。

basic_auth

名称类型描述默认值必需
password_filestring包含基本认证密码的文件。
passwordsecret基本认证密码。
usernamestring基本认证用户名。

passwordpassword_file 是互斥的,在 basic_auth 块中只能提供其中之一。

oauth2

名称类型描述默认值必需
client_idstringOAuth2 客户端 ID。
client_secret_filestring包含 OAuth2 客户端密钥的文件。
client_secretsecretOAuth2 客户端密钥。
endpoint_paramsmap(string)可选参数,附加到令牌 URL。
proxy_urlstring用于发送请求的 HTTP 代理。
no_proxystring逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。
proxy_from_environmentbool使用环境变量指示的代理 URL。false
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送到代理的标头。
scopeslist(string)用于认证的范围列表。
token_urlstring获取令牌的 URL。

client_secretclient_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_urlno_proxy

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

tls_config

名称类型描述默认值必需
ca_pemstring用于验证服务器的 CA PEM 编码文本。
ca_filestring用于验证服务器的 CA 证书。
cert_pemstring用于客户端认证的证书 PEM 编码文本。
cert_filestring用于客户端认证的证书文件。
insecure_skip_verifybool禁用对服务器证书的验证。
key_filestring用于客户端认证的密钥文件。
key_pemsecret用于客户端认证的密钥 PEM 编码文本。
min_versionstring最低可接受的 TLS 版本。
server_namestring用于指示服务器名称的 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)

导出的字段

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

组件健康状况

loki.source.kubernetes_events 仅在给定无效配置时报告为不健康。

调试信息

loki.source.kubernetes_events 公开每个被监听命名空间中事件的最新读取时间戳。

调试指标

loki.source.kubernetes_events 不公开任何组件特定的调试指标。

组件行为

该组件使用其数据路径(一个以域名的完全限定名称命名的目录)来存储其 positions file。positions file 用于存储读取偏移量,以便如果组件或 Alloy 重启,loki.source.kubernetes_events 可以从同一位置继续追踪。

数据路径位于由 --storage.path 命令行参数配置的目录内。

示例

此示例收集 kube-system 命名空间中的事件,并将其转发到 loki.write 组件,以便将其写入 Loki。

alloy
loki.source.kubernetes_events "example" {
  // Only watch for events in the kube-system namespace.
  namespaces = ["kube-system"]

  forward_to = [loki.write.local.receiver]
}

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

兼容组件

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

注意

连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。请参阅链接的文档了解更多详情。