Merge pull request #321 from yfyf/metrics-in-diagnostics

Add METRICS diagnostic type with InfluxDB backups

Author: knuton

pkgs/playos-diagnostics/default.nix

@@ -15,6 +15,7 @@ pkgs.writeShellApplication {
     rauc
     grub2_efi
     curl
+    influxdb
   ];
   text = builtins.readFile ./playos-diagnostics.sh;
 }

pkgs/playos-diagnostics/playos-diagnostics.sh

@@ -8,6 +8,7 @@ declare -a DIAGNOSTIC_TYPES=(
     "HARDWARE"
     "LOGS"
     "NETWORK"
+    "METRICS"
     "STATS"
     "SYSINFO"
     "UPDATE"
@@ -60,7 +61,7 @@ Limits:
                             suffixes for seconds, minutes, hours, days.
 
 Filters:
-    -m, --minimal           Produce a small archive. Alias for --exclude=LOGS
+    -m, --minimal           Produce a small archive. Alias for "--exclude=METRICS --exclude=LOGS"
 
     -S, --since SINCE       How much historical data (e.g. logs) to collect.
                             Defaults to "${DEFAULT_SINCE}".
@@ -100,7 +101,7 @@ while [[ $# -gt 0 ]]; do
         -h|--help) usage ;;
         -o|--output) OUTPUT="$2"; shift 2 ;;
         --log-format) LOG_FORMAT="$2"; shift 2 ;;
-        -m|--minimal) EXCLUDES+=("LOGS"); shift ;;
+        -m|--minimal) EXCLUDES+=("LOGS" "METRICS"); shift ;;
         -S|--since) SINCE="$2"; shift 2 ;;
         --cmd-timeout) CMD_TIMEOUT="$2"; shift 2 ;;
         -e|--exclude) EXCLUDES+=("$2"); shift 2 ;;
@@ -240,6 +241,16 @@ collect_UPDATE() {
     run_cmd -o controller_system_status.html curl -L --fail --silent http://localhost:3333/status
 }
 
+collect_METRICS() {
+    # If influxdb is not running, the backup tool keeps retrying with back-off,
+    # which will take forever, so to fail early we check if the service is active
+    #
+    # Expected uncompressed size is around 200-300 MB
+    run_cmd -o /dev/null \
+        "systemctl is-active -q influxdb.service && \
+         influxd backup -portable -skip-errors ./influxdb-backup"
+}
+
 workdir=$(mktemp -d)
 # shellcheck disable=SC2064
 trap "rm -rf '$workdir'" EXIT

testing/integration/playos-diagnostics.nix

@@ -13,6 +13,7 @@ pkgs.testers.runNixOSTest {
       config = {
         environment.systemPackages = with pkgs; [ playos-diagnostics ];
         services.connman.enable = pkgs.lib.mkOverride 0 true; # disabled in runNixOSTest by default
+        services.influxdb.enable = true; # for testing backups in METRICS
       };
     };
   };
@@ -169,11 +170,14 @@ with TestCase("proxy passwords are masked in connman output") as t:
             f"The expected masked string '{expected_mask}' was not found.")
 
 
-with TestCase("--minimal flag excludes logs") as t:
+with TestCase("--minimal flag excludes logs and metrics") as t:
     with diagnostic_output('--minimal') as (_, tmpdir):
         match = list(tmpdir.glob("playos-diagnostics-*/data/logs/"))
         t.assertEqual(match, [])
 
+        match = list(tmpdir.glob("playos-diagnostics-*/data/metrics/"))
+        t.assertEqual(match, [])
+
 
 with TestCase("--exclude excludes custom types") as t:
     with diagnostic_output('--exclude NETWORK') as (_, tmpdir):