文档

Grafana Alloy

参考

组件

loki

loki.source.kubernetes_events

开源

loki.source.kubernetes_events

loki.source.kubernetes_events 从 Kubernetes API 获取事件并转换为日志行以转发到其他 loki 组件。

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

用法

loki.source.kubernetes_events "LABEL" {
  forward_to = RECEIVER_LIST
}

参数

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

loki.source.kubernetes_events 支持以下参数

名称	类型	描述	默认值	必需
`job_name`	`字符串`	用于生成日志的 `job` 标签的值。	`"loki.source.kubernetes_events"`	否
`log_format`	`字符串`	日志格式。	`"logfmt"`	否
`namespaces`	`列表（字符串）`	要监视事件的命名空间。	`[]`	否
`forward_to`	`列表（日志接收器）`	要发送日志条目的接收器列表。		是

默认情况下，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参数是空字符串，则组件将无法加载。要删除作业标签，将loki.source.kubernetes_events的输出转发到一个loki.relabel组件。

为了与静态模式中的eventhandler集成兼容，可以将job_name设置为"integrations/kubernetes/eventhandler"。

块

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

层次结构	块	描述	必需
client	client	配置用于跟踪日志的Kubernetes客户端。	否
client > basic_auth	basic_auth	配置用于端点的认证的基本认证。	否
client > authorization	authorization	配置端点的通用认证。	否
client > oauth2	oauth2	配置用于端点认证的OAuth2。	否
client > oauth2 > tls_config	tls_config	配置连接到端点的TLS设置。	否
client > tls_config	tls_config	配置连接到端点的TLS设置。	否

符号>表示更深的嵌套级别。例如，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令牌的文件。		否
`bearer_token`	`secret`	用于认证的bearer令牌。		否
`enable_http2`	`bool`	是否支持请求的HTTP2。	`true`	否
`follow_redirects`	`bool`	是否应跟随服务器返回的重定向。	`true`	否
`proxy_url`	`字符串`	要通过其发送请求的HTTP代理。		否
`no_proxy`	`字符串`	以逗号分隔的IP地址、CIDR表示法和域名列表，不包括在代理中。		否
`proxy_from_environment`	`bool`	使用环境变量指示的代理URL。	`false`	否
`proxy_connect_header`	`map(list(secret))`	指定在CONNECT请求期间发送到代理的标头。		否

以下之一最多可以提供

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_url 或 proxy_from_environment，则应仅配置 proxy_connect_header。

基本身份验证块

名称	类型	描述	必需
`密码文件`	`字符串`	包含基本身份验证密码的文件。	否
`密码`	`secret`	基本身份验证密码。	否
`用户名`	`字符串`	基本身份验证用户名。	否

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

授权块

名称	类型	描述	必需
`凭证文件`	`字符串`	包含秘密值的文件。	否
`凭证`	`secret`	秘密值。	否
`类型`	`字符串`	授权类型，例如，“Bearer”。	否

credential 和 credentials_file 是互斥的，且在 authorization 块内只能提供其中一个。

OAuth2 块

名称	类型	描述	默认值	必需
`客户端 ID`	`字符串`	OAuth2 客户端 ID。		否
`客户端密钥文件`	`字符串`	包含 OAuth2 客户端密钥的文件。		否
`客户端密钥`	`secret`	OAuth2 客户端密钥。		否
`端点参数`	`map(string)`	追加到令牌 URL 的可选参数。		否
`proxy_url`	`字符串`	要通过其发送请求的HTTP代理。		否
`no_proxy`	`字符串`	以逗号分隔的IP地址、CIDR表示法和域名列表，不包括在代理中。		否
`proxy_from_environment`	`bool`	使用环境变量指示的代理URL。	`false`	否
`proxy_connect_header`	`map(list(secret))`	指定在CONNECT请求期间发送到代理的标头。		否
`作用域`	`列表（字符串）`	用于验证的作用域列表。		否
`令牌 URL`	`字符串`	获取令牌的 URL。		否

client_secret 和 client_secret_file 是互斥的，且在 oauth2 块内只能提供其中一个。

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

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

如果配置了 proxy_url 或 proxy_from_environment，则应仅配置 proxy_connect_header。

tls_config 块

名称	类型	描述	必需
`ca_pem`	`字符串`	用于验证服务器的 CA PEM 编码文本。	否
`ca_file`	`字符串`	用于验证服务器的 CA 证书。	否
`cert_pem`	`字符串`	用于客户端身份验证的证书 PEM 编码文本。	否
`cert_file`	`字符串`	用于客户端身份验证的证书文件。	否
`insecure_skip_verify`	`bool`	禁用服务器证书的验证。	否
`key_file`	`字符串`	用于客户端身份验证的密钥文件。	否
`key_pem`	`secret`	用于客户端身份验证的密钥 PEM 编码文本。	否
`min_version`	`字符串`	可接受的最小 TLS 版本。	否
`server_name`	`字符串`	ServerName 扩展以指示服务器名称。	否

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

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)

导出字段

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

组件健康

只有当提供无效配置时，loki.source.kubernetes_events 才会报告为不健康。

调试信息

loki.source.kubernetes_events 公开了每个监视命名空间事件最近读取的时间戳。

调试度量

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

组件行为

该组件使用其数据路径，一个以域名完全限定名命名的目录，来存储其 位置文件。位置文件用于存储读取偏移量，以便在组件或 Alloy 重启后，loki.source.kubernetes_events 可以从同一位置继续。

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

在Grafana Agent静态版本的eventhandler集成中，使用cache_path参数来配置一个位置文件。在Alloy中，这个参数不再需要。

示例

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

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")
  }
}