telegraf/plugins/inputs/cgroup/README.md

73 lines
1.3 KiB
Markdown
Raw Normal View History

# CGroup Input Plugin
2016-06-08 16:13:22 +08:00
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.
2016-06-08 16:13:22 +08:00
Following file formats are supported:
* Single value
```
VAL\n
```
* New line separated values
```
VAL0\n
VAL1\n
```
* Space separated values
```
VAL0 VAL1 ...\n
```
* New line separated key-space-value's
```
KEY0 VAL0\n
KEY1 VAL1\n
```
### Tags:
All measurements have the following tags:
- path
2016-06-08 16:13:22 +08:00
### Configuration:
2020-07-25 00:42:17 +08:00
```toml
2016-06-08 16:13:22 +08:00
# [[inputs.cgroup]]
# paths = [
2020-07-25 00:42:17 +08:00
# "/sys/fs/cgroup/memory", # root cgroup
# "/sys/fs/cgroup/memory/child1", # container cgroup
# "/sys/fs/cgroup/memory/child2/*", # all children cgroups under child2, but not child2 itself
2016-06-08 16:13:22 +08:00
# ]
# files = ["memory.*usage*", "memory.limit_in_bytes"]
2020-07-25 00:42:17 +08:00
```
2016-06-08 16:13:22 +08:00
2020-07-25 00:42:17 +08:00
### usage examples:
```toml
2016-06-08 16:13:22 +08:00
# [[inputs.cgroup]]
# paths = [
2020-07-25 00:42:17 +08:00
# "/sys/fs/cgroup/cpu", # root cgroup
# "/sys/fs/cgroup/cpu/*", # all container cgroups
# "/sys/fs/cgroup/cpu/*/*", # all children cgroups under each container cgroup
2016-06-08 16:13:22 +08:00
# ]
# files = ["cpuacct.usage", "cpu.cfs_period_us", "cpu.cfs_quota_us"]
2020-07-25 00:42:17 +08:00
# [[inputs.cgroup]]
# paths = [
# "/sys/fs/cgroup/unified/*", # root cgroup
# ]
# files = ["*"]
2016-06-08 16:13:22 +08:00
```