CAD-2572 Tracing: Get EKG Server to traces

IntersectMBO · May 13, 2021 · ce361a9 · ce361a9
1 parent 3362b49
commit ce361a9
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 14 deletions.
diff --git a/cardano-node/cardano-node.cabal b/cardano-node/cardano-node.cabal
@@ -76,6 +76,7 @@ library
                      , byron-spec-ledger
                      , bytestring
                      , deepseq
+                     , ekg
                      , cardano-api
                      , cardano-config
                      , cardano-crypto-class

diff --git a/cardano-node/src/Cardano/Node/Configuration/Logging.hs b/cardano-node/src/Cardano/Node/Configuration/Logging.hs
@@ -31,6 +31,7 @@ import           Data.List (nub)
 import           Data.Text (pack)
 import           Data.Time.Clock (UTCTime, getCurrentTime)
 import           Data.Version (showVersion)
+import qualified System.Remote.Monitoring as EKG
 
 import           Cardano.BM.Backend.Aggregation (plugin)
 import           Cardano.BM.Backend.EKGView (plugin)
@@ -109,6 +110,7 @@ data LoggingLayer = LoggingLayer
   , llConfiguration :: Configuration
   , llAddBackend :: Backend Text -> BackendKind -> IO ()
   , llSwitchboard :: Switchboard Text
+  , llEKGServer :: Maybe EKG.Server
   }
 
 --------------------------------
@@ -163,7 +165,9 @@ createLoggingLayer ver nodeConfig' p = do
   when loggingEnabled $ liftIO $
     loggingPreInit nodeConfig' logConfig switchBoard trace
 
-  pure $ mkLogLayer logConfig switchBoard trace
+  mEKGServer <- liftIO $ Switchboard.getSbEKGServer switchBoard
+
+  pure $ mkLogLayer logConfig switchBoard mEKGServer trace
  where
    loggingPreInit
      :: NodeConfiguration
@@ -217,8 +221,8 @@ createLoggingLayer ver nodeConfig' p = do
        -- Record node metrics, if configured
        startCapturingMetrics trace
 
-   mkLogLayer :: Configuration -> Switchboard Text -> Trace IO Text -> LoggingLayer
-   mkLogLayer logConfig switchBoard trace =
+   mkLogLayer :: Configuration -> Switchboard Text -> Maybe EKG.Server -> Trace IO Text -> LoggingLayer
+   mkLogLayer logConfig switchBoard mEKGServer trace =
      LoggingLayer
        { llBasicTrace = Trace.natTrace liftIO trace
        , llLogDebug = Trace.logDebug
@@ -235,6 +239,7 @@ createLoggingLayer ver nodeConfig' p = do
        , llConfiguration = logConfig
        , llAddBackend = Switchboard.addExternalBackend switchBoard
        , llSwitchboard = switchBoard
+       , llEKGServer = mEKGServer
        }
 
    startCapturingMetrics :: Trace IO Text -> IO ()

diff --git a/cardano-node/src/Cardano/Node/Run.hs b/cardano-node/src/Cardano/Node/Run.hs
@@ -113,7 +113,7 @@ runNode cmdPc = do
                      p
 
     loggingLayer <- case eLoggingLayer of
-                      Left err -> putTextLn (show err) >> exitFailure
+                      Left err  -> putTextLn (show err) >> exitFailure
                       Right res -> return res
 
     !trace <- setupTrace loggingLayer
@@ -125,7 +125,11 @@ runNode cmdPc = do
     -- Used for ledger queries and peer connection status.
     nodeKernelData :: NodeKernelData blk <- mkNodeKernelData
 
-    tracers <- mkTracers (ncTraceConfig nc) trace nodeKernelData
+    tracers <- mkTracers
+                 (ncTraceConfig nc)
+                 trace
+                 nodeKernelData
+                 (llEKGServer loggingLayer)
 
     Async.withAsync (handlePeersListSimple trace nodeKernelData)
         $ \_peerLogingThread ->

diff --git a/cardano-node/src/Cardano/Tracing/Tracers.hs b/cardano-node/src/Cardano/Tracing/Tracers.hs
@@ -33,6 +33,7 @@ import           Data.Aeson (ToJSON (..), Value (..))
 import qualified Data.HashMap.Strict as Map
 import qualified Data.Text as Text
 import           Data.Time (UTCTime)
+import qualified System.Remote.Monitoring as EKG
 
 import           Network.Mux (MuxTrace, WithMuxBearer)
 import qualified Network.Socket as Socket (SockAddr)
@@ -274,16 +275,20 @@ mkTracers
   => TraceOptions
   -> Trace IO Text
   -> NodeKernelData blk
+  -> Maybe EKG.Server
   -> IO (Tracers peer localPeer blk)
-mkTracers tOpts@(TracingOn trSel) tr nodeKern = do
+mkTracers tOpts@(TracingOn trSel) tr nodeKern mEKGServer = do
   fStats <- mkForgingStats
   consensusTracers <- mkConsensusTracers trSel verb tr nodeKern fStats
   elidedChainDB <- newstate  -- for eliding messages in ChainDB tracer
 
   pure Tracers
     { chainDBTracer = tracerOnOff' (traceChainDB trSel) $
-        annotateSeverity $ teeTraceChainTip tOpts elidedChainDB
-                             (appendName "ChainDB" tr) (appendName "metrics" tr)
+        annotateSeverity $ teeTraceChainTip
+                             tOpts elidedChainDB
+                             mEKGServer
+                             (appendName "ChainDB" tr)
+                             (appendName "metrics" tr)
     , consensusTracers = consensusTracers
     , nodeToClientTracers = nodeToClientTracers' trSel verb tr
     , nodeToNodeTracers = nodeToNodeTracers' trSel verb tr
@@ -302,7 +307,7 @@ mkTracers tOpts@(TracingOn trSel) tr nodeKern = do
    verb :: TracingVerbosity
    verb = traceVerbosity trSel
 
-mkTracers TracingOff _ _ =
+mkTracers TracingOff _ _ _ =
   pure Tracers
     { chainDBTracer = nullTracer
     , consensusTracers = Consensus.Tracers
@@ -359,14 +364,15 @@ teeTraceChainTip
      )
   => TraceOptions
   -> MVar (Maybe (WithSeverity (ChainDB.TraceEvent blk)), Integer)
+  -> Maybe EKG.Server
   -> Trace IO Text
   -> Trace IO Text
   -> Tracer IO (WithSeverity (ChainDB.TraceEvent blk))
-teeTraceChainTip TracingOff _ _ _ = nullTracer
-teeTraceChainTip (TracingOn trSel) elided trTrc trMet =
+teeTraceChainTip TracingOff _ _ _ _ = nullTracer
+teeTraceChainTip (TracingOn trSel) elided mEKGServer trTrc trMet =
   Tracer $ \ev -> do
     traceWith (teeTraceChainTipElide (traceVerbosity trSel) elided trTrc) ev
-    traceWith (ignoringSeverity (traceChainMetrics trMet)) ev
+    traceWith (ignoringSeverity (traceChainMetrics mEKGServer trMet)) ev
 
 teeTraceChainTipElide
   :: ( ConvertRawHash blk
@@ -388,8 +394,9 @@ ignoringSeverity tr = Tracer $ \(WithSeverity _ ev) -> traceWith tr ev
 
 traceChainMetrics
   :: forall blk. HasHeader (Header blk)
-  => Trace IO Text -> Tracer IO (ChainDB.TraceEvent blk)
-traceChainMetrics tr = Tracer $ \ev ->
+  => Maybe EKG.Server -> Trace IO Text -> Tracer IO (ChainDB.TraceEvent blk)
+traceChainMetrics Nothing _ = nullTracer
+traceChainMetrics (Just _eKGServer) tr = Tracer $ \ev ->
   fromMaybe (pure ()) $
     doTrace <$> chainTipInformation ev
  where