Merge tag '0.1.2' into develop

added `SETTINGS.disk.vroot`

kiwi_simple_metrics/metrics/disk.py

@@ -1,4 +1,5 @@
 import os
+from pathlib import PurePath
 from typing import Iterator
 
 from ..settings import SETTINGS
@@ -6,16 +7,26 @@ from ._report import Report, ReportData
 
 
 def _hwdata() -> Iterator[ReportData]:
-    def get_path_statvfs(path: os.PathLike) -> dict[str, float]:
+    def get_path_statvfs(path: os.PathLike) -> dict[str, int]:
         sv = os.statvfs(path)
         return {
             "free": sv.f_bavail,
             "total": sv.f_blocks,
         }
 
+    def get_path_name(path: os.PathLike) -> str:
+        # get path and its parents
+        path = PurePath(path)
+
+        # if path or above is the vroot, make it a "virtual absolute" path
+        if SETTINGS.disk.vroot in [path, *path.parents]:
+            path = "/" / path.relative_to(SETTINGS.disk.vroot)
+
+        return str(path)
+
     yield from sorted([
         ReportData.from_free_total(
-            name=str(path),
+            name=get_path_name(path),
             **get_path_statvfs(path),
             settings=SETTINGS.disk,
         ) for path in SETTINGS.disk.paths

kiwi_simple_metrics/settings/metric.py

@@ -83,6 +83,9 @@ class DiskMS(MetricSettings):
     # paths to check for disk space
     paths: list[DirectoryPath] = [DirectoryPath("/")]
 
+    # path to be treated as filesystem root
+    vroot: DirectoryPath = DirectoryPath("/")
+
 
 class ExternalMS(MetricSettings):
     name: str = "External Metric"

pyproject.toml

@@ -5,7 +5,7 @@ license = "MIT"
 name = "kiwi-simple-metrics"
 packages = [{include = "kiwi_simple_metrics"}]
 readme = "README.md"
-version = "0.1.0"
+version = "0.1.2"
 
 [tool.poetry.dependencies]
 psutil = "^5.9.5"