Skip to main content

Documentation Index

Fetch the complete documentation index at: https://otel.fyi/llms.txt

Use this file to discover all available pages before exploring further.

​
Podman Receiver

Status Available in: contrib Maintainers: @rogercoll Source: opentelemetry-collector-contrib

​
Supported Telemetry

Metrics

​
Overview

:information_source: Requires Podman API version 3.3.1+ and Windows is not supported.

​
Configuration

The following settings are required:
  • endpoint (default = unix:///run/podman/podman.sock): Address to reach the desired Podman daemon.
The following settings are optional:
  • collection_interval (default = 10s): The interval at which to gather container stats.
  • initial_delay (default = 1s): defines how long this receiver waits before starting.
  • timeout (default = 5s): The maximum amount of time to wait for Podman API responses.
  • metrics (defaults at ./documentation.md): Enables/disables individual metrics. See ./documentation.md for full detail.
Example: 
receivers:
  podman_stats:
    endpoint: unix://run/podman/podman.sock
    timeout: 10s
    collection_interval: 10s
    initial_delay: 1s
    metrics:
      container.cpu.usage.system:
        enabled: false
The full list of settings exposed for this receiver are documented in config.go with detailed sample configurations in testdata/config.yaml.

​
Connecting over SSH

receivers:
  podman_stats:
    endpoint: ssh://core@localhost:53841/run/user/1000/podman/podman.sock
    ssh_key: /path/to/ssh/private/key
    ssh_passphrase: <password>

​
Podman API compatibility

The receiver has only been tested with API 3.3.1+ but it may work with older versions as well. If you want to use the receiver with an older API version, please set the api_version to the desired version. For example, 
receivers:
  podman_stats:
    endpoint: unix://run/podman/podman.sock
    api_version: 3.2.0

​
Metrics

The receiver emits the following metrics: container.memory.usage.limit container.memory.usage.total container.memory.percent container.network.io.usage.tx_bytes container.network.io.usage.rx_bytes container.blockio.io_service_bytes_recursive.write container.blockio.io_service_bytes_recursive.read container.cpu.usage.system container.cpu.usage.total container.cpu.percent container.cpu.usage.percpu See ./documentation.md for full detail.

​
Building

This receiver uses the official libpod Go bindings for Podman. In order to include this receiver in your build, you’ll need to make sure all non-Go dependencies are satisfied or some features are excluded. You can use the below mentioned build tags to exclude the non-Go dependencies. This receiver does not use any features enabled by these deps so excluding these does not affect the functionality in any way. Recommended build tags to use when including this receiver in your build:
  • containers_image_openpgp
  • exclude_graphdriver_btrfs
  • exclude_graphdriver_devicemapper

​
Metrics

Metric NameDescriptionUnitTypeAttributes
✅ container.blockio.io_service_bytes_recursive.readNumber of bytes transferred from the disk by the container{operations}Counter
✅ container.blockio.io_service_bytes_recursive.writeNumber of bytes transferred to the disk by the container{operations}Counter
✅ container.cpu.percentPercent of CPU used by the container.1Gauge
✅ container.cpu.usage.percpuTotal CPU time consumed per CPU-core.sCountercore
✅ container.cpu.usage.systemSystem CPU usage.sCounter
✅ container.cpu.usage.totalTotal CPU time consumed.sCounter
✅ container.memory.percentPercentage of memory used.1Gauge
✅ container.memory.usage.limitMemory limit of the container.ByUpDownCounter
✅ container.memory.usage.totalMemory usage of the container.ByUpDownCounter
✅ container.network.io.usage.rx_bytesBytes received by the container.ByCounter
✅ container.network.io.usage.tx_bytesBytes sent by the container.ByCounter

​
Attributes

Attribute NameDescriptionTypeValues
coreThe CPU core number when utilising per-CPU metrics.string

​
Resource Attributes

Attribute NameDescriptionTypeEnabled
container.idThe ID of the container.string✅
container.image.nameThe name of the image in use by the container.string✅
container.nameThe name of the container.string✅
container.runtimeThe runtime of the container. For this receiver, it will always be ‘podman’.string✅

​
Configuration

​
Example Configuration

podman_stats:
podman_stats/all:
  endpoint: http://example.com/
  collection_interval: 2s
  timeout: 20s
podman_stats/empty_endpoint:
  endpoint: ""
podman_stats/invalid_collection_interval:
  collection_interval: 0s
Last generated: 2026-04-20