From: Aleš Mrázek <ales.mrazek@nic.cz>
Date: Mon, 5 Feb 2024 15:15:58 +0000 (+0100)
Subject: naming: replacing 'kids' suffix with 'kresids' for clarification
X-Git-Tag: v6.0.7~23^2~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ac5506c70ff0cd3e8a0e0a3f516d2fbe7a44c129;p=thirdparty%2Fknot-resolver.git

naming: replacing 'kids' suffix with 'kresids' for clarification
---

diff --git a/manager/knot_resolver_manager/kresd_controller/interface.py b/manager/knot_resolver_manager/kresd_controller/interface.py
index aa339c265..30ec03574 100644
--- a/manager/knot_resolver_manager/kresd_controller/interface.py
+++ b/manager/knot_resolver_manager/kresd_controller/interface.py
@@ -98,8 +98,8 @@ class Subprocess(ABC):
     One SubprocessInstance corresponds to one manager's subprocess
     """
 
-    def __init__(self, config: KresConfig, kid: KresID) -> None:
-        self._id = kid
+    def __init__(self, config: KresConfig, kresid: KresID) -> None:
+        self._id = kresid
         self._config = config
         self._registered_worker: bool = False
 
diff --git a/manager/knot_resolver_manager/kresd_controller/registered_workers.py b/manager/knot_resolver_manager/kresd_controller/registered_workers.py
index 2478fdaef..9a3a0d368 100644
--- a/manager/knot_resolver_manager/kresd_controller/registered_workers.py
+++ b/manager/knot_resolver_manager/kresd_controller/registered_workers.py
@@ -14,7 +14,7 @@ logger = logging.getLogger(__name__)
 _REGISTERED_WORKERS: "Dict[KresID, Subprocess]" = {}
 
 
-def get_registered_workers_kids() -> "List[KresID]":
+def get_registered_workers_kresids() -> "List[KresID]":
     return list(_REGISTERED_WORKERS.keys())
 
 
diff --git a/manager/knot_resolver_manager/statistics.py b/manager/knot_resolver_manager/statistics.py
index 4b2c2e7d0..50cfc7f1c 100644
--- a/manager/knot_resolver_manager/statistics.py
+++ b/manager/knot_resolver_manager/statistics.py
@@ -13,7 +13,7 @@ from knot_resolver_manager.config_store import ConfigStore, only_on_real_changes
 from knot_resolver_manager.datamodel.config_schema import KresConfig
 from knot_resolver_manager.kresd_controller.registered_workers import (
     command_registered_workers,
-    get_registered_workers_kids,
+    get_registered_workers_kresids,
 )
 from knot_resolver_manager.utils.functional import Result
 
@@ -125,11 +125,11 @@ class ResolverCollector:
             # when not running, we can start a new loop (we are not in the manager's main thread)
             compat.asyncio.run(self.collect_kresd_stats(_triggered_from_prometheus_library=True))
 
-    def _create_resolver_metrics_loaded_gauge(self, kid: "KresID", loaded: bool) -> GaugeMetricFamily:
+    def _create_resolver_metrics_loaded_gauge(self, kresid: "KresID", loaded: bool) -> GaugeMetricFamily:
         return _gauge(
             "resolver_metrics_loaded",
             "0 if metrics from resolver instance were not loaded, otherwise 1",
-            label=("instance_id", str(kid)),
+            label=("instance_id", str(kresid)),
             value=int(loaded),
         )
 
@@ -139,29 +139,31 @@ class ResolverCollector:
 
         # if we have no data, return metrics with information about it and exit
         if self._stats_raw is None:
-            for kid in get_registered_workers_kids():
-                yield self._create_resolver_metrics_loaded_gauge(kid, False)
+            for kresid in get_registered_workers_kresids():
+                yield self._create_resolver_metrics_loaded_gauge(kresid, False)
             return
 
         # if we have data, parse them
-        for kid in get_registered_workers_kids():
+        for kresid in get_registered_workers_kresids():
             success = False
             try:
-                if kid in self._stats_raw:
-                    raw = self._stats_raw[kid]
+                if kresid in self._stats_raw:
+                    raw = self._stats_raw[kresid]
                     metrics: Dict[str, int] = json.loads(raw[1:-1])
-                    yield from self._parse_resolver_metrics(kid, metrics)
+                    yield from self._parse_resolver_metrics(kresid, metrics)
                     success = True
             except json.JSONDecodeError:
-                logger.warning("Failed to load metrics from resolver instance %s: failed to parse statistics", str(kid))
+                logger.warning(
+                    "Failed to load metrics from resolver instance %s: failed to parse statistics", str(kresid)
+                )
             except KeyError as e:
                 logger.warning(
                     "Failed to load metrics from resolver instance %s: attempted to read missing statistic %s",
-                    str(kid),
+                    str(kresid),
                     str(e),
                 )
 
-            yield self._create_resolver_metrics_loaded_gauge(kid, success)
+            yield self._create_resolver_metrics_loaded_gauge(kresid, success)
 
     def describe(self) -> List[Metric]:
         # this function prevents the collector registry from invoking the collect function on startup