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
一起使用
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
forward_to | list(LogsReceiver) | 要将日志条目发送到的接收器列表。 | 是 | |
job_name | 字符串 | 用于为生成的日志的 job 标签的值。 | "loki.source.kubernetes_events" | 否 |
log_format | 字符串 | 日志的格式。 | "logfmt" | 否 |
namespaces | list(string) | 要在其中监视事件的命名空间。 | [] | 否 |
默认情况下,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_server | 字符串 | Kubernetes API 服务器的 URL。 | 否 | |
bearer_token_file | 字符串 | 包含用于身份验证的 bearer token 的文件。 | 否 | |
bearer_token | secret | 用于身份验证的 Bearer token。 | 否 | |
enable_http2 | bool | 是否支持请求的 HTTP2。 | true | 否 |
follow_redirects | bool | 是否应跟随服务器返回的重定向。 | true | 否 |
kubeconfig_file | 字符串 | 用于连接到 Kubernetes 的 kubeconfig 文件的路径。 | 否 | |
no_proxy | 字符串 | 要从代理中排除的 IP 地址、CIDR 表示法和域名,以逗号分隔的列表。 | 否 | |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 | |
proxy_from_environment | bool | 使用环境变量指示的代理 URL。 | false | 否 |
proxy_url | 字符串 | 用于发送请求的 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_url
和 no_proxy
。
仅当配置了 proxy_url
或 proxy_from_environment
时,才应配置 proxy_connect_header
。
authorization
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
credentials_file | 字符串 | 包含 secret 值的文件。 | 否 | |
credentials | secret | Secret 值。 | 否 | |
type | 字符串 | 授权类型,例如 “Bearer”。 | 否 |
credential
和 credentials_file
是互斥的,并且在 authorization
块内只能提供一个。
basic_auth
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | 字符串 | 包含 basic auth 密码的文件。 | 否 | |
password | secret | Basic auth 密码。 | 否 | |
username | 字符串 | Basic auth 用户名。 | 否 |
password
和 password_file
是互斥的,并且在 basic_auth
块内只能提供一个。
oauth2
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | 字符串 | OAuth2 客户端 ID。 | 否 | |
client_secret_file | 字符串 | 包含 OAuth2 客户端 secret 的文件。 | 否 | |
client_secret | secret | OAuth2 客户端 secret。 | 否 | |
endpoint_params | map(string) | 要附加到令牌 URL 的可选参数。 | 否 | |
proxy_url | 字符串 | 用于发送请求的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 要从代理中排除的 IP 地址、CIDR 表示法和域名,以逗号分隔的列表。 | 否 | |
proxy_from_environment | bool | 使用环境变量指示的代理 URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 | |
scopes | list(string) | 要进行身份验证的作用域列表。 | 否 | |
token_url | 字符串 | 从中获取令牌的 URL。 | 否 |
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_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
命令行参数 配置的目录内。
示例
此示例收集 kube-system
命名空间中的监视事件,并将它们转发到 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")
}
}
兼容组件
loki.source.kubernetes_events
可以接受来自以下组件的参数
- 导出 Loki
LogsReceiver
的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。