keep-alive tracing

* new tracing system: moved instances to NodeToNode module, where other
  mini-protocol tracers are defined.
* make the output of the legacy tracing system for keep alive
  measurements, the same as the new one.

Author: coot

cardano-node/ChangeLog.md

@@ -27,6 +27,9 @@
   }
   ```
 
+- KeepAlive client tracing: dropped `KeepAliveClient` from `kind` of
+  `AddSample` messages in the legacy tracing system.
+
 ## 10.2 -- January 2025
 
 - Use p2p network stack by default, warn when using the legacy network stack.

cardano-node/src/Cardano/Node/Tracing/Tracers/Consensus.hs

@@ -68,14 +68,11 @@ import qualified Ouroboros.Network.BlockFetch.ClientState as BlockFetch
 import           Ouroboros.Network.BlockFetch.Decision
 import           Ouroboros.Network.BlockFetch.Decision.Trace (TraceDecisionEvent (..))
 import           Ouroboros.Network.ConnectionId (ConnectionId (..))
-import           Ouroboros.Network.DeltaQ (GSV (..), PeerGSV (..))
-import           Ouroboros.Network.KeepAlive (TraceKeepAliveClient (..))
 import           Ouroboros.Network.SizeInBytes (SizeInBytes (..))
 import           Ouroboros.Network.TxSubmission.Inbound hiding (txId)
 import           Ouroboros.Network.TxSubmission.Outbound
 
 import           Control.Monad (guard)
-import           Control.Monad.Class.MonadTime.SI (Time (..))
 import           Data.Aeson (ToJSON, Value (Number, String), toJSON, (.=))
 import qualified Data.Aeson as Aeson
 import           Data.Foldable (Foldable (toList))
@@ -84,7 +81,7 @@ import           Data.IntPSQ (IntPSQ)
 import qualified Data.IntPSQ as Pq
 import qualified Data.List as List
 import qualified Data.Text as Text
-import           Data.Time (DiffTime, NominalDiffTime)
+import           Data.Time (NominalDiffTime)
 import           Data.Word (Word32, Word64)
 import           Network.TypedProtocol.Core
 
@@ -2114,41 +2111,6 @@ instance MetaTrace (TraceBlockchainTimeEvent t) where
     , Namespace [] ["SystemClockMovedBack"]
     ]
 
---------------------------------------------------------------------------------
--- KeepAliveClient Tracer
---------------------------------------------------------------------------------
-
-instance Show remotePeer => LogFormatting (TraceKeepAliveClient remotePeer) where
-    forMachine _dtal (AddSample peer rtt pgsv) =
-        mconcat
-          [ "kind" .= String "AddSample"
-          , "address" .= show peer
-          , "rtt" .= rtt
-          , "sampleTime" .= show (dTime $ sampleTime pgsv)
-          , "outboundG" .= (realToFrac $ gGSV (outboundGSV pgsv) :: Double)
-          , "inboundG" .= (realToFrac $ gGSV (inboundGSV pgsv) :: Double)
-          ]
-        where
-          gGSV :: GSV -> DiffTime
-          gGSV (GSV g _ _) = g
-
-          dTime :: Time -> Double
-          dTime (Time d) = realToFrac d
-
-    forHuman = showT
-
-instance MetaTrace (TraceKeepAliveClient remotePeer) where
-  namespaceFor AddSample {} = Namespace [] ["KeepAliveClient"]
-
-  severityFor (Namespace _ ["KeepAliveClient"]) Nothing = Just Info
-  severityFor _ _ = Nothing
-
-  documentFor (Namespace _ ["KeepAliveClient"]) = Just
-    "A server read has occurred, either for an add block or a rollback"
-  documentFor _ = Just ""
-
-  allNamespaces = [Namespace [] ["KeepAliveClient"]]
-
 --------------------------------------------------------------------------------
 -- Gsm Tracer
 --------------------------------------------------------------------------------

cardano-node/src/Cardano/Node/Tracing/Tracers/NodeToNode.hs

@@ -20,14 +20,18 @@ import           Ouroboros.Consensus.Ledger.SupportsMempool (GenTx, HasTxId, Has
                    LedgerSupportsMempool, extractTxs, txId)
 import           Ouroboros.Consensus.Node.Run (SerialiseNodeToNodeConstraints, estimateBlockSize)
 import           Ouroboros.Network.Block (Point, Serialised (..), blockHash)
+import           Ouroboros.Network.DeltaQ (GSV (..), PeerGSV (..))
+import           Ouroboros.Network.KeepAlive (TraceKeepAliveClient (..))
 import           Ouroboros.Network.Protocol.BlockFetch.Type (BlockFetch (..), Message (..))
 import qualified Ouroboros.Network.Protocol.TxSubmission2.Type as STX
 import qualified Ouroboros.Network.Protocol.KeepAlive.Type as KA
 import qualified Ouroboros.Network.Protocol.PeerSharing.Type as PS
 import           Ouroboros.Network.SizeInBytes (SizeInBytes (..))
 
+import           Control.Monad.Class.MonadTime.SI (Time (..))
 import           Data.Aeson (ToJSON (..), Value (String), (.=))
 import           Data.Proxy (Proxy (..))
+import           Data.Time (DiffTime)
 import           Data.Text (pack)
 import           Network.TypedProtocol.Codec (AnyMessage (AnyMessageAndAgency))
 
@@ -427,3 +431,38 @@ instance MetaTrace (AnyMessage (PS.PeerSharing addr)) where
       , Namespace [] ["PeerShareResult"]
       , Namespace [] ["PeerShareDone"]
       ]
+
+--------------------------------------------------------------------------------
+-- KeepAliveClient Tracer
+--------------------------------------------------------------------------------
+
+instance Show remotePeer => LogFormatting (TraceKeepAliveClient remotePeer) where
+    forMachine _dtal (AddSample peer rtt pgsv) =
+        mconcat
+          [ "kind" .= String "AddSample"
+          , "address" .= show peer
+          , "rtt" .= rtt
+          , "sampleTime" .= show (dTime $ sampleTime pgsv)
+          , "outboundG" .= (realToFrac $ gGSV (outboundGSV pgsv) :: Double)
+          , "inboundG" .= (realToFrac $ gGSV (inboundGSV pgsv) :: Double)
+          ]
+        where
+          gGSV :: GSV -> DiffTime
+          gGSV (GSV g _ _) = g
+
+          dTime :: Time -> Double
+          dTime (Time d) = realToFrac d
+
+    forHuman = showT
+
+instance MetaTrace (TraceKeepAliveClient remotePeer) where
+  namespaceFor AddSample {} = Namespace [] ["KeepAliveClient"]
+
+  severityFor (Namespace _ ["KeepAliveClient"]) Nothing = Just Info
+  severityFor _ _ = Nothing
+
+  documentFor (Namespace _ ["KeepAliveClient"]) = Just
+    "A server read has occurred, either for an add block or a rollback"
+  documentFor _ = Just ""
+
+  allNamespaces = [Namespace [] ["KeepAliveClient"]]

cardano-node/src/Cardano/Tracing/OrphanInstances/Network.hs

@@ -1526,7 +1526,7 @@ instance (Show txid, Show tx)
 instance Show remotePeer => ToObject (TraceKeepAliveClient remotePeer) where
   toObject _verb (AddSample peer rtt pgsv) =
     mconcat
-      [ "kind" .= String "KeepAliveClient AddSample"
+      [ "kind" .= String "AddSample"
       , "address" .= show peer
       , "rtt" .= rtt
       , "sampleTime" .= show (dTime $ sampleTime pgsv)