From 3c011babcd79eb18b386989a11c1cbff660f4515 Mon Sep 17 00:00:00 2001
From: papertager <2567587994@qq.com>
Date: Tue, 9 Jun 2026 11:18:42 +0800
Subject: [PATCH] Add counter CSV lint tool

---
 README.md              |  6 ++++
 tools/lint_counters.py | 64 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+)
 create mode 100644 tools/lint_counters.py

diff --git a/README.md b/README.md
index 1fd9a54..c9aa66d 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,12 @@ if you want to use self defined counter configuration file on host, here's an ex
 $ sudo docker run -d --name=mx-exporter --device=/dev/dri -p 0.0.0.0:<host port>:<http port> -v <new config file>:/work/counters.csv <image name> -c /work/counters.csv
 ```
 
+Validate the counter CSV before starting the exporter:
+
+```
+$ python3 tools/lint_counters.py mx_exporter/default-counters.csv
+```
+
 ## Run as python application
 
 ```
diff --git a/tools/lint_counters.py b/tools/lint_counters.py
new file mode 100644
index 0000000..4424ad1
--- /dev/null
+++ b/tools/lint_counters.py
@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+"""Lint mx-exporter counter CSV files."""
+
+from __future__ import annotations
+
+import argparse
+import csv
+import sys
+from pathlib import Path
+
+
+VALID_TYPES = {"Gauge", "Counter", "Summary", "Histogram", "Info"}
+
+
+def lint_counter_file(path: Path) -> list[str]:
+    errors: list[str] = []
+    seen_ids: set[str] = set()
+
+    with path.open(newline="", encoding="utf-8") as handle:
+        for line_no, row in enumerate(csv.reader(handle), start=1):
+            if not row or not "".join(row).strip() or row[0].lstrip().startswith("#"):
+                continue
+            if len(row) < 4:
+                errors.append(f"{line_no}: expected at least 4 columns, got {len(row)}")
+                continue
+
+            metric_id = row[0].strip()
+            metric_type = row[1].strip()
+            metric_name = row[2].strip()
+            if metric_id in seen_ids:
+                errors.append(f"{line_no}: duplicate metric id {metric_id!r}")
+            seen_ids.add(metric_id)
+
+            if metric_type not in VALID_TYPES:
+                errors.append(f"{line_no}: invalid metric type {metric_type!r}")
+            if not metric_name:
+                errors.append(f"{line_no}: empty prometheus metric name")
+
+    return errors
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description="Lint mx-exporter counter CSV files.")
+    parser.add_argument(
+        "path",
+        nargs="?",
+        type=Path,
+        default=Path(__file__).resolve().parents[1] / "mx_exporter" / "default-counters.csv",
+    )
+    args = parser.parse_args()
+
+    errors = lint_counter_file(args.path)
+    if errors:
+        print(f"Counter lint failed for {args.path}:", file=sys.stderr)
+        for error in errors:
+            print(f"  {error}", file=sys.stderr)
+        return 1
+
+    print(f"Counter lint passed for {args.path}")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())