| 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/Collectors/Containers and VMs" |
| 7 | keywords: ['openshift', 'red hat openshift', 'okd', 'kubernetes', 'k8s', 'containers', 'pods'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # OpenShift Containers |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/openshift.png" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: cgroups.plugin |
| 18 | Module: /sys/fs/cgroup |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | Monitor Red Hat OpenShift container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
| 25 | |
| 26 | |
| 27 | |
| 28 | This collector is only supported on the following platforms: |
| 29 | |
| 30 | - Linux |
| 31 | |
| 32 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 33 | |
| 34 | |
| 35 | ### Default Behavior |
| 36 | |
| 37 | #### Auto-Detection |
| 38 | |
| 39 | This integration doesn't support auto-detection. |
| 40 | |
| 41 | #### Limits |
| 42 | |
| 43 | The default configuration for this integration does not impose any limits on data collection. |
| 44 | |
| 45 | #### Performance Impact |
| 46 | |
| 47 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 48 | |
| 49 | ## Setup |
| 50 | |
| 51 | |
| 52 | ### Prerequisites |
| 53 | |
| 54 | No action required. |
| 55 | |
| 56 | ### Configuration |
| 57 | |
| 58 | #### Options |
| 59 | |
| 60 | |
| 61 | |
| 62 | There are no configuration options. |
| 63 | |
| 64 | |
| 65 | |
| 66 | #### via File |
| 67 | |
| 68 | There is no configuration file. |
| 69 | |
| 70 | ##### Examples |
| 71 | There are no configuration examples. |
| 72 | |
| 73 | |
| 74 | |
| 75 | ## Alerts |
| 76 | |
| 77 | |
| 78 | The following alerts are available: |
| 79 | |
| 80 | | Alert name | On metric | Description | |
| 81 | |:------------|:----------|:------------| |
| 82 | | [ 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 | |
| 83 | | [ 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 | |
| 84 | | [ 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 | |
| 85 | | [ 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 | |
| 86 | |
| 87 | |
| 88 | ## Metrics |
| 89 | |
| 90 | Metrics grouped by *scope*. |
| 91 | |
| 92 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 93 | |
| 94 | |
| 95 | |
| 96 | ### Per k8s cgroup |
| 97 | |
| 98 | These metrics refer to the Pod container. |
| 99 | |
| 100 | Labels: |
| 101 | |
| 102 | | Label | Description | |
| 103 | |:-----------|:----------------| |
| 104 | | k8s_node_name | Node name. The value of _pod.spec.nodeName_. | |
| 105 | | k8s_namespace | Namespace name. The value of _pod.metadata.namespace_. | |
| 106 | | k8s_controller_kind | Controller kind (ReplicaSet, DaemonSet, StatefulSet, Job, etc.). The value of _pod.OwnerReferences.Controller.Kind_. | |
| 107 | | k8s_controller_name | Controller name.The value of _pod.OwnerReferences.Controller.Name_. | |
| 108 | | k8s_pod_name | Pod name. The value of _pod.metadata.name_. | |
| 109 | | k8s_container_name | Container name. The value of _pod.spec.containers.name_. | |
| 110 | | k8s_kind | Instance kind: "pod" or "container". | |
| 111 | | k8s_qos_class | QoS class (guaranteed, burstable, besteffort). | |
| 112 | | k8s_cluster_id | Cluster ID. The value of kube-system namespace _namespace.metadata.uid_. | |
| 113 | |
| 114 | Metrics: |
| 115 | |
| 116 | | Metric | Dimensions | Unit | |
| 117 | |:------|:----------|:----| |
| 118 | | k8s.cgroup.cpu_limit | used | percentage | |
| 119 | | k8s.cgroup.cpu | user, system | percentage | |
| 120 | | k8s.cgroup.cpu_per_core | a dimension per core | percentage | |
| 121 | | k8s.cgroup.throttled | throttled | percentage | |
| 122 | | k8s.cgroup.throttled_duration | duration | ms | |
| 123 | | k8s.cgroup.cpu_shares | shares | shares | |
| 124 | | k8s.cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB | |
| 125 | | k8s.cgroup.writeback | dirty, writeback | MiB | |
| 126 | | k8s.cgroup.mem_activity | in, out | MiB/s | |
| 127 | | k8s.cgroup.pgfaults | pgfault, swap | MiB/s | |
| 128 | | k8s.cgroup.mem_usage | ram, swap | MiB | |
| 129 | | k8s.cgroup.mem_usage_limit | available, used | MiB | |
| 130 | | k8s.cgroup.mem_utilization | utilization | percentage | |
| 131 | | k8s.cgroup.mem_failcnt | failures | count | |
| 132 | | k8s.cgroup.io | read, write | KiB/s | |
| 133 | | k8s.cgroup.serviced_ops | read, write | operations/s | |
| 134 | | k8s.cgroup.throttle_io | read, write | KiB/s | |
| 135 | | k8s.cgroup.throttle_serviced_ops | read, write | operations/s | |
| 136 | | k8s.cgroup.queued_ops | read, write | operations | |
| 137 | | k8s.cgroup.merged_ops | read, write | operations/s | |
| 138 | | k8s.cgroup.cpu_some_pressure | some10, some60, some300 | percentage | |
| 139 | | k8s.cgroup.cpu_some_pressure_stall_time | time | ms | |
| 140 | | k8s.cgroup.cpu_full_pressure | some10, some60, some300 | percentage | |
| 141 | | k8s.cgroup.cpu_full_pressure_stall_time | time | ms | |
| 142 | | k8s.cgroup.memory_some_pressure | some10, some60, some300 | percentage | |
| 143 | | k8s.cgroup.memory_some_pressure_stall_time | time | ms | |
| 144 | | k8s.cgroup.memory_full_pressure | some10, some60, some300 | percentage | |
| 145 | | k8s.cgroup.memory_full_pressure_stall_time | time | ms | |
| 146 | | k8s.cgroup.io_some_pressure | some10, some60, some300 | percentage | |
| 147 | | k8s.cgroup.io_some_pressure_stall_time | time | ms | |
| 148 | | k8s.cgroup.io_full_pressure | some10, some60, some300 | percentage | |
| 149 | | k8s.cgroup.io_full_pressure_stall_time | time | ms | |
| 150 | | k8s.cgroup.pids_current | pids | pids | |
| 151 | |
| 152 | ### Per k8s cgroup network device |
| 153 | |
| 154 | These metrics refer to the Pod container network interface. |
| 155 | |
| 156 | Labels: |
| 157 | |
| 158 | | Label | Description | |
| 159 | |:-----------|:----------------| |
| 160 | | device | The name of the host network interface linked to the container's network interface. | |
| 161 | | container_device | Container network interface name. | |
| 162 | | interface_type | Network interface type. Always "virtual" for the containers. | |
| 163 | | k8s_node_name | Node name. The value of _pod.spec.nodeName_. | |
| 164 | | k8s_namespace | Namespace name. The value of _pod.metadata.namespace_. | |
| 165 | | k8s_controller_kind | Controller kind (ReplicaSet, DaemonSet, StatefulSet, Job, etc.). The value of _pod.OwnerReferences.Controller.Kind_. | |
| 166 | | k8s_controller_name | Controller name.The value of _pod.OwnerReferences.Controller.Name_. | |
| 167 | | k8s_pod_name | Pod name. The value of _pod.metadata.name_. | |
| 168 | | k8s_container_name | Container name. The value of _pod.spec.containers.name_. | |
| 169 | | k8s_kind | Instance kind: "pod" or "container". | |
| 170 | | k8s_qos_class | QoS class (guaranteed, burstable, besteffort). | |
| 171 | | k8s_cluster_id | Cluster ID. The value of kube-system namespace _namespace.metadata.uid_. | |
| 172 | |
| 173 | Metrics: |
| 174 | |
| 175 | | Metric | Dimensions | Unit | |
| 176 | |:------|:----------|:----| |
| 177 | | k8s.cgroup.net_net | received, sent | kilobits/s | |
| 178 | | k8s.cgroup.net_packets | received, sent, multicast | pps | |
| 179 | | k8s.cgroup.net_errors | inbound, outbound | errors/s | |
| 180 | | k8s.cgroup.net_drops | inbound, outbound | errors/s | |
| 181 | | k8s.cgroup.net_fifo | receive, transmit | errors/s | |
| 182 | | k8s.cgroup.net_compressed | receive, sent | pps | |
| 183 | | k8s.cgroup.net_events | frames, collisions, carrier | events/s | |
| 184 | | k8s.cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state | |
| 185 | | k8s.cgroup.net_carrier | up, down | state | |
| 186 | | k8s.cgroup.net_mtu | mtu | octets | |
| 187 | |
| 188 |