Merge #4561

4561: Trace changes r=Jimbo4350 a=coot

This PR contains various small changes to traces.

- Removed kind field from NodeTo{Node,Client}VersionData
- Fixed a typo
- Changed IP ToJSON instance
- Simplified ToJSON instance of LocalRootPeers
- Use Notice severity for NetworkConfigUpdate
- Added severityStartupTracer

Fixes #4560


Co-authored-by: Marcin Szamotulski <[email protected]>

Author: iohk-bors[bot]

Diff for: cardano-node/src/Cardano/Node/Startup.hs

@@ -113,6 +113,16 @@ data StartupTrace blk =
   | BIByron BasicInfoByron
   | BINetwork BasicInfoNetwork
 
+severityStartupTracer :: StartupTrace blk -> SeverityS
+severityStartupTracer (StartupSocketConfigError _) = Error
+severityStartupTracer NetworkConfigUpdate = Notice
+severityStartupTracer (NetworkConfigUpdateError _) = Error
+severityStartupTracer NetworkConfigUpdateUnsupported = Warning
+severityStartupTracer P2PWarning = Warning
+severityStartupTracer P2PWarningDevelopementNetworkProtocols = Warning
+severityStartupTracer WarningDevelopmentNetworkProtocols {} = Warning
+severityStartupTracer _ = Info
+
 data BasicInfoCommon = BasicInfoCommon {
     biConfigPath    :: FilePath
   , biNetworkMagic  :: NetworkMagic

Diff for: cardano-node/src/Cardano/Node/Tracing/Tracers.hs

@@ -139,7 +139,7 @@ mkDispatchTracers nodeKernel trBase trForward mbTrEKG trDataPoint trConfig enabl
                 trBase trForward mbTrEKG
                 ["Startup"]
                 namesStartupInfo
-                (const Notice)
+                severityStartupTracer
                 allPublic
     configureTracers trConfig docStartupInfo [startupTr]
 

Diff for: cardano-node/src/Cardano/Node/Tracing/Tracers/P2P.hs

@@ -691,7 +691,7 @@ instance LogFormatting (PeerSelectionActionsTrace SockAddr) where
              , "reason" .= show f
              ]
   forMachine _dtal (PeerMonitoringError connId s) =
-    mconcat [ "kind" .= String "PeerMonitoridngError"
+    mconcat [ "kind" .= String "PeerMonitoringError"
              , "connectionId" .= toJSON connId
              , "reason" .= show s
              ]

Diff for: cardano-node/src/Cardano/Tracing/OrphanInstances/Network.hs

@@ -75,7 +75,8 @@ import           Ouroboros.Network.PeerSelection.Governor (DebugPeerSelection (.
                    TracePeerSelection (..))
 import qualified Ouroboros.Network.PeerSelection.KnownPeers as KnownPeers
 import           Ouroboros.Network.PeerSelection.LedgerPeers
-import           Ouroboros.Network.PeerSelection.LocalRootPeers (LocalRootPeers, toGroupSets, toMap)
+import           Ouroboros.Network.PeerSelection.LocalRootPeers (LocalRootPeers)
+import qualified Ouroboros.Network.PeerSelection.LocalRootPeers as LocalRootPeers
 import           Ouroboros.Network.PeerSelection.PeerStateActions (PeerSelectionActionsTrace (..))
 import           Ouroboros.Network.PeerSelection.RootPeersDNS (TraceLocalRootPeers (..),
                    TracePublicRootPeers (..))
@@ -1361,7 +1362,7 @@ instance Show exception => ToObject (TraceLocalRootPeers RemoteAddress exception
              ]
 
 instance ToJSON IP where
-  toJSON ip = Aeson.object ["ip" .= String (pack . show $ ip)]
+  toJSON ip = String (pack . show $ ip)
 
 instance ToObject TracePublicRootPeers where
   toObject _verb (TracePublicRootRelayAccessPoint relays) =
@@ -1386,12 +1387,11 @@ instance ToObject TracePublicRootPeers where
 instance ToJSON PeerStatus where
   toJSON = String . pack . show
 
-instance (Aeson.ToJSONKey peerAddr, ToJSON peerAddr, Show peerAddr)
+instance (Aeson.ToJSONKey peerAddr, ToJSON peerAddr, Ord peerAddr, Show peerAddr)
   => ToJSON (LocalRootPeers peerAddr) where
   toJSON lrp =
     Aeson.object [ "kind" .= String "LocalRootPeers"
-                 , "state" .= toJSON (toMap lrp)
-                 , "groups" .= Aeson.toJSONList (toGroupSets lrp)
+                 , "groups" .= Aeson.toJSONList (LocalRootPeers.toGroups lrp)
                  ]
 
 instance ToJSON PeerSelectionTargets where
@@ -1653,7 +1653,7 @@ instance ToObject (PeerSelectionActionsTrace SockAddr) where
              , "reason" .= show f
              ]
   toObject _verb (PeerMonitoringError connId s) =
-    mconcat [ "kind" .= String "PeerMonitoridngError"
+    mconcat [ "kind" .= String "PeerMonitoringError"
              , "connectionId" .= toJSON connId
              , "reason" .= show s
              ]
@@ -1742,15 +1742,13 @@ instance ToJSON NodeToClientVersion where
 
 instance ToJSON NodeToNodeVersionData where
   toJSON (NodeToNodeVersionData (NetworkMagic m) dm) =
-    Aeson.object [ "kind" .= String "NodeToNodeVersionData"
-                 , "networkMagic" .= toJSON m
+    Aeson.object [ "networkMagic" .= toJSON m
                  , "diffusionMode" .= show dm
                  ]
 
 instance ToJSON NodeToClientVersionData where
   toJSON (NodeToClientVersionData (NetworkMagic m)) =
-    Aeson.object [ "kind" .= String "NodeToClientVersionData"
-                 , "networkMagic" .= toJSON m
+    Aeson.object [ "networkMagic" .= toJSON m
                  ]
 
 instance (Show versionNumber, ToJSON versionNumber, ToJSON agreedOptions)

Diff for: cardano-node/src/Cardano/Tracing/Startup.hs

@@ -26,6 +26,7 @@ import           Ouroboros.Consensus.Node.NetworkProtocolVersion
 
 instance HasSeverityAnnotation (StartupTrace blk) where
     getSeverityAnnotation (StartupSocketConfigError _) = Error
+    getSeverityAnnotation NetworkConfigUpdate = Notice
     getSeverityAnnotation (NetworkConfigUpdateError _) = Error
     getSeverityAnnotation NetworkConfigUpdateUnsupported = Warning
     getSeverityAnnotation P2PWarning = Warning