cgroup

README

CGroup Input Plugin

This input plugin will capture specific statistics per cgroup.

Consider restricting paths to the set of cgroups you really want to monitor if you have a large number of cgroups, to avoid any cardinality issues.

Following file formats are supported:

• Single value

VAL\n

• New line separated values

VAL0\n
VAL1\n

• Space separated values

VAL0 VAL1 ...\n

• Space separated keys and value, separated by new line

KEY0 ... VAL0\n
KEY1 ... VAL1\n

Metrics

All measurements have the path tag.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Read specific statistics per cgroup
# This plugin ONLY supports Linux
[[inputs.cgroup]]
  ## Directories in which to look for files, globs are supported.
  ## Consider restricting paths to the set of cgroups you really
  ## want to monitor if you have a large number of cgroups, to avoid
  ## any cardinality issues.
  # paths = [
  #   "/sys/fs/cgroup/memory",
  #   "/sys/fs/cgroup/memory/child1",
  #   "/sys/fs/cgroup/memory/child2/*",
  # ]
  ## cgroup stat fields, as file names, globs are supported.
  ## these file names are appended to each path from above.
  # files = ["memory.*usage*", "memory.limit_in_bytes"]

Example Configurations

# [[inputs.cgroup]]
  # paths = [
  #   "/sys/fs/cgroup/cpu",              # root cgroup
  #   "/sys/fs/cgroup/cpu/*",            # all container cgroups
  #   "/sys/fs/cgroup/cpu/*/*",          # all children cgroups under each container cgroup
  # ]
  # files = ["cpuacct.usage", "cpu.cfs_period_us", "cpu.cfs_quota_us"]

# [[inputs.cgroup]]
  # paths = [
  #   "/sys/fs/cgroup/unified/*",        # root cgroup
  # ]
  # files = ["*"]

Example Output

Documentation

Index

• type CGroup
  • func (g *CGroup) Gather(acc telegraf.Accumulator) error
  • func (cg *CGroup) Init() error
  • func (*CGroup) SampleConfig() string

Types

type CGroup

type CGroup struct {
	Paths []string `toml:"paths"`
	Files []string `toml:"files"`
	// contains filtered or unexported fields
}

func (*CGroup) Gather

func (g *CGroup) Gather(acc telegraf.Accumulator) error

func (*CGroup) Init

func (cg *CGroup) Init() error

func (*CGroup) SampleConfig

func (*CGroup) SampleConfig() string