diff --git a/cardano-tracer/docs/cardano-tracer.md b/cardano-tracer/docs/cardano-tracer.md index 58e094b9152..126e9518ef3 100644 --- a/cardano-tracer/docs/cardano-tracer.md +++ b/cardano-tracer/docs/cardano-tracer.md @@ -274,7 +274,7 @@ In this example, `cardano-tracer` listens on port 34567. Nodes can connect via I ### Important -On same-host setups sockets are always preferrable due to **less overhead and better performance**. On multi-host setups, socket connection via SSH tunnels is always preferrable due to **increased security**. +On same-host setups sockets are always preferable due to **less overhead and better performance**. On multi-host setups, socket connection via SSH tunnels is always preferable due to **increased security**. Use TCP forwarding **if and only if** you control each and every aspect of the environment, such as port mapping or firewalls, or virtual network setup - the 'forwarding protocol' does not implement encrypting traffic nor authentication methods. @@ -449,7 +449,7 @@ rts_gc_bytes_copied 17114384 # EOF ``` -Passing metric help annotations to the service can be done in the config file, either as a key-value map from metric name to help text, or as a seperate JSON file containing such a map. +Passing metric help annotations to the service can be done in the config file, either as a key-value map from metric name to help text, or as a separate JSON file containing such a map. The system's internal metric names have to be used as keys (cf. [metrics documentation](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/new-tracing/tracers_doc_generated.md#metrics)). ``` "metricsHelp": "path/to/key-value-map.json" diff --git a/cardano-tracer/src/Cardano/Tracer/Configuration.hs b/cardano-tracer/src/Cardano/Tracer/Configuration.hs index a166364b7ff..0dbbf9c2178 100644 --- a/cardano-tracer/src/Cardano/Tracer/Configuration.hs +++ b/cardano-tracer/src/Cardano/Tracer/Configuration.hs @@ -161,7 +161,7 @@ data TracerConfig = TracerConfig , logging :: !(NonEmpty LoggingParams) -- ^ Logging parameters. , rotation :: !(Maybe RotationParams) -- ^ Rotation parameters. , verbosity :: !(Maybe Verbosity) -- ^ Verbosity of the tracer itself. - , metricsNoSuffix :: !(Maybe Bool) -- ^ Prometheus ONLY: Dropping metrics name suffixes (like "_int") increases similiarity with old system names - if desired; default: False + , metricsNoSuffix :: !(Maybe Bool) -- ^ Prometheus ONLY: Dropping metrics name suffixes (like "_int") increases similarity with old system names - if desired; default: False , metricsHelp :: !(Maybe FileOrMap) -- ^ Prometheus ONLY: JSON file or object containing a key-value map "metric name -> help text" for "# HELP " annotations , resourceFreq :: !(Maybe Int) -- ^ Frequency (1/millisecond) for gathering resource data. , ekgRequestFull :: !(Maybe Bool) -- ^ Request full set of metrics always, vs. deltas only (safer, but more overhead); default: False diff --git a/cardano-tracer/test/Cardano/Tracer/Test/ForwardingStressTest/Script.hs b/cardano-tracer/test/Cardano/Tracer/Test/ForwardingStressTest/Script.hs index f4fe87ad062..dae45a1e003 100644 --- a/cardano-tracer/test/Cardano/Tracer/Test/ForwardingStressTest/Script.hs +++ b/cardano-tracer/test/Cardano/Tracer/Test/ForwardingStressTest/Script.hs @@ -84,7 +84,7 @@ runScriptForwarding TestSetup{..} msgCountersRef msgsRef tracerGetter = do let numMsg = sum (fmap (\ (Script sc) -> length sc) scripts''') if numMsg > 0 then do - -- TODO mutiple files + -- TODO multiple files let logfileGlobPattern = unI tsWorkDir <> "/logs/*sock@*/node-*.json" logs <- glob logfileGlobPattern logFile <- case logs of diff --git a/trace-dispatcher/src/Cardano/Logging/ConfigurationParser.hs b/trace-dispatcher/src/Cardano/Logging/ConfigurationParser.hs index e5fd0369b89..a006aa15473 100644 --- a/trace-dispatcher/src/Cardano/Logging/ConfigurationParser.hs +++ b/trace-dispatcher/src/Cardano/Logging/ConfigurationParser.hs @@ -97,7 +97,7 @@ readConfiguration fp = either throwIO pure . parseRepresentation =<< BS.readFile fp -- | Read a configuration file and returns the internal representation --- Uses values which are not in the file fram the defaultConfig +-- Uses values which are not in the file from the defaultConfig readConfigurationWithDefault :: FilePath -> TraceConfig -> IO TraceConfig readConfigurationWithDefault fp defaultConf = do fileConf <- either throwIO pure . parseRepresentation =<< BS.readFile fp diff --git a/trace-dispatcher/src/Cardano/Logging/Types.hs b/trace-dispatcher/src/Cardano/Logging/Types.hs index 2a7fe9681bc..28b14c05381 100644 --- a/trace-dispatcher/src/Cardano/Logging/Types.hs +++ b/trace-dispatcher/src/Cardano/Logging/Types.hs @@ -504,7 +504,7 @@ instance AE.FromJSON TraceOptionForwarder where queueSize <- case maybeQueueSize of -- If the new field was provided we use it. (Just qs) -> return qs - -- Else we look for the deprectaed fields. + -- Else we look for the deprecated fields. Nothing -> do -- We keep the same default values. connQueueSize <- obj AE..:? "connQueueSize" AE..!= 1024