From fcc25f7d30f3f385ec245949f8a3378de50e3b19 Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Tue, 8 Feb 2022 13:46:44 +0100 Subject: [PATCH] Add collector documentation --- collectors/cpufreqCpuinfoMetric.md | 10 ++++++++++ collectors/cpufreqMetric.md | 11 +++++++++++ collectors/numastatsMetric.md | 15 +++++++++++++++ 3 files changed, 36 insertions(+) create mode 100644 collectors/cpufreqCpuinfoMetric.md create mode 100644 collectors/cpufreqMetric.md create mode 100644 collectors/numastatsMetric.md diff --git a/collectors/cpufreqCpuinfoMetric.md b/collectors/cpufreqCpuinfoMetric.md new file mode 100644 index 0000000..8b0216f --- /dev/null +++ b/collectors/cpufreqCpuinfoMetric.md @@ -0,0 +1,10 @@ + +## `cpufreq_cpuinfo` collector +```json + "cpufreq_cpuinfo": {} +``` + +The `cpufreq_cpuinfo` collector reads the clock frequency from `/proc/cpuinfo` and outputs a handful **cpu** metrics. + +Metrics: +* `cpufreq` diff --git a/collectors/cpufreqMetric.md b/collectors/cpufreqMetric.md new file mode 100644 index 0000000..b62d16e --- /dev/null +++ b/collectors/cpufreqMetric.md @@ -0,0 +1,11 @@ +## `cpufreq_cpuinfo` collector +```json + "cpufreq": { + "exclude_metrics": [] + } +``` + +The `cpufreq` collector reads the clock frequency from `/sys/devices/system/cpu/cpu*/cpufreq` and outputs a handful **cpu** metrics. + +Metrics: +* `cpufreq` \ No newline at end of file diff --git a/collectors/numastatsMetric.md b/collectors/numastatsMetric.md new file mode 100644 index 0000000..8eb1a0c --- /dev/null +++ b/collectors/numastatsMetric.md @@ -0,0 +1,15 @@ + +## `numastat` collector +```json + "numastat": {} +``` + +The `numastat` collector reads data from `/sys/devices/system/node/node*/numastat` and outputs a handful **memoryDomain** metrics. See: https://www.kernel.org/doc/html/latest/admin-guide/numastat.html + +Metrics: +* `numastats_numa_hit`: A process wanted to allocate memory from this node, and succeeded. +* `numastats_numa_miss`: A process wanted to allocate memory from another node, but ended up with memory from this node. +* `numastats_numa_foreign`: A process wanted to allocate on this node, but ended up with memory from another node. +* `numastats_local_node`: A process ran on this node's CPU, and got memory from this node. +* `numastats_other_node`: A process ran on a different node's CPU, and got memory from this node. +* `numastats_interleave_hit`: Interleaving wanted to allocate from this node and succeeded. \ No newline at end of file