Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana Agent Flow mode Reference Components reference loki.source.docker

loki.source.docker

loki.source.docker reads log entries from Docker containers and forwards them to other loki.* components. Each component can read from a single Docker daemon.

Multiple loki.source.docker components can be specified by giving them different labels.

Usage

river Copy

loki.source.docker "LABEL" {
  host       = HOST
  targets    = TARGET_LIST
  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.docker supports the following arguments:

Blocks

The following blocks are supported inside the definition of loki.source.docker:

The > symbol indicates deeper levels of nesting. For example, client > basic_auth refers to an basic_auth block defined inside a client block.

These blocks are only applicable when connecting to a Docker daemon over HTTP or HTTPS and has no effect when connecting via a unix:/// socket

client block

The client block configures settings used to connect to HTTP(S) Docker daemons.

bearer_token, bearer_token_file, basic_auth, authorization, and oauth2 are mutually exclusive, and only one can be provided inside of a http_client_config block.

basic_auth block

The basic_auth block configures basic authentication for HTTP(S) Docker daemons.

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

authorization block

The authorization block configures custom authorization to use for the Docker daemon.

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

oauth2 block

The oauth2 block configures OAuth2 authorization to use for the Docker daemon.

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.

tls_config block

The tls_config block configures TLS settings for connecting to HTTPS Docker daemons.

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

• ca_pem and ca_file
• cert_pem and cert_file
• key_pem and key_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 is not 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.docker does not export any fields.

Component health

loki.source.docker is only reported as unhealthy if given an invalid configuration.

Debug information

loki.source.docker exposes some debug information per target:

• Whether the target is ready to tail entries.
• The labels associated with the target.
• The most recent time a log line was read.

Debug metrics

• loki_source_docker_target_entries_total (gauge): Total number of successful entries sent to the Docker target.
• loki_source_docker_target_parsing_errors_total (gauge): Total number of parsing errors while receiving Docker messages.

Component behavior

The component uses its data path (a directory named after the domain’s fully qualified name) to store its positions file. The positions file stores the read offsets so that if there is a component or Agent restart, loki.source.docker can pick up tailing from the same spot.

Example

This example collects log entries from the files specified in the targets argument and forwards them to a loki.write component to be written to Loki.

river Copy

discovery.docker "linux" {
  host = "unix:///var/run/docker.sock"
}

loki.source.docker "default" {
  host       = "unix:///var/run/docker.sock"
  targets    = discovery.docker.linux.targets 
  forward_to = [loki.write.local.receiver]
}

loki.write "local" {
  endpoint {
    url = "loki:3100/api/v1/push"
  }
}