From e66d52bb32f792c92d56b894415c741cc9e78a6c Mon Sep 17 00:00:00 2001
From: Holger Obermaier <40787752+ho-ob@users.noreply.github.com>
Date: Wed, 16 Nov 2022 14:10:25 +0100
Subject: [PATCH] * Corrected json config in numastatsMetric.md * Added some
 debug output to numastatsMetric.go

---
 collectors/numastatsMetric.go | 39 ++++++++++++++++++++++-------------
 collectors/numastatsMetric.md |  8 ++++---
 2 files changed, 30 insertions(+), 17 deletions(-)

diff --git a/collectors/numastatsMetric.go b/collectors/numastatsMetric.go
index 8eaac67..f79b45b 100644
--- a/collectors/numastatsMetric.go
+++ b/collectors/numastatsMetric.go
@@ -14,29 +14,38 @@ import (
 	lp "github.com/ClusterCockpit/cc-metric-collector/pkg/ccMetric"
 )
 
-//
-// Numa policy hit/miss statistics
+// Non-Uniform Memory Access (NUMA) policy hit/miss statistics
 //
 // numa_hit:
-//   A process wanted to allocate memory from this node, and succeeded.
+//
+//	A process wanted to allocate memory from this node, and succeeded.
+//
 // numa_miss:
-//   A process wanted to allocate memory from another node,
-//   but ended up with memory from this node.
+//
+//	A process wanted to allocate memory from another node,
+//	but ended up with memory from this node.
+//
 // numa_foreign:
-//   A process wanted to allocate on this node,
-//   but ended up with memory from another node.
+//
+//	A process wanted to allocate on this node,
+//	but ended up with memory from another node.
+//
 // local_node:
-//   A process ran on this node's CPU,
-//   and got memory from this node.
+//
+//	A process ran on this node's CPU,
+//	and got memory from this node.
+//
 // other_node:
-//   A process ran on a different node's CPU
-//   and got memory from this node.
+//
+//	A process ran on a different node's CPU
+//	and got memory from this node.
+//
 // interleave_hit:
-//   Interleaving wanted to allocate from this node
-//   and succeeded.
+//
+//	Interleaving wanted to allocate from this node
+//	and succeeded.
 //
 // See: https://www.kernel.org/doc/html/latest/admin-guide/numastat.html
-//
 type NUMAStatsCollectorTopolgy struct {
 	file   string
 	tagSet map[string]string
@@ -82,6 +91,8 @@ func (m *NUMAStatsCollector) Init(config json.RawMessage) error {
 			})
 	}
 
+	// Initialized
+	cclog.ComponentDebug(m.name, "initialized", len(m.topology), "NUMA domains")
 	m.init = true
 	return nil
 }
diff --git a/collectors/numastatsMetric.md b/collectors/numastatsMetric.md
index 8eb1a0c..cb9ab2f 100644
--- a/collectors/numastatsMetric.md
+++ b/collectors/numastatsMetric.md
@@ -1,15 +1,17 @@
 
 ## `numastat` collector
+
 ```json
-  "numastat": {}
+  "numastats": {}
 ```
 
-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
+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
+* `numastats_interleave_hit`: Interleaving wanted to allocate from this node and succeeded.