podmanreceiver

README

Podman Stats Receiver

Status
Stability	development: metrics
Unsupported Platforms	windows
Distributions	contrib
Issues
Code Owners	@rogercoll

The Podman Stats receiver queries the Podman service API to fetch stats for all running containers on a configured interval. These stats are for container resource usage of cpu, memory, network, and the blkio controller.

ℹ 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 here with detailed sample configurations here.

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 exluded. 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

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (config Config) Validate() error
• type ContainerScraper
• type PodmanClient

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`

	// The URL of the podman server.  Default is "unix:///run/podman/podman.sock"
	Endpoint string `mapstructure:"endpoint"`

	APIVersion    string              `mapstructure:"api_version"`
	SSHKey        string              `mapstructure:"ssh_key"`
	SSHPassphrase configopaque.String `mapstructure:"ssh_passphrase"`

	// MetricsBuilderConfig config. Enable or disable stats by name.
	metadata.MetricsBuilderConfig `mapstructure:",squash"`
}

func (Config) Validate

func (config Config) Validate() error

type ContainerScraper

type ContainerScraper struct {
	// contains filtered or unexported fields
}

type PodmanClient

type PodmanClient interface {
	// contains filtered or unexported methods
}