cardano-tracer: Fix typos, better commens

Author: jutaro

Diff for: cardano-tracer/src/Cardano/Tracer/Configuration.hs

@@ -93,7 +93,7 @@ data TracerConfig = TracerConfig
   , logging        :: !(NonEmpty LoggingParams)     -- ^ Logging parameters.
   , rotation       :: !(Maybe RotationParams)       -- ^ Rotation parameters.
   , verbosity      :: !(Maybe Verbosity)            -- ^ Verbosity of the tracer itself.
-  , metricsComp    :: !(Maybe (Map Text Text))      -- ^ Metrics compability map from metrics name to metrics name
+  , metricsComp    :: !(Maybe (Map Text Text))      -- ^ Metrics compatibility map from metrics name to metrics name
   } deriving (Eq, Generic, FromJSON, ToJSON, Show)
 
 -- | Read the tracer's configuration file.

Diff for: cardano-tracer/src/Cardano/Tracer/Handlers/Metrics/Prometheus.hs

@@ -126,7 +126,7 @@ getMetricsFromNode tracerEnv nodeId acceptedMetrics =
  where
   getListOfMetrics :: Sample -> MetricsList
   getListOfMetrics =
-      metricsCompability
+      metricsCompatibility
       . filter (not . T.null . fst)
       . map metricsWeNeed
       . HM.toList
@@ -149,8 +149,8 @@ getMetricsFromNode tracerEnv nodeId acceptedMetrics =
     . T.replace "-" "_"
     . T.replace "." "_"
 
-  metricsCompability :: MetricsList -> MetricsList
-  metricsCompability metricsList =
+  metricsCompatibility :: MetricsList -> MetricsList
+  metricsCompatibility metricsList =
       case metricsComp (teConfig tracerEnv) of
         Nothing -> metricsList
         Just mmap -> foldl  (\ accu p'@(mn,mv) -> case M.lookup mn mmap of

Diff for: nix/nixos/cardano-tracer-service.nix

@@ -41,11 +41,14 @@ let serviceConfigToJSON =
           epHost    = "127.0.0.1";
           epPort    = 3200; ## supervisord.portShiftPrometheus
         } // (cfg.prometheus or {});
-        ## TODO YUP: replace with real mappings
-        metricsComp = {
-            "Mempool.TxsInMempool" = "Mempool.TxsInMempool.Mapped";
-            "ChainDB.SlotNum" = "ChainDB.SlotNum.Mapped";
-        };
+        # Just an example for metrics compatibility mapping.
+        # An entry means the first entry has the second entry as alias.
+        # The Metrics is then avalable, both with the original and the mapped name.
+        # Only one mapping per message is supported.
+        # metricsComp = {
+        #     "Mempool.TxsInMempool" = "Mempool.TxsInMempool.Mapped";
+        #     "ChainDB.SlotNum" = "ChainDB.SlotNum.Mapped";
+        # };
       };
 in pkgs.commonLib.defServiceModule
   (lib: with lib;