Skip to content

Commit 3ec977e

Browse files
committed
Add missing descriptions of Prometheus container metrics
Including correcting "container_perf_metric_scaling_ratio" to "container_perf_events_scaling_ratio".
1 parent 1fa5899 commit 3ec977e

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/storage/prometheus.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
6868
`container_memory_swap` | Gauge | Container swap usage | bytes | |
6969
`container_memory_usage_bytes` | Gauge | Current memory usage, including all memory regardless of when it was accessed | bytes | |
7070
`container_memory_working_set_bytes` | Gauge | Current working set | bytes | |
71+
`container_network_advance_tcp_stats_total` | Gauge | advanced tcp connections statistic for container | | advtcp |
7172
`container_network_receive_bytes_total` | Counter | Cumulative count of bytes received | bytes | network |
7273
`container_network_receive_errors_total` | Counter | Cumulative count of errors encountered while receiving | | network |
7374
`container_network_receive_packets_dropped_total` | Counter | Cumulative count of packets dropped while receiving | | network |
@@ -80,12 +81,14 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
8081
`container_network_transmit_packets_total` | Counter | Cumulative count of packets transmitted | | network |
8182
`container_network_udp6_usage_total` | Gauge | udp6 connection usage statistic for container | | udp |
8283
`container_network_udp_usage_total` | Gauge | udp connection usage statistic for container | | udp |
84+
`container_oom_events_total` | Counter | Count of out of memory events observed for the container | | oom_event |
85+
`container_perf_events_scaling_ratio` | Gauge | Scaling ratio for perf event counter (event can be identified by `event` label and `cpu` indicates the core for which event was measured). See [perf event configuration](../runtime_options.md#perf-events). | | | libpfm
8386
`container_perf_events_total` | Counter | Scaled counter of perf core event (event can be identified by `event` label and `cpu` indicates the core for which event was measured). See [perf event configuration](../runtime_options.md#perf-events). | | | libpfm
84-
`container_perf_metric_scaling_ratio` | Gauge | Scaling ratio for perf event counter (event can be identified by `event` label and `cpu` indicates the core for which event was measured). See [perf event configuration](../runtime_options.md#perf-events). | | | libpfm
8587
`container_perf_uncore_events_scaling_ratio` | Gauge | Scaling ratio for perf uncore event counter (event can be identified by `event` label, `pmu` and `socket` lables indicate the PMU and the CPU socket for which event was measured). See [perf event configuration](../runtime_options.md#perf-events). Metric exists only for main cgroup (id="/"). | | | libpfm
8688
`container_perf_uncore_events_total` | Counter | Scaled counter of perf uncore event (event can be identified by `event` label, `pmu` and `socket` lables indicate the PMU and the CPU socket for which event was measured). See [perf event configuration](../runtime_options.md#perf-events)). Metric exists only for main cgroup (id="/").| | | libpfm
8789
`container_processes` | Gauge | Number of processes running inside the container | | process |
8890
`container_referenced_bytes` | Gauge | Container referenced bytes during last measurements cycle based on Referenced field in /proc/smaps file, with /proc/PIDs/clear_refs set to 1 after defined number of cycles configured through `referenced_reset_interval` cAdvisor parameter.</br>Warning: this is intrusive collection because can influence kernel page reclaim policy and add latency. Refer to https://github.com/brendangregg/wss#wsspl-referenced-page-flag for more details. | bytes | referenced_memory |
91+
`container_sockets` | Gauge | Number of open sockets for the container | | process |
8992
`container_spec_cpu_period` | Gauge | CPU period of the container | | |
9093
`container_spec_cpu_quota` | Gauge | CPU quota of the container | | |
9194
`container_spec_cpu_shares` | Gauge | CPU share of the container | | |
@@ -94,6 +97,9 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
9497
`container_spec_memory_swap_limit_bytes` | Gauge | Memory swap limit for the container | bytes | |
9598
`container_start_time_seconds` | Gauge | Start time of the container since unix epoch | seconds | |
9699
`container_tasks_state` | Gauge | Number of tasks in given state (`sleeping`, `running`, `stopped`, `uninterruptible`, or `ioawaiting`) | | |
100+
`container_threads` | Gauge | Number of threads running inside the container | | process |
101+
`container_threads_max` | Gauge | Maximum number of threads allowed inside the container | | process |
102+
`container_ulimits_soft` | Gauge | Soft ulimit values for the container root process. Unlimited if -1, except priority and nice | | process |
97103

98104
## Prometheus hardware metrics
99105

0 commit comments

Comments
 (0)