From 6360a4f062a2fab31dfc9940775e32e88224c88f Mon Sep 17 00:00:00 2001
From: Daniel Langbein <daniel@systemli.org>
Date: Mon, 20 Nov 2023 14:15:53 +0100
Subject: [PATCH] removed bundled config files

---
 .run/main (export).run.xml                    |  2 +-
 README.md                                     | 10 ++-
 .../monitor/data/yodaTux.ini => example.ini   |  5 ++
 setup.cfg                                     |  2 +-
 src/de/p1st/monitor/cfg/singleton.py          | 10 +--
 src/de/p1st/monitor/data/yodaHedgehog.ini     | 38 ----------
 src/de/p1st/monitor/data/yodaNas.ini          | 70 -------------------
 7 files changed, 20 insertions(+), 117 deletions(-)
 rename src/de/p1st/monitor/data/yodaTux.ini => example.ini (91%)
 delete mode 100644 src/de/p1st/monitor/data/yodaHedgehog.ini
 delete mode 100644 src/de/p1st/monitor/data/yodaNas.ini

diff --git a/.run/main (export).run.xml b/.run/main (export).run.xml
index a8c75ac..65fd2d1 100644
--- a/.run/main (export).run.xml	
+++ b/.run/main (export).run.xml	
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/src/de/p1st/monitor/main.py" />
-    <option name="PARAMETERS" value="-c $PROJECT_DIR$/src/de/p1st/monitor/data/yodaTux.ini --export" />
+    <option name="PARAMETERS" value="-c $PROJECT_DIR$/example.ini --export" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
     <option name="MODULE_MODE" value="false" />
diff --git a/README.md b/README.md
index fede2bd..a2f18d5 100644
--- a/README.md
+++ b/README.md
@@ -23,12 +23,18 @@ Lines of code including docstrings and comments:
 
 ```shell
 find ./src -name '*.py' | xargs wc -l
-#=> 1625 total
+#=> 1938 total
 ```
 
 ## Configuration
 
-See [yodaTux.ini](src/de/p1st/monitor/data/yodaTux.ini) for a configuration file covering all config options.
+The configuration is selected in the following order:
+- Given as CLI argument
+- Located at `/etc/de-p1st-monitor/${hostname}.ini`
+
+See [example.ini](example.ini) for a configuration file covering all config options.
+
+More examples can be found at https://codeberg.org/privacy1st/nix-git/src/branch/main/assets/de-p1st-monitor.
 
 ## Installation
 
diff --git a/src/de/p1st/monitor/data/yodaTux.ini b/example.ini
similarity index 91%
rename from src/de/p1st/monitor/data/yodaTux.ini
rename to example.ini
index d7cc841..8c9f1dc 100644
--- a/src/de/p1st/monitor/data/yodaTux.ini
+++ b/example.ini
@@ -5,6 +5,10 @@ dir = /var/log/de-p1st-monitor/
 
 [temp.1]
 ; `sensor` and `label` are used to identify one temperature value.
+; You find these values by running:
+;   $ python3
+;   $ import psutil
+;   $ psutil.sensors_temperatures(fahrenheit=False)
 sensor = k10temp
 label = Tctl
 
@@ -25,6 +29,7 @@ warn_data_range = 4
 
 
 [network.1]
+; You can list your network interfaces with `ip link show`.
 network_interface = wlan0
 
 
diff --git a/setup.cfg b/setup.cfg
index 5b0bd98..6291309 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -3,7 +3,7 @@
 
 [metadata]
 name = de.p1st.monitor
-version = 0.11.5
+version = 0.12.0
 author = Daniel Langbein
 author_email = daniel@systemli.org
 description = periodically monitor and warn
diff --git a/src/de/p1st/monitor/cfg/singleton.py b/src/de/p1st/monitor/cfg/singleton.py
index 94a8fd1..93676ec 100644
--- a/src/de/p1st/monitor/cfg/singleton.py
+++ b/src/de/p1st/monitor/cfg/singleton.py
@@ -23,11 +23,11 @@ def init_cfg(config_file: Path = None):
             config_file = None
 
     # Otherwise, use packaged config file.
-    if config_file is None:
-        pkg = importlib_resources.files('de.p1st.monitor')
-        config_file = pkg / 'data' / f'{hostname}.ini'
-        if not config_file.is_file():
-            config_file = None
+    # if config_file is None:
+    #     pkg = importlib_resources.files('de.p1st.monitor')
+    #     config_file = pkg / 'data' / f'{hostname}.ini'
+    #     if not config_file.is_file():
+    #         config_file = None
 
     if config_file is None or not config_file.is_file():
         raise Exception(f'Configuration file does not exist! {config_file}')
diff --git a/src/de/p1st/monitor/data/yodaHedgehog.ini b/src/de/p1st/monitor/data/yodaHedgehog.ini
deleted file mode 100644
index d0bb6f5..0000000
--- a/src/de/p1st/monitor/data/yodaHedgehog.ini
+++ /dev/null
@@ -1,38 +0,0 @@
-[logging]
-dir = /var/log/de-p1st-monitor/
-
-[filesystem.1]
-mountpoint = /
-warn_if_above = 0.75
-[filesystem.2]
-mountpoint = /boot
-warn_if_above = 0.75
-; TODO
-
-[memory]
-warn_if_above = 0.85
-[swap]
-warn_if_above = 0.85
-
-[cpu1]
-warn_if_above = 2.0
-warn_threshold = 2
-warn_data_range = 2
-[cpu5]
-warn_if_above = 1.5
-warn_threshold = 2
-warn_data_range = 2
-[cpu15]
-warn_if_above = 1.0
-warn_threshold = 2
-warn_data_range = 2
-
-; TODO coretemp
-
-; TODO network
-
-[drive_temp.1]
-; HDD drives
-; TODO: 39 warn, 45 limit
-type = drivetemp
-warn_if_above = 40
diff --git a/src/de/p1st/monitor/data/yodaNas.ini b/src/de/p1st/monitor/data/yodaNas.ini
deleted file mode 100644
index 9a28417..0000000
--- a/src/de/p1st/monitor/data/yodaNas.ini
+++ /dev/null
@@ -1,70 +0,0 @@
-[logging]
-dir = /var/log/de-p1st-monitor/
-
-[filesystem.1]
-; 256GB2
-mountpoint = /
-warn_if_above = 0.75
-[filesystem.2]
-; 256GB2
-mountpoint = /boot
-warn_if_above = 0.75
-[filesystem.3]
-; 12TB1
-uuid = c385a436-0288-486f-a2b9-c64c2db667e7
-warn_if_above = 0.66
-[filesystem.4]
-; 3TB1, 3TB2 and 4TB1
-uuid = 1f560eeb-a375-457b-84a6-93d771a5ba5f
-warn_if_above = 0.85
-unmounted_ok = true
-
-[memory]
-warn_if_above = 0.85
-[swap]
-warn_if_above = 0.85
-
-[cpu1]
-warn_if_above = 3.0
-warn_threshold = 2
-warn_data_range = 2
-[cpu5]
-warn_if_above = 2.0
-warn_threshold = 2
-warn_data_range = 2
-[cpu15]
-warn_if_above = 1.0
-warn_threshold = 2
-warn_data_range = 2
-
-[temp.1]
-sensor = coretemp
-label = Package id 0
-warn_if_above = 60
-[temp.2]
-sensor = coretemp
-label = Core 0
-warn_if_above = 60
-[temp.3]
-sensor = coretemp
-label = Core 1
-warn_if_above = 60
-
-[network.1]
-network_interface = enp0s31f6
-
-[drive_temp.1]
-; NVMe drives
-; TODO: 49 warn, 55 limit
-type = nvme
-warn_if_above = 50
-[drive_temp.2]
-; HDD drives
-; TODO: 39 warn, 45 limit
-type = drivetemp
-warn_if_above = 40
-
-; [sensor_script.1]
-; cmd = ["digitemp_DS9097", "-q", "-c", "/home/yoda/.digitemprc", "-t", "0"]
-; name = room-temp
-; warn_if_above = 32