The Docker Stats receiver queries the local Docker daemon's container stats API for all desired running containers on a configured interval. These stats are for container resource usage of cpu, memory, network, and the blkio controller.

ℹ️ Requires Docker API version 1.22+ and only Linux is supported.

The following settings are required:

• endpoint (default = unix:https:///var/run/docker.sock): Address to reach the desired Docker daemon.

The following settings are optional:

• collection_interval (default = 10s): The interval at which to gather container stats.
• container_labels_to_metric_labels (no default): A map of Docker container label names whose label values to use as the specified metric label key.
• env_vars_to_metric_labels (no default): A map of Docker container environment variables whose values to use as the specified metric label key.
• excluded_images (no default, all running containers monitored): A list of strings, regexes, or globs whose referent container image names will not be among the queried containers. !-prefixed negations are possible for all item types to signify that only unmatched container image names should be monitored.
  • Regexes must be placed between / characters: /my?egex/. Negations are to be outside the forward slashes: !/my?egex/ will monitor all containers whose name doesn't match the compiled regex my?egex.
  • Globs are non-regex items (e.g. /items/) containing any of the following: *[]{}?. Negations are supported: !my*container will monitor all containers whose image name doesn't match the blob my*container.
• provide_per_core_cpu_metrics (default = false): Whether to report cpu.usage.percpu metrics.
• timeout (default = 5s): The request timeout for any docker daemon query.
• api_version (default = 1.22): The Docker client API version (must be 1.22+). Docker API versions.

Example:

receivers:
  docker_stats:
    endpoint: http:https://example.com/
    collection_interval: 2s
    timeout: 20s
    api_version: 1.24
    container_labels_to_metric_labels:
      my.container.label: my-metric-label
      my.other.container.label: my-other-metric-label
    env_vars_to_metric_labels:
      MY_ENVIRONMENT_VARIABLE: my-metric-label
      MY_OTHER_ENVIRONMENT_VARIABLE: my-other-metric-label
    excluded_images:
      - undesired-container
      - /.*undesired.*/
      - another-*-container
    provide_per_core_cpu_metrics: true

The full list of settings exposed for this receiver are documented here with detailed sample configurations here.

See the Collector feature gates for an overview of feature gates in the collector.

ALPHA: receiver.dockerstats.useScraperV2

The feature gate receiver.dockerstatsd.useScraperV2 once enabled allows collection of selective metrics that is described in documentation.md. When the feature gate is disabled, the metrics settings are mostly ignored and not configurable with minor variation in metric name and attributes.

This is considered a breaking change for existing users of this receiver, and it is recommended to migrate to the new implementation when possible. Any new users planning to adopt this receiver should enable this feature gate to avoid having to migrate any visualisations or alerts.

This feature gate will eventually be enabled by default, and eventually the old implementation will be removed. It aims to give users time to migrate to the new implementation. The target release for this featuregate to be enabled by default is 0.60.0.