loki.source.podlogs
loki.source.podlogs
在 Kubernetes 上发现 PodLogs
资源。PodLogs
资源提供规则,用于确定在集群中发现哪些 Kubernetes Pod。
loki.source.podlogs
使用 Kubernetes API 从发现的 Kubernetes Pod 中追踪日志。
loki.source.podlogs
与 loki.source.kubernetes
类似,但使用自定义资源而不是从另一个组件获取目标。
注意
由于
loki.source.podlogs
使用 Kubernetes API 追踪日志,它比loki.source.file
使用更多的网络流量和 Kubelet CPU 消耗。
你可以通过为它们指定不同的标签来指定多个 loki.source.podlogs
组件。
用法
loki.source.podlogs "<LABEL>" {
forward_to = <RECEIVER_LIST>
}
参数
该组件为每个给定的 targets
启动一个新的读取器,并将日志条目扇出到 forward_to
中传递的接收器列表。
loki.source.podlogs
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
forward_to | list(LogsReceiver) | 发送日志条目到的接收器列表。 | 是 |
loki.source.podlogs
在 Kubernetes 上搜索 PodLogs
资源。每个 PodLogs
资源描述了一组要从中追踪日志的 Pod。
PodLogs
自定义资源
PodLogs
资源描述了一组要从中收集日志的 Pod。
注意
loki.source.podlogs
查找monitoring.grafana.com/v1alpha2
版本的PodLogs
,并且与 Agent Operator 的PodLogs
不兼容,后者版本为v1alpha1
。
字段 | 类型 | 描述 |
---|---|---|
apiVersion | string | monitoring.grafana.com/v1alpha2 |
kind | string | PodLogs |
metadata | ObjectMeta | PodLogs 的元数据。 |
spec | PodLogsSpec | 定义要从哪些 Pod 收集日志。 |
PodLogsSpec
PodLogsSpec
描述了一组要从中收集日志的 Pod。
字段 | 类型 | 描述 |
---|---|---|
selector | LabelSelector | 用于选择要从中收集日志的 Pod 的标签选择器。 |
namespaceSelector | LabelSelector | 用于选择可以发现 Pod 的命名空间的标签选择器。 |
relabelings | RelabelConfig | 应用于发现的 Pod 的 relabeling 规则。 |
如果 selector
使用默认值,则发现所有 Pod。如果 namespaceSelector
使用默认值,则使用所有命名空间进行 Pod 发现。
relabelings
字段可用于修改发现的 Pod 的标签。以下元标签可用于 relabeling
__meta_kubernetes_namespace
: Pod 的命名空间。__meta_kubernetes_pod_annotation_<annotationname>
: Pod 的每个 annotation。__meta_kubernetes_pod_annotationpresent_<annotationname>
: Pod 的每个 annotation 为true
。__meta_kubernetes_pod_container_image
: 容器正在使用的镜像。__meta_kubernetes_pod_container_init
: 如果容器是InitContainer
,则为true
。__meta_kubernetes_pod_container_name
: 容器名称。__meta_kubernetes_pod_controller_kind
: Pod 控制器的对象类型。__meta_kubernetes_pod_controller_name
: Pod 控制器名称。__meta_kubernetes_pod_host_ip
: Pod 对象的当前主机 IP。__meta_kubernetes_pod_ip
: Pod 的 Pod IP。__meta_kubernetes_pod_label_<labelname>
: Pod 的每个标签。__meta_kubernetes_pod_labelpresent_<labelname>
: Pod 的每个标签为true
。__meta_kubernetes_pod_name
: Pod 名称。__meta_kubernetes_pod_node_name
: Pod 被调度到的节点名称。__meta_kubernetes_pod_phase
: 生命周期中的状态,可为Pending
,Running
,Succeeded
,Failed
或Unknown
。__meta_kubernetes_pod_ready
: Pod 的就绪状态,可为true
或false
。__meta_kubernetes_pod_uid
: Pod 的 UID。
除了元标签外,还公开了以下标签,用于告知 loki.source.podlogs
要追踪哪个容器
__pod_container_name__
: Pod 中的容器名称。__pod_name__
: Pod 名称。__pod_namespace__
: Pod 的命名空间。__pod_uid__
: Pod 的 UID。
块
你可以配合 loki.source.podlogs
使用以下块
块 | 描述 | 必需 |
---|---|---|
client | 配置用于追踪日志的 Kubernetes 客户端。 | 否 |
client > authorization | 配置到端点的通用授权。 | 否 |
client > basic_auth | 配置用于通过 basic_auth 对端点进行认证。 | 否 |
client > oauth2 | 配置用于通过 OAuth 2.0 对端点进行认证。 | 否 |
client > oauth2 > tls_config | 配置连接到端点的 TLS 设置。 | 否 |
client > tls_config | 配置连接到端点的 TLS 设置。 | 否 |
clustering | 配置组件以便在 Alloy 运行在集群模式下时使用。 | 否 |
namespace_selector | 用于选择在哪些命名空间发现 PodLogs 的标签选择器。 | 否 |
namespace_selector > match_expression | 用于选择在哪些命名空间发现 PodLogs 的标签选择器表达式。 | 否 |
selector | 用于选择发现哪些 PodLogs 的标签选择器。 | 否 |
selector > match_expression | 用于选择发现哪些 PodLogs 的标签选择器表达式。 | 否 |
> 符号表示更深的嵌套层级。例如,client
> basic_auth
指的是在 client
块内部定义的 basic_auth
块。
client
client
块配置用于从容器追踪日志的 Kubernetes 客户端。如果未提供 client
块,则使用正在运行的 Alloy Pod 的服务账户的默认集群内配置。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
api_server | string | Kubernetes API 服务器的 URL。 | 否 | |
bearer_token_file | string | 包含用于认证的 bearer 令牌的文件。 | 否 | |
bearer_token | secret | 用于认证的 Bearer 令牌。 | 否 | |
enable_http2 | bool | 请求是否支持 HTTP2。 | true | 否 |
follow_redirects | bool | 是否应遵循服务器返回的重定向。 | true | 否 |
http_headers | map(list(secret)) | 随每个请求发送的自定义 HTTP 头部。map 的键是头部名称。 | 否 | |
kubeconfig_file | string | 用于连接到 Kubernetes 的 kubeconfig 文件路径。 | 否 | |
no_proxy | string | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的头部。 | 否 | |
proxy_from_environment | bool | 使用环境变量指定的代理 URL。 | false | 否 |
proxy_url | string | 用于发送请求的 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 | string | 包含 secret 值的文件。 | 否 | |
credentials | secret | Secret 值。 | 否 | |
type | string | 授权类型,例如“Bearer”。 | 否 |
credential
和 credentials_file
是互斥的,authorization
块中只能提供其中一个。
basic_auth
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | string | 包含 basic auth 密码的文件。 | 否 | |
password | secret | Basic auth 密码。 | 否 | |
username | string | Basic auth 用户名。 | 否 |
password
和 password_file
是互斥的,basic_auth
块中只能提供其中一个。
clustering
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
enabled | bool | 与其他集群节点一起分发日志收集。 | 是 |
当 Alloy 使用集群模式运行,并且 enabled
设置为 true 时,此 loki.source.podlogs
组件实例会选择参与集群,以便在所有集群节点之间分配日志收集负载。
如果 Alloy 未在集群模式下运行,则此块无效,loki.source.podlogs
将根据发现的每个 PodLogs 资源收集日志。
集群模式仅查看以下标签来确定 shard key
__pod_namespace__
__pod_name__
__pod_container_name__
__pod_uid__
__meta_kubernetes_namespace
__meta_kubernetes_pod_name
__meta_kubernetes_pod_container_name
__meta_kubernetes_pod_uid
container
pod
job
namespace
match_expression
match_expression
块描述了用于 PodLogs
或命名空间发现的 Kubernetes 标签匹配表达式。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
key | string | 要匹配的标签名称。 | 是 | |
operator | string | 匹配时使用的运算符。 | 是 | |
values | list(string) | 匹配时使用的值。 | 否 |
operator
参数必须是以下字符串之一
"In"
"NotIn"
"Exists"
"DoesNotExist"
selector
和 namespace_selector
都可以使用多个 match_expression
内联块,它们被视为 AND 子句。
oauth2
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | string | OAuth2 客户端 ID。 | 否 | |
client_secret_file | string | 包含 OAuth2 客户端 secret 的文件。 | 否 | |
client_secret | secret | OAuth2 客户端 secret。 | 否 | |
endpoint_params | map(string) | 可选参数,将附加到令牌 URL。 | 否 | |
proxy_url | string | 用于发送请求的 HTTP 代理。 | 否 | |
no_proxy | string | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
proxy_from_environment | bool | 使用环境变量指定的代理 URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的头部。 | 否 | |
scopes | list(string) | 用于认证的 scope 列表。 | 否 | |
token_url | string | 用于获取令牌的 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
。
selector
和 namespace_selector
selector
和 namespace_selector
块描述了用于 PodLogs
或命名空间发现的 Kubernetes 标签选择器。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
match_labels | map(string) | 用于发现资源的标签键和值。 | {} | 否 |
当 match_labels
参数为空时,匹配所有资源。
tls_config
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
ca_pem | string | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
ca_file | string | 用于验证服务器的 CA 证书文件。 | 否 | |
cert_pem | string | 用于客户端认证的证书 PEM 编码文本。 | 否 | |
cert_file | string | 用于客户端认证的证书文件。 | 否 | |
insecure_skip_verify | bool | 禁用对服务器证书的验证。 | 否 | |
key_file | string | 用于客户端认证的密钥文件。 | 否 | |
key_pem | secret | 用于客户端认证的密钥 PEM 编码文本。 | 否 | |
min_version | string | 可接受的最低 TLS 版本。 | 否 | |
server_name | string | 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.podlogs
不导出任何字段。
组件健康状况
仅当配置无效时,loki.source.podlogs
才被报告为不健康。
调试信息
loki.source.podlogs
为每个目标公开了一些目标级调试信息
- 与目标关联的标签。
- 服务发现期间找到的完整标签集。
- 最近一次读取日志行并将其转发到管道中下一个组件的时间。
- 最近一次追踪时发生的错误(如果有)。
调试指标
loki.source.podlogs
不公开任何组件特定的调试指标。
示例
此示例发现所有 PodLogs
资源并将收集到的日志转发到 loki.write
组件,以便将它们写入 Loki。
loki.source.podlogs "default" {
forward_to = [loki.write.local.receiver]
}
loki.write "local" {
endpoint {
url = sys.env("LOKI_URL")
}
}
兼容组件
loki.source.podlogs
可以接受来自以下组件的参数
- 导出 Loki
LogsReceiver
的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。