Skip to content

Commit fda2a62

Browse files
committed
Add missing option names for metrics to Prometheus doc
1 parent 3ec977e commit fda2a62

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

docs/storage/prometheus.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
2222
`container_accelerator_memory_total_bytes` | Gauge | Total accelerator memory | bytes | accelerator |
2323
`container_accelerator_memory_used_bytes` | Gauge | Total accelerator memory allocated | bytes | accelerator |
2424
`container_blkio_device_usage_total` | Counter | Blkio device bytes usage | bytes | diskIO |
25-
`container_cpu_cfs_periods_total` | Counter | Number of elapsed enforcement period intervals | | |
26-
`container_cpu_cfs_throttled_periods_total` | Counter | Number of throttled period intervals | | |
27-
`container_cpu_cfs_throttled_seconds_total` | Counter | Total time duration the container has been throttled | seconds | |
28-
`container_cpu_load_average_10s` | Gauge | Value of container cpu load average over the last 10 seconds | | |
25+
`container_cpu_cfs_periods_total` | Counter | Number of elapsed enforcement period intervals | | cpu |
26+
`container_cpu_cfs_throttled_periods_total` | Counter | Number of throttled period intervals | | cpu |
27+
`container_cpu_cfs_throttled_seconds_total` | Counter | Total time duration the container has been throttled | seconds | cpu |
28+
`container_cpu_load_average_10s` | Gauge | Value of container cpu load average over the last 10 seconds | | cpuLoad |
2929
`container_cpu_schedstat_run_periods_total` | Counter | Number of times processes of the cgroup have run on the cpu | | sched |
3030
`container_cpu_schedstat_runqueue_seconds_total` | Counter | Time duration processes of the container have been waiting on a runqueue | seconds | sched |
3131
`container_cpu_schedstat_run_seconds_total` | Counter | Time duration the processes of the container have run on the CPU | seconds | sched |
32-
`container_cpu_system_seconds_total` | Counter | Cumulative system cpu time consumed | seconds | |
33-
`container_cpu_usage_seconds_total` | Counter | Cumulative cpu time consumed | seconds | |
34-
`container_cpu_user_seconds_total` | Counter | Cumulative user cpu time consumed | seconds | |
32+
`container_cpu_system_seconds_total` | Counter | Cumulative system cpu time consumed | seconds | cpu |
33+
`container_cpu_usage_seconds_total` | Counter | Cumulative cpu time consumed | seconds | cpu |
34+
`container_cpu_user_seconds_total` | Counter | Cumulative user cpu time consumed | seconds | cpu |
3535
`container_file_descriptors` | Gauge | Number of open file descriptors for the container | | process |
3636
`container_fs_inodes_free` | Gauge | Number of available Inodes | | disk |
3737
`container_fs_inodes_total` | Gauge | Total number of Inodes | | disk |
@@ -53,21 +53,21 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
5353
`container_hugetlb_failcnt` | Counter | Number of hugepage usage hits limits | | hugetlb |
5454
`container_hugetlb_max_usage_bytes` | Gauge | Maximum hugepage usages recorded | bytes | hugetlb |
5555
`container_hugetlb_usage_bytes` | Gauge | Current hugepage usage | bytes | hugetlb |
56-
`container_last_seen` | Gauge | Last time a container was seen by the exporter | timestamp | |
56+
`container_last_seen` | Gauge | Last time a container was seen by the exporter | timestamp | - |
5757
`container_llc_occupancy_bytes` | Gauge | Last level cache usage statistics for container counted with RDT Memory Bandwidth Monitoring (MBM). | bytes | resctrl |
5858
`container_memory_bandwidth_bytes` | Gauge | Total memory bandwidth usage statistics for container counted with RDT Memory Bandwidth Monitoring (MBM). | bytes | resctrl |
5959
`container_memory_bandwidth_local_bytes` | Gauge | Local memory bandwidth usage statistics for container counted with RDT Memory Bandwidth Monitoring (MBM). | bytes | resctrl |
60-
`container_memory_cache` | Gauge | Total page cache memory | bytes | |
61-
`container_memory_failcnt` | Counter | Number of memory usage hits limits | | |
62-
`container_memory_failures_total` | Counter | Cumulative count of memory allocation failures | | |
63-
`container_memory_mapped_file` | Gauge | Size of memory mapped files | bytes | |
64-
`container_memory_max_usage_bytes` | Gauge | Maximum memory usage recorded | bytes | |
60+
`container_memory_cache` | Gauge | Total page cache memory | bytes | memory |
61+
`container_memory_failcnt` | Counter | Number of memory usage hits limits | | memory |
62+
`container_memory_failures_total` | Counter | Cumulative count of memory allocation failures | | memory |
63+
`container_memory_mapped_file` | Gauge | Size of memory mapped files | bytes | memory |
64+
`container_memory_max_usage_bytes` | Gauge | Maximum memory usage recorded | bytes | memory |
6565
`container_memory_migrate` | Gauge | Memory migrate status | | cpuset |
6666
`container_memory_numa_pages` | Gauge | Number of used pages per NUMA node | | memory_numa |
67-
`container_memory_rss` | Gauge | Size of RSS | bytes | |
68-
`container_memory_swap` | Gauge | Container swap usage | bytes | |
69-
`container_memory_usage_bytes` | Gauge | Current memory usage, including all memory regardless of when it was accessed | bytes | |
70-
`container_memory_working_set_bytes` | Gauge | Current working set | bytes | |
67+
`container_memory_rss` | Gauge | Size of RSS | bytes | memory |
68+
`container_memory_swap` | Gauge | Container swap usage | bytes | memory |
69+
`container_memory_usage_bytes` | Gauge | Current memory usage, including all memory regardless of when it was accessed | bytes | memory |
70+
`container_memory_working_set_bytes` | Gauge | Current working set | bytes | memory |
7171
`container_network_advance_tcp_stats_total` | Gauge | advanced tcp connections statistic for container | | advtcp |
7272
`container_network_receive_bytes_total` | Counter | Cumulative count of bytes received | bytes | network |
7373
`container_network_receive_errors_total` | Counter | Cumulative count of errors encountered while receiving | | network |
@@ -82,21 +82,21 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
8282
`container_network_udp6_usage_total` | Gauge | udp6 connection usage statistic for container | | udp |
8383
`container_network_udp_usage_total` | Gauge | udp connection usage statistic for container | | udp |
8484
`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
86-
`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
87-
`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
88-
`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
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). | | perf_event | libpfm
86+
`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). | | perf_event | libpfm
87+
`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="/"). | | perf_event | libpfm
88+
`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="/").| | perf_event | libpfm
8989
`container_processes` | Gauge | Number of processes running inside the container | | process |
9090
`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 |
9191
`container_sockets` | Gauge | Number of open sockets for the container | | process |
92-
`container_spec_cpu_period` | Gauge | CPU period of the container | | |
93-
`container_spec_cpu_quota` | Gauge | CPU quota of the container | | |
94-
`container_spec_cpu_shares` | Gauge | CPU share of the container | | |
95-
`container_spec_memory_limit_bytes` | Gauge | Memory limit for the container | bytes | |
92+
`container_spec_cpu_period` | Gauge | CPU period of the container | | - |
93+
`container_spec_cpu_quota` | Gauge | CPU quota of the container | | - |
94+
`container_spec_cpu_shares` | Gauge | CPU share of the container | | - |
95+
`container_spec_memory_limit_bytes` | Gauge | Memory limit for the container | bytes | - |
9696
`container_spec_memory_reservation_limit_bytes` | Gauge | Memory reservation limit for the container | bytes | |
9797
`container_spec_memory_swap_limit_bytes` | Gauge | Memory swap limit for the container | bytes | |
9898
`container_start_time_seconds` | Gauge | Start time of the container since unix epoch | seconds | |
99-
`container_tasks_state` | Gauge | Number of tasks in given state (`sleeping`, `running`, `stopped`, `uninterruptible`, or `ioawaiting`) | | |
99+
`container_tasks_state` | Gauge | Number of tasks in given state (`sleeping`, `running`, `stopped`, `uninterruptible`, or `ioawaiting`) | | cpuLoad |
100100
`container_threads` | Gauge | Number of threads running inside the container | | process |
101101
`container_threads_max` | Gauge | Maximum number of threads allowed inside the container | | process |
102102
`container_ulimits_soft` | Gauge | Soft ulimit values for the container root process. Unlimited if -1, except priority and nice | | process |

0 commit comments

Comments
 (0)