loki.source.podlogs
loki.source.podlogs
discovers PodLogs
resources on Kubernetes.
The PodLogs
resources provide rules for which Kubernetes Pods to discover on your cluster.
loki.source.podlogs
uses the Kubernetes API to tail the logs from the discovered Kubernetes Pods.
loki.source.podlogs
is similar to loki.source.kubernetes
, but uses custom resources rather than being fed targets from another component.
Note
Because
loki.source.podlogs
uses the Kubernetes API to tail logs, it uses more network traffic and CPU consumption of Kubelets thanloki.source.file
.
You can specify multiple loki.source.podlogs
components by giving them different labels.
Usage
loki.source.podlogs "<LABEL>" {
forward_to = <RECEIVER_LIST>
}
Arguments
The component starts a new reader for each of the given targets
and fans out log entries to the list of receivers passed in forward_to
.
loki.source.podlogs
supports the following arguments:
loki.source.podlogs
searches for PodLogs
resources on Kubernetes.
Each PodLogs
resource describes a set of pods to tail logs from.
PodLogs
custom resource
The PodLogs
resource describes a set of Pods to collect logs from.
Note
loki.source.podlogs
looks forPodLogs
ofmonitoring.grafana.com/v1alpha2
, and isn’t compatible withPodLogs
from the Agent Operator, which are versionv1alpha1
.
PodLogsSpec
PodLogsSpec
describes a set of Pods to collect logs from.
If selector
is left as the default value, all Pods are discovered.
If namespaceSelector
is left as the default value, all Namespaces are used for Pod discovery.
The relabelings
field can be used to modify labels from discovered Pods.
The following meta labels are available for relabeling:
__meta_kubernetes_namespace
: The namespace of the Pod.__meta_kubernetes_pod_annotation_<annotationname>
: Each annotation from the Pod.__meta_kubernetes_pod_annotationpresent_<annotationname>
:true
for each annotation from the Pod.__meta_kubernetes_pod_container_image
: The image the container is using.__meta_kubernetes_pod_container_init
:true
if the container is anInitContainer
.__meta_kubernetes_pod_container_name
: Name of the container.__meta_kubernetes_pod_controller_kind
: Object kind of the Pod’s controller.__meta_kubernetes_pod_controller_name
: Name of the Pod’s controller.__meta_kubernetes_pod_host_ip
: The current host IP of the Pod object.__meta_kubernetes_pod_ip
: The Pod IP of the Pod.__meta_kubernetes_pod_label_<labelname>
: Each label from the Pod.__meta_kubernetes_pod_labelpresent_<labelname>
:true
for each label from the Pod.__meta_kubernetes_pod_name
: The name of the Pod.__meta_kubernetes_pod_node_name
: The name of the node the Pod is scheduled onto.__meta_kubernetes_pod_phase
: Set toPending
,Running
,Succeeded
,Failed
orUnknown
in the lifecycle.__meta_kubernetes_pod_ready
: Set totrue
orfalse
for the Pod’s ready state.__meta_kubernetes_pod_uid
: The UID of the Pod.
In addition to the meta labels, the following labels are exposed to tell loki.source.podlogs
which container to tail:
__pod_container_name__
: The container name within the Pod.__pod_name__
: The name of the Pod.__pod_namespace__
: The namespace of the Pod.__pod_uid__
: The UID of the Pod.
Blocks
You can use the following blocks with loki.source.podlogs
:
The > symbol indicates deeper levels of nesting.
For example, client
> basic_auth
refers to a basic_auth
block defined inside a client
block.
client
The client
block configures the Kubernetes client used to tail logs from containers.
If the client
block isn’t provided, the default in-cluster configuration with the service account of the running Alloy Pod is used.
The following arguments are supported:
At most, one of the following can be provided:
authorization
blockbasic_auth
blockbearer_token_file
argumentbearer_token
argumentoauth2
block
no_proxy
can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers.
proxy_url
must be configured if no_proxy
is configured.
proxy_from_environment
uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof).
Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.
proxy_url
and no_proxy
must not be configured if proxy_from_environment
is configured.
proxy_connect_header
should only be configured if proxy_url
or proxy_from_environment
are configured.
authorization
credential
and credentials_file
are mutually exclusive, and only one can be provided inside an authorization
block.
basic_auth
password
and password_file
are mutually exclusive, and only one can be provided inside a basic_auth
block.
clustering
When Alloy is using clustering, and enabled
is set to true, then this
loki.source.podlogs
component instance opts-in to participating in the
cluster to distribute the load of log collection between all cluster nodes.
If Alloy is not running in clustered mode, then the block is a no-op and
loki.source.podlogs
collects logs based on every PodLogs resource discovered.
Clustering looks only at the following labels for determining the 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
The match_expression
block describes a Kubernetes label match expression for PodLogs
or Namespace discovery.
The following arguments are supported:
The operator
argument must be one of the following strings:
"In"
"NotIn"
"Exists"
"DoesNotExist"
Both selector
and namespace_selector
can make use of multiple
match_expression
inner blocks which are treated as AND clauses.
oauth2
client_secret
and client_secret_file
are mutually exclusive, and only one can be provided inside an oauth2
block.
The oauth2
block may also contain a separate tls_config
sub-block.
no_proxy
can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers.
proxy_url
must be configured if no_proxy
is configured.
proxy_from_environment
uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof).
Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.
proxy_url
and no_proxy
must not be configured if proxy_from_environment
is configured.
proxy_connect_header
should only be configured if proxy_url
or proxy_from_environment
are configured.
selector
and namespace_selector
The selector
and namespce_selector
blocks describe a Kubernetes label selector for PodLogs
or Namespace discovery.
The following arguments are supported:
When the match_labels
argument is empty, all resources are matched.
tls_config
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_file
When configuring client authentication, both the client certificate (using cert_pem
or cert_file
) and the client key (using key_pem
or key_file
) must be provided.
When min_version
isn’t provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2.
If min_version
is provided, it must be set to one of the following strings:
"TLS10"
(TLS 1.0)"TLS11"
(TLS 1.1)"TLS12"
(TLS 1.2)"TLS13"
(TLS 1.3)
Exported fields
loki.source.podlogs
doesn’t export any fields.
Component health
loki.source.podlogs
is only reported as unhealthy if given an invalid configuration.
Debug information
loki.source.podlogs
exposes some target-level debug information per target:
- The labels associated with the target.
- The full set of labels which were found during service discovery.
- The most recent time a log line was read and forwarded to the next components in the pipeline.
- The most recent error from tailing, if any.
Debug metrics
loki.source.podlogs
doesn’t expose any component-specific debug metrics.
Example
This example discovers all PodLogs
resources and forwards collected logs to a loki.write
component so they’re written to Loki.
loki.source.podlogs "default" {
forward_to = [loki.write.local.receiver]
}
loki.write "local" {
endpoint {
url = sys.env("LOKI_URL")
}
}
Compatible components
loki.source.podlogs
can accept arguments from the following components:
- Components that export Loki
LogsReceiver
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.