@cryptotaxi247 / netdata-1 / commits / 78ec2eddb

Regenerate integrations docs (#21738)

Co-authored-by: ktsaou <2662304+ktsaou@users.noreply.github.com>

Netdata bot committed Feb 11, 2026 at 19:57 UTC 78ec2eddbdc03601359a750c421f9090c8a0ec46
17 files changed +1442 -35
src/collectors/COLLECTORS.md
+17 -8
@@ -160,18 +160,26 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
160
161 | Integration | Description |
162 |-------------|-------------|
163 -| [Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/containers.md) | Monitor Containers for performance, resource usage, and health status. |
163 +| [AWS ECS Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/aws_ecs_containers.md) | Monitor AWS ECS container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
164 +| [containerd Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/containerd_containers.md) | Monitor containerd container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
165 +| [Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/containers.md) | Monitor containers and virtual machines resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
166 | [Docker](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/docker/integrations/docker.md) | This collector monitors Docker containers state, health status and more. |
167 +| [Docker Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/docker_containers.md) | Monitor Docker container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
168 | [Docker Engine](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/docker_engine/integrations/docker_engine.md) | This collector monitors the activity and health of Docker Engine and Docker Swarm. |
169 | [Docker Hub repository](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/dockerhub/integrations/docker_hub_repository.md) | This collector keeps track of DockerHub repositories statistics such as the number of stars, pulls, current status, and more. |
167 -| [Libvirt Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/libvirt_containers.md) | Monitor Libvirt for performance, resource usage, and health status. |
168 -| [LXC Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/lxc_containers.md) | Monitor LXC Containers for performance, resource usage, and health status. |
169 -| [oVirt Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/ovirt_containers.md) | Monitor oVirt for performance, resource usage, and health status. |
170 +| [Libvirt VMs and Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/libvirt_vms_and_containers.md) | Monitor libvirt-managed VM and container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
171 +| [LXC Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/lxc_containers.md) | Monitor LXC/LXD/Incus container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
172 +| [Nomad Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/nomad_containers.md) | Monitor HashiCorp Nomad container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
173 +| [OpenShift Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/openshift_containers.md) | Monitor Red Hat OpenShift container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
174 +| [OpenStack VMs](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/openstack_vms.md) | Monitor OpenStack Nova virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
175 +| [oVirt VMs](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/ovirt_vms.md) | Monitor oVirt/RHEV virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
176 | [Podman](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/podman.md) | Keep tabs on Podman container runtime metrics for efficient container management and performance. |
171 -| [Proxmox Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/proxmox_containers.md) | Monitor Proxmox for performance, resource usage, and health status. |
177 +| [Podman Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/podman_containers.md) | Monitor Podman container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
178 | [Proxmox VE](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/proxmox_ve.md) | Keep tabs on Proxmox Virtual Environment metrics for efficient virtualization and container management. |
179 +| [Proxmox VMs and Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/proxmox_vms_and_containers.md) | Monitor Proxmox VE virtual machine and container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
180 +| [systemd-nspawn Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/systemd-nspawn_containers.md) | Monitor systemd-nspawn container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
181 | [vCenter Server Appliance](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/vcsa/integrations/vcenter_server_appliance.md) | This collector monitors [health statistics](https://developer.vmware.com/apis/vsphere-automation/latest/appliance/health/) of vCenter Server Appliance servers. |
174 -| [Virtual Machines](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/virtual_machines.md) | Monitor Virtual Machines for performance, resource usage, and health status. |
182 +| [Virtual Machines](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/virtual_machines.md) | Monitor virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
183 | [VMware vCenter Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/vsphere/integrations/vmware_vcenter_server.md) | This collector monitors hosts and vms performance statistics from `vCenter` servers. |
184 | [Xen XCP-ng](https://github.com/netdata/netdata/blob/master/src/collectors/xenstat.plugin/integrations/xen_xcp-ng.md) | This collector monitors XenServer and XCP-ng host and domains statistics. |
185
@@ -224,7 +232,8 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
232 | [Kubelet](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/k8s_kubelet/integrations/kubelet.md) | This collector monitors Kubelet instances. |
233 | [Kubeproxy](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/k8s_kubeproxy/integrations/kubeproxy.md) | This collector monitors Kubeproxy instances. |
234 | [Kubernetes Cluster State](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/k8s_state/integrations/kubernetes_cluster_state.md) | This collector monitors Kubernetes Nodes, Pods and Containers. |
227 -| [Kubernetes Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/kubernetes_containers.md) | Monitor Containers for performance, resource usage, and health status. |
235 +| [Kubernetes Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/kubernetes_containers.md) | Monitor containers and virtual machines resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
236 +| [OpenShift Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/openshift_containers.md) | Monitor Red Hat OpenShift container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
237
238 ### Incident Management
239
@@ -602,7 +611,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
611
612 | Integration | Description |
613 |-------------|-------------|
605 -| [Systemd Services](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/systemd_services.md) | Monitor Containers for performance, resource usage, and health status. |
614 +| [Systemd Services](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/systemd_services.md) | Monitor containers and virtual machines resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
615 | [Systemd Units](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/systemdunits/integrations/systemd_units.md) | This collector monitors the state of Systemd units and unit files. |
616 | [systemd-logind users](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/logind/integrations/systemd-logind_users.md) | This collector monitors number of sessions and users as reported by the `org.freedesktop.login1` DBus API. |
617
src/collectors/cgroups.plugin/integrations/aws_ecs_containers.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/aws_ecs_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "AWS ECS Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['aws', 'ecs', 'elastic container service', 'amazon', 'containers']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# AWS ECS Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/aws.svg" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor AWS ECS container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/containerd_containers.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/containerd_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "containerd Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['containerd', 'containers', 'cri', 'container runtime', 'nerdctl']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# containerd Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/containerd.svg" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor containerd container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/containers.md
+2 -2
@@ -5,7 +5,7 @@ sidebar_label: "Containers"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Containers and VMs"
7 most_popular: True
8 -keywords: ['containers', 'docker']
8 +keywords: ['containers', 'docker', 'podman', 'containerd', 'cri-o', 'lxc', 'lxd', 'incus', 'nomad', 'ecs', 'systemd-nspawn', 'nspawn', 'cgroups', 'linux containers']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor Containers for performance, resource usage, and health status.
25 +Monitor containers and virtual machines resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/docker_containers.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/docker_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "Docker Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['docker', 'containers', 'docker compose', 'docker swarm', 'moby', 'containerd', 'runc']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# Docker Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/docker.svg" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor Docker container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/kubernetes_containers.md
+2 -2
@@ -5,7 +5,7 @@ sidebar_label: "Kubernetes Containers"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Kubernetes"
7 most_popular: True
8 -keywords: ['k8s', 'kubernetes', 'pods', 'containers']
8 +keywords: ['k8s', 'kubernetes', 'pods', 'containers', 'openshift', 'rancher', 'rke', 'rke2', 'k3s', 'microk8s', 'eks', 'gke', 'aks', 'tanzu', 'minikube', 'kind', 'containerd', 'cri-o', 'kubelet', 'kubepods']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor Containers for performance, resource usage, and health status.
25 +Monitor containers and virtual machines resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/libvirt_vms_and_containers.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/libvirt_vms_and_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "Libvirt VMs and Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['libvirt', 'kvm', 'qemu', 'virsh', 'virt-manager', 'virtual machine', 'vm', 'container']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# Libvirt VMs and Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/libvirt.png" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor libvirt-managed VM and container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/lxc_containers.md
+2 -2
@@ -5,7 +5,7 @@ sidebar_label: "LXC Containers"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Containers and VMs"
7 most_popular: True
8 -keywords: ['lxc', 'lxd', 'container']
8 +keywords: ['lxc', 'lxd', 'incus', 'linux containers', 'system containers', 'container']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor LXC Containers for performance, resource usage, and health status.
25 +Monitor LXC/LXD/Incus container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/nomad_containers.md renamed
+6 -6
@@ -1,18 +1,18 @@
1 <!--startmeta
2 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/proxmox_containers.md"
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/nomad_containers.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 -sidebar_label: "Proxmox Containers"
4 +sidebar_label: "Nomad Containers"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Containers and VMs"
7 most_popular: True
8 -keywords: ['proxmox', 'container']
8 +keywords: ['nomad', 'hashicorp', 'containers', 'orchestrator']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
12 -# Proxmox Containers
12 +# Nomad Containers
13
14
15 -<img src="https://netdata.cloud/img/proxmox.png" width="150"/>
15 +<img src="https://netdata.cloud/img/nomad.svg" width="150"/>
16
17
18 Plugin: cgroups.plugin
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor Proxmox for performance, resource usage, and health status.
25 +Monitor HashiCorp Nomad container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/openshift_containers.md new
+187
@@ -0,0 +1,187 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/openshift_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "OpenShift Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['openshift', 'red hat openshift', 'okd', 'kubernetes', 'k8s', 'containers', 'pods']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# OpenShift Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/openshift.svg" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor Red Hat OpenShift container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per k8s cgroup
57 +
58 +These metrics refer to the Pod container.
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| k8s_node_name | Node name. The value of _pod.spec.nodeName_. |
65 +| k8s_namespace | Namespace name. The value of _pod.metadata.namespace_. |
66 +| k8s_controller_kind | Controller kind (ReplicaSet, DaemonSet, StatefulSet, Job, etc.). The value of _pod.OwnerReferences.Controller.Kind_. |
67 +| k8s_controller_name | Controller name.The value of _pod.OwnerReferences.Controller.Name_. |
68 +| k8s_pod_name | Pod name. The value of _pod.metadata.name_. |
69 +| k8s_container_name | Container name. The value of _pod.spec.containers.name_. |
70 +| k8s_kind | Instance kind: "pod" or "container". |
71 +| k8s_qos_class | QoS class (guaranteed, burstable, besteffort). |
72 +| k8s_cluster_id | Cluster ID. The value of kube-system namespace _namespace.metadata.uid_. |
73 +
74 +Metrics:
75 +
76 +| Metric | Dimensions | Unit |
77 +|:------|:----------|:----|
78 +| k8s.cgroup.cpu_limit | used | percentage |
79 +| k8s.cgroup.cpu | user, system | percentage |
80 +| k8s.cgroup.cpu_per_core | a dimension per core | percentage |
81 +| k8s.cgroup.throttled | throttled | percentage |
82 +| k8s.cgroup.throttled_duration | duration | ms |
83 +| k8s.cgroup.cpu_shares | shares | shares |
84 +| k8s.cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
85 +| k8s.cgroup.writeback | dirty, writeback | MiB |
86 +| k8s.cgroup.mem_activity | in, out | MiB/s |
87 +| k8s.cgroup.pgfaults | pgfault, swap | MiB/s |
88 +| k8s.cgroup.mem_usage | ram, swap | MiB |
89 +| k8s.cgroup.mem_usage_limit | available, used | MiB |
90 +| k8s.cgroup.mem_utilization | utilization | percentage |
91 +| k8s.cgroup.mem_failcnt | failures | count |
92 +| k8s.cgroup.io | read, write | KiB/s |
93 +| k8s.cgroup.serviced_ops | read, write | operations/s |
94 +| k8s.cgroup.throttle_io | read, write | KiB/s |
95 +| k8s.cgroup.throttle_serviced_ops | read, write | operations/s |
96 +| k8s.cgroup.queued_ops | read, write | operations |
97 +| k8s.cgroup.merged_ops | read, write | operations/s |
98 +| k8s.cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
99 +| k8s.cgroup.cpu_some_pressure_stall_time | time | ms |
100 +| k8s.cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
101 +| k8s.cgroup.cpu_full_pressure_stall_time | time | ms |
102 +| k8s.cgroup.memory_some_pressure | some10, some60, some300 | percentage |
103 +| k8s.cgroup.memory_some_pressure_stall_time | time | ms |
104 +| k8s.cgroup.memory_full_pressure | some10, some60, some300 | percentage |
105 +| k8s.cgroup.memory_full_pressure_stall_time | time | ms |
106 +| k8s.cgroup.io_some_pressure | some10, some60, some300 | percentage |
107 +| k8s.cgroup.io_some_pressure_stall_time | time | ms |
108 +| k8s.cgroup.io_full_pressure | some10, some60, some300 | percentage |
109 +| k8s.cgroup.io_full_pressure_stall_time | time | ms |
110 +| k8s.cgroup.pids_current | pids | pids |
111 +
112 +### Per k8s cgroup network device
113 +
114 +These metrics refer to the Pod container network interface.
115 +
116 +Labels:
117 +
118 +| Label | Description |
119 +|:-----------|:----------------|
120 +| device | The name of the host network interface linked to the container's network interface. |
121 +| container_device | Container network interface name. |
122 +| interface_type | Network interface type. Always "virtual" for the containers. |
123 +| k8s_node_name | Node name. The value of _pod.spec.nodeName_. |
124 +| k8s_namespace | Namespace name. The value of _pod.metadata.namespace_. |
125 +| k8s_controller_kind | Controller kind (ReplicaSet, DaemonSet, StatefulSet, Job, etc.). The value of _pod.OwnerReferences.Controller.Kind_. |
126 +| k8s_controller_name | Controller name.The value of _pod.OwnerReferences.Controller.Name_. |
127 +| k8s_pod_name | Pod name. The value of _pod.metadata.name_. |
128 +| k8s_container_name | Container name. The value of _pod.spec.containers.name_. |
129 +| k8s_kind | Instance kind: "pod" or "container". |
130 +| k8s_qos_class | QoS class (guaranteed, burstable, besteffort). |
131 +| k8s_cluster_id | Cluster ID. The value of kube-system namespace _namespace.metadata.uid_. |
132 +
133 +Metrics:
134 +
135 +| Metric | Dimensions | Unit |
136 +|:------|:----------|:----|
137 +| k8s.cgroup.net_net | received, sent | kilobits/s |
138 +| k8s.cgroup.net_packets | received, sent, multicast | pps |
139 +| k8s.cgroup.net_errors | inbound, outbound | errors/s |
140 +| k8s.cgroup.net_drops | inbound, outbound | errors/s |
141 +| k8s.cgroup.net_fifo | receive, transmit | errors/s |
142 +| k8s.cgroup.net_compressed | receive, sent | pps |
143 +| k8s.cgroup.net_events | frames, collisions, carrier | events/s |
144 +| k8s.cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
145 +| k8s.cgroup.net_carrier | up, down | state |
146 +| k8s.cgroup.net_mtu | mtu | octets |
147 +
148 +
149 +
150 +## Alerts
151 +
152 +
153 +The following alerts are available:
154 +
155 +| Alert name | On metric | Description |
156 +|:------------|:----------|:------------|
157 +| [ k8s_cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | k8s.cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
158 +| [ k8s_cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | k8s.cgroup.mem_usage | cgroup memory utilization |
159 +| [ k8s_cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | k8s.cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
160 +| [ k8s_cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | k8s.cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
161 +
162 +
163 +## Setup
164 +
165 +
166 +### Prerequisites
167 +
168 +No action required.
169 +
170 +### Configuration
171 +
172 +#### Options
173 +
174 +
175 +
176 +There are no configuration options.
177 +
178 +
179 +
180 +#### via File
181 +
182 +There is no configuration file.
183 +
184 +##### Examples
185 +There are no configuration examples.
186 +
187 +
src/collectors/cgroups.plugin/integrations/openstack_vms.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/openstack_vms.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "OpenStack VMs"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['openstack', 'openstack nova', 'openstack compute', 'kvm', 'qemu', 'libvirt', 'virtual machine', 'vm', 'cloud']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# OpenStack VMs
13 +
14 +
15 +<img src="https://netdata.cloud/img/openstack.svg" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor OpenStack Nova virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/ovirt_vms.md renamed
+5 -5
@@ -1,15 +1,15 @@
1 <!--startmeta
2 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/ovirt_containers.md"
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/ovirt_vms.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 -sidebar_label: "oVirt Containers"
4 +sidebar_label: "oVirt VMs"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Containers and VMs"
7 most_popular: True
8 -keywords: ['ovirt', 'container']
8 +keywords: ['ovirt', 'rhev', 'red hat virtualization', 'red hat enterprise virtualization', 'kvm', 'qemu', 'libvirt', 'virtual machine', 'vm']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
12 -# oVirt Containers
12 +# oVirt VMs
13
14
15 <img src="https://netdata.cloud/img/ovirt.svg" width="150"/>
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor oVirt for performance, resource usage, and health status.
25 +Monitor oVirt/RHEV virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/podman_containers.md renamed
+6 -6
@@ -1,18 +1,18 @@
1 <!--startmeta
2 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/libvirt_containers.md"
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/podman_containers.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 -sidebar_label: "Libvirt Containers"
4 +sidebar_label: "Podman Containers"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Containers and VMs"
7 most_popular: True
8 -keywords: ['libvirt', 'container']
8 +keywords: ['podman', 'containers', 'pods', 'oci', 'crun', 'runc']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
12 -# Libvirt Containers
12 +# Podman Containers
13
14
15 -<img src="https://netdata.cloud/img/libvirt.png" width="150"/>
15 +<img src="https://netdata.cloud/img/podman.svg" width="150"/>
16
17
18 Plugin: cgroups.plugin
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor Libvirt for performance, resource usage, and health status.
25 +Monitor Podman container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/proxmox_vms_and_containers.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/proxmox_vms_and_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "Proxmox VMs and Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['proxmox', 'proxmox ve', 'pve', 'kvm', 'qemu', 'lxc', 'libvirt', 'virtual machine', 'vm', 'container']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# Proxmox VMs and Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/proxmox.png" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor Proxmox VE virtual machine and container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/systemd-nspawn_containers.md new
+173
@@ -0,0 +1,173 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/integrations/systemd-nspawn_containers.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cgroups.plugin/metadata.yaml"
4 +sidebar_label: "systemd-nspawn Containers"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Containers and VMs"
7 +most_popular: True
8 +keywords: ['systemd-nspawn', 'nspawn', 'machinectl', 'systemd', 'containers']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# systemd-nspawn Containers
13 +
14 +
15 +<img src="https://netdata.cloud/img/systemd.svg" width="150"/>
16 +
17 +
18 +Plugin: cgroups.plugin
19 +Module: /sys/fs/cgroup
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitor systemd-nspawn container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26 +
27 +
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +This integration doesn't support auto-detection.
39 +
40 +#### Limits
41 +
42 +The default configuration for this integration does not impose any limits on data collection.
43 +
44 +#### Performance Impact
45 +
46 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
47 +
48 +## Metrics
49 +
50 +Metrics grouped by *scope*.
51 +
52 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
53 +
54 +
55 +
56 +### Per cgroup
57 +
58 +
59 +
60 +Labels:
61 +
62 +| Label | Description |
63 +|:-----------|:----------------|
64 +| container_name | The container name or group path if name resolution fails. |
65 +| image | Docker/Podman container image name. |
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| cgroup.cpu_limit | used | percentage |
72 +| cgroup.cpu | user, system | percentage |
73 +| cgroup.cpu_per_core | a dimension per core | percentage |
74 +| cgroup.throttled | throttled | percentage |
75 +| cgroup.throttled_duration | duration | ms |
76 +| cgroup.cpu_shares | shares | shares |
77 +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB |
78 +| cgroup.writeback | dirty, writeback | MiB |
79 +| cgroup.mem_activity | in, out | MiB/s |
80 +| cgroup.pgfaults | pgfault, swap | MiB/s |
81 +| cgroup.mem_usage | ram, swap | MiB |
82 +| cgroup.mem_usage_limit | available, used | MiB |
83 +| cgroup.mem_utilization | utilization | percentage |
84 +| cgroup.mem_failcnt | failures | count |
85 +| cgroup.io | read, write | KiB/s |
86 +| cgroup.serviced_ops | read, write | operations/s |
87 +| cgroup.throttle_io | read, write | KiB/s |
88 +| cgroup.throttle_serviced_ops | read, write | operations/s |
89 +| cgroup.queued_ops | read, write | operations |
90 +| cgroup.merged_ops | read, write | operations/s |
91 +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage |
92 +| cgroup.cpu_some_pressure_stall_time | time | ms |
93 +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage |
94 +| cgroup.cpu_full_pressure_stall_time | time | ms |
95 +| cgroup.memory_some_pressure | some10, some60, some300 | percentage |
96 +| cgroup.memory_some_pressure_stall_time | time | ms |
97 +| cgroup.memory_full_pressure | some10, some60, some300 | percentage |
98 +| cgroup.memory_full_pressure_stall_time | time | ms |
99 +| cgroup.io_some_pressure | some10, some60, some300 | percentage |
100 +| cgroup.io_some_pressure_stall_time | time | ms |
101 +| cgroup.io_full_pressure | some10, some60, some300 | percentage |
102 +| cgroup.io_full_pressure_stall_time | time | ms |
103 +| cgroup.pids_current | pids | pids |
104 +
105 +### Per cgroup network device
106 +
107 +
108 +
109 +Labels:
110 +
111 +| Label | Description |
112 +|:-----------|:----------------|
113 +| container_name | The container name or group path if name resolution fails. |
114 +| image | Docker/Podman container image name. |
115 +| device | The name of the host network interface linked to the container's network interface. |
116 +| container_device | Container network interface name. |
117 +| interface_type | Network interface type. Always "virtual" for the containers. |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| cgroup.net_net | received, sent | kilobits/s |
124 +| cgroup.net_packets | received, sent, multicast | pps |
125 +| cgroup.net_errors | inbound, outbound | errors/s |
126 +| cgroup.net_drops | inbound, outbound | errors/s |
127 +| cgroup.net_fifo | receive, transmit | errors/s |
128 +| cgroup.net_compressed | receive, sent | pps |
129 +| cgroup.net_events | frames, collisions, carrier | events/s |
130 +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state |
131 +| cgroup.net_carrier | up, down | state |
132 +| cgroup.net_mtu | mtu | octets |
133 +
134 +
135 +
136 +## Alerts
137 +
138 +
139 +The following alerts are available:
140 +
141 +| Alert name | On metric | Description |
142 +|:------------|:----------|:------------|
143 +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes |
144 +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization |
145 +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute |
146 +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute |
147 +
148 +
149 +## Setup
150 +
151 +
152 +### Prerequisites
153 +
154 +No action required.
155 +
156 +### Configuration
157 +
158 +#### Options
159 +
160 +
161 +
162 +There are no configuration options.
163 +
164 +
165 +
166 +#### via File
167 +
168 +There is no configuration file.
169 +
170 +##### Examples
171 +There are no configuration examples.
172 +
173 +
src/collectors/cgroups.plugin/integrations/systemd_services.md
+2 -2
@@ -5,7 +5,7 @@ sidebar_label: "Systemd Services"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Systemd"
7 most_popular: True
8 -keywords: ['containers', 'docker']
8 +keywords: ['systemd', 'services', 'units', 'daemons', 'systemctl', 'cgroups']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor Containers for performance, resource usage, and health status.
25 +Monitor containers and virtual machines resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28
src/collectors/cgroups.plugin/integrations/virtual_machines.md
+2 -2
@@ -5,7 +5,7 @@ sidebar_label: "Virtual Machines"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Containers and VMs"
7 most_popular: True
8 -keywords: ['vms', 'virtualization', 'container']
8 +keywords: ['vms', 'virtual machines', 'virtualization', 'hypervisor', 'kvm', 'qemu', 'libvirt', 'proxmox', 'proxmox ve', 'ovirt', 'openstack', 'openstack nova', 'cgroups']
9 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 endmeta-->
11
@@ -22,7 +22,7 @@ Module: /sys/fs/cgroup
22
23 ## Overview
24
25 -Monitor Virtual Machines for performance, resource usage, and health status.
25 +Monitor virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups.
26
27
28