Skip to content

Commit 48c92ee

Browse files
jutaromgmeier
authored andcommitted
PR review fixes
1 parent 29c6650 commit 48c92ee

File tree

19 files changed

+125
-72
lines changed

19 files changed

+125
-72
lines changed

bench/tx-generator/src/Cardano/Benchmarking/Tracer.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import Cardano.Benchmarking.Version as Version
3434
import Cardano.Logging
3535
import qualified Cardano.Logging.Types as Net
3636
import Cardano.Node.Startup
37-
import Cardano.Node.Tracing.NodeInfo () -- MetaTrace NodeInfo
37+
import Cardano.Node.Tracing.NodeInfo ()
3838
import Ouroboros.Network.IOManager (IOManager)
3939

4040
import Control.Monad (forM, guard)
@@ -49,8 +49,8 @@ import qualified Data.Text as Text
4949
import Data.Time.Clock
5050
import GHC.Generics
5151

52+
import Trace.Forward.Forwarding (initForwardingDelayed)
5253
import Trace.Forward.Utils.TraceObject
53-
import Trace.Forward.Forwarding (initForwardingDelayed)
5454

5555
pattern TracerNameBench :: Text
5656
pattern TracerNameBench = "Benchmark"

cardano-node/src/Cardano/Node/Tracing/API.hs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ module Cardano.Node.Tracing.API
99
) where
1010

1111
import Cardano.Logging hiding (traceWith)
12-
import qualified Cardano.Logging.Types as Net
1312
import Cardano.Logging.Prometheus.TCPServer (runPrometheusSimple)
13+
import qualified Cardano.Logging.Types as Net
1414
import Cardano.Network.PeerSelection.PeerTrustable (PeerTrustable)
1515
import Cardano.Node.Configuration.NodeAddress (PortNumber)
1616
import Cardano.Node.Configuration.POM (NodeConfiguration (..))
@@ -51,8 +51,9 @@ import Data.Time.Clock (getCurrentTime)
5151
import Network.Mux.Trace (TraceLabelPeer (..))
5252
import Network.Socket (HostName)
5353
import System.Metrics as EKG
54-
import Trace.Forward.Forwarding (initForwardingDelayed)
55-
import Trace.Forward.Utils.TraceObject (writeToSink)
54+
55+
import Trace.Forward.Forwarding (initForwardingDelayed)
56+
import Trace.Forward.Utils.TraceObject (writeToSink)
5657

5758

5859
initTraceDispatcher ::

cardano-tracer/cardano-tracer.cabal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cabal-version: 3.0
22

33
name: cardano-tracer
4-
version: 0.3.3
4+
version: 0.3.4
55
synopsis: A service for logging and monitoring over Cardano nodes
66
description: A service for logging and monitoring over Cardano nodes.
77
category: Cardano,

cardano-tracer/src/Cardano/Tracer/Acceptors/Client.hs

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,40 @@ module Cardano.Tracer.Acceptors.Client
66

77
import Cardano.Logging (TraceObject)
88
import qualified Cardano.Logging.Types as Net
9-
import Cardano.Logging.Version (ForwardingVersion (..), ForwardingVersionData (..),
10-
forwardingCodecCBORTerm, forwardingVersionCodec)
11-
#if RTVIEW
12-
import Cardano.Tracer.Acceptors.Utils (notifyAboutNodeDisconnected,
13-
prepareDataPointRequestor, prepareMetricsStores, removeDisconnectedNode)
14-
#else
15-
import Cardano.Tracer.Acceptors.Utils (
16-
prepareDataPointRequestor, prepareMetricsStores, removeDisconnectedNode)
17-
#endif
9+
import Cardano.Tracer.Acceptors.Utils (prepareDataPointRequestor, prepareMetricsStores,
10+
removeDisconnectedNode)
1811
import qualified Cardano.Tracer.Configuration as TC
1912
import Cardano.Tracer.Environment
2013
import Cardano.Tracer.Handlers.Logs.TraceObjects (deregisterNodeId, traceObjectsHandler)
2114
import Cardano.Tracer.MetaTrace
2215
import Cardano.Tracer.Utils (connIdToNodeId)
23-
import qualified Network.Mux as Mux
2416
import Ouroboros.Network.Context (MinimalInitiatorContext (..), ResponderContext (..))
2517
import Ouroboros.Network.Driver.Limits (ProtocolTimeLimits)
2618
import Ouroboros.Network.IOManager (withIOManager)
2719
import Ouroboros.Network.Magic (NetworkMagic (..))
2820
import Ouroboros.Network.Mux (MiniProtocol (..), MiniProtocolLimits (..),
2921
MiniProtocolNum (..), OuroborosApplication (..),
30-
RunMiniProtocol (..), miniProtocolLimits, miniProtocolNum, miniProtocolRun,
31-
OuroborosApplicationWithMinimalCtx)
22+
OuroborosApplicationWithMinimalCtx, RunMiniProtocol (..), miniProtocolLimits,
23+
miniProtocolNum, miniProtocolRun)
3224
import Ouroboros.Network.Protocol.Handshake.Codec (cborTermVersionDataCodec,
33-
codecHandshake, timeLimitsHandshake, noTimeLimitsHandshake)
25+
codecHandshake, noTimeLimitsHandshake, timeLimitsHandshake)
3426
import Ouroboros.Network.Protocol.Handshake.Type (Handshake)
3527
import Ouroboros.Network.Protocol.Handshake.Version (acceptableVersion, queryVersion,
3628
simpleSingletonVersions)
3729
import Ouroboros.Network.Snocket (LocalAddress, LocalSocket, Snocket,
38-
localAddressFromPath, localSnocket, socketSnocket, makeSocketBearer, makeLocalBearer)
39-
import Ouroboros.Network.Socket (ConnectionId (..), ConnectToArgs (..),
30+
localAddressFromPath, localSnocket, makeLocalBearer, makeSocketBearer,
31+
socketSnocket)
32+
import Ouroboros.Network.Socket (ConnectToArgs (..), ConnectionId (..),
4033
HandshakeCallbacks (..), connectToNode, nullNetworkConnectTracers)
4134

4235
import Codec.CBOR.Term (Term)
4336
import Control.Exception (throwIO)
4437
import qualified Data.ByteString.Lazy as LBS
45-
import Data.List.NonEmpty (NonEmpty((:|)))
46-
import Data.Void (Void, absurd)
38+
import Data.List.NonEmpty (NonEmpty ((:|)))
4739
import qualified Data.Text as Text
40+
import Data.Void (Void, absurd)
4841
import Data.Word (Word32)
42+
import qualified Network.Mux as Mux
4943
import qualified Network.Socket as Socket
5044
import qualified System.Metrics.Configuration as EKGF
5145
import System.Metrics.Network.Acceptor (acceptEKGMetricsInit)
@@ -54,6 +48,8 @@ import qualified Trace.Forward.Configuration.DataPoint as DPF
5448
import qualified Trace.Forward.Configuration.TraceObject as TF
5549
import Trace.Forward.Run.DataPoint.Acceptor (acceptDataPointsInit)
5650
import Trace.Forward.Run.TraceObject.Acceptor (acceptTraceObjectsInit)
51+
import Trace.Forward.Utils.Version (ForwardingVersion (..), ForwardingVersionData (..),
52+
forwardingCodecCBORTerm, forwardingVersionCodec)
5753

5854
runAcceptorsClient
5955
:: TracerEnv

cardano-tracer/src/Cardano/Tracer/Acceptors/Server.hs

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,42 @@ module Cardano.Tracer.Acceptors.Server
66

77
import Cardano.Logging (TraceObject)
88
import qualified Cardano.Logging.Types as Net
9-
import Cardano.Logging.Version (ForwardingVersion (..), ForwardingVersionData (..),
10-
forwardingCodecCBORTerm, forwardingVersionCodec)
11-
#if RTVIEW
12-
import Cardano.Tracer.Acceptors.Utils (notifyAboutNodeDisconnected,
13-
prepareDataPointRequestor, prepareMetricsStores, removeDisconnectedNode)
14-
#else
159
import Cardano.Tracer.Acceptors.Utils (prepareDataPointRequestor, prepareMetricsStores,
1610
removeDisconnectedNode)
17-
#endif
1811
import qualified Cardano.Tracer.Configuration as TC
1912
import Cardano.Tracer.Environment
2013
import Cardano.Tracer.Handlers.Logs.TraceObjects (deregisterNodeId, traceObjectsHandler)
2114
import Cardano.Tracer.MetaTrace
2215
import Cardano.Tracer.Utils (connIdToNodeId)
23-
import qualified Network.Mux as Mux
2416
import Ouroboros.Network.Context (MinimalInitiatorContext (..), ResponderContext (..))
2517
import Ouroboros.Network.Driver.Limits (ProtocolTimeLimits)
2618
import Ouroboros.Network.ErrorPolicy (nullErrorPolicies)
2719
import Ouroboros.Network.IOManager (withIOManager)
2820
import Ouroboros.Network.Magic (NetworkMagic (..))
2921
import Ouroboros.Network.Mux (MiniProtocol (..), MiniProtocolLimits (..),
3022
MiniProtocolNum (..), OuroborosApplication (..),
31-
RunMiniProtocol (..), OuroborosApplicationWithMinimalCtx,
32-
miniProtocolLimits, miniProtocolNum, miniProtocolRun)
23+
OuroborosApplicationWithMinimalCtx, RunMiniProtocol (..), miniProtocolLimits,
24+
miniProtocolNum, miniProtocolRun)
3325
import Ouroboros.Network.Protocol.Handshake.Codec (cborTermVersionDataCodec,
3426
codecHandshake, noTimeLimitsHandshake, timeLimitsHandshake)
3527
import Ouroboros.Network.Protocol.Handshake.Type (Handshake)
3628
import Ouroboros.Network.Protocol.Handshake.Version (acceptableVersion, queryVersion,
3729
simpleSingletonVersions)
3830
import Ouroboros.Network.Snocket (LocalAddress, LocalSocket, Snocket,
39-
localAddressFromPath, localSnocket, socketSnocket, makeSocketBearer, makeLocalBearer)
31+
localAddressFromPath, localSnocket, makeLocalBearer, makeSocketBearer,
32+
socketSnocket)
4033
import Ouroboros.Network.Socket (AcceptedConnectionsLimit (..), ConnectionId (..),
4134
HandshakeCallbacks (..), SomeResponderApplication (..), cleanNetworkMutableState,
4235
newNetworkMutableState, nullNetworkServerTracers, withServerNode)
4336

4437
import Codec.CBOR.Term (Term)
4538
import Control.Concurrent.Async (race_, wait)
4639
import qualified Data.ByteString.Lazy as LBS
47-
import Data.List.NonEmpty (NonEmpty((:|)))
40+
import Data.List.NonEmpty (NonEmpty ((:|)))
4841
import qualified Data.Text as Text
4942
import Data.Void (Void)
5043
import Data.Word (Word32)
44+
import qualified Network.Mux as Mux
5145
import qualified Network.Socket as Socket
5246
import qualified System.Metrics.Configuration as EKGF
5347
import System.Metrics.Network.Acceptor (acceptEKGMetricsResp)
@@ -56,6 +50,8 @@ import qualified Trace.Forward.Configuration.DataPoint as DPF
5650
import qualified Trace.Forward.Configuration.TraceObject as TF
5751
import Trace.Forward.Run.DataPoint.Acceptor (acceptDataPointsResp)
5852
import Trace.Forward.Run.TraceObject.Acceptor (acceptTraceObjectsResp)
53+
import Trace.Forward.Utils.Version (ForwardingVersion (..), ForwardingVersionData (..),
54+
forwardingCodecCBORTerm, forwardingVersionCodec)
5955

6056

6157
runAcceptorsServer

cardano-tracer/src/Cardano/Tracer/Handlers/ReForwarder.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ module Cardano.Tracer.Handlers.ReForwarder
1515
( initReForwarder
1616
) where
1717

18-
import Trace.Forward.Forwarding
1918
import Cardano.Logging.Trace
2019
import Cardano.Logging.Tracer.DataPoint
2120
import qualified Cardano.Logging.Types as Log
@@ -29,8 +28,9 @@ import Control.Monad (when)
2928
import Data.List (isPrefixOf)
3029
import qualified Data.Text as Text
3130

31+
import Trace.Forward.Forwarding
32+
import Trace.Forward.Utils.ForwardSink (ForwardSink)
3233
import Trace.Forward.Utils.TraceObject (writeToSink)
33-
import Trace.Forward.Utils.ForwardSink (ForwardSink)
3434

3535
-- | Initialize the reforwarding service if configured to be active.
3636
-- Returns

cardano-tracer/test/Cardano/Tracer/Test/Forwarder.hs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ module Cardano.Tracer.Test.Forwarder
1818
import Cardano.Logging (DetailLevel (..), SeverityS (..), TraceObject (..))
1919
import Cardano.Logging.Types (HowToConnect)
2020
import qualified Cardano.Logging.Types as Net
21-
import Cardano.Logging.Version (ForwardingVersion (..), ForwardingVersionData (..),
22-
forwardingCodecCBORTerm, forwardingVersionCodec)
2321
import Cardano.Tracer.Configuration (Verbosity (..))
2422
import Cardano.Tracer.Test.TestSetup
2523
import Cardano.Tracer.Test.Utils
@@ -36,7 +34,7 @@ import Ouroboros.Network.Protocol.Handshake.Type (Handshake)
3634
import Ouroboros.Network.Protocol.Handshake.Version (acceptableVersion, queryVersion,
3735
simpleSingletonVersions)
3836
import Ouroboros.Network.Snocket (MakeBearer, Snocket, localAddressFromPath, localSnocket,
39-
makeLocalBearer, socketSnocket, makeSocketBearer)
37+
makeLocalBearer, makeSocketBearer, socketSnocket)
4038
import Ouroboros.Network.Socket (AcceptedConnectionsLimit (..), ConnectToArgs (..),
4139
HandshakeCallbacks (..), SomeResponderApplication (..), cleanNetworkMutableState,
4240
connectToNode, newNetworkMutableState, nullNetworkConnectTracers,
@@ -52,7 +50,7 @@ import "contra-tracer" Control.Tracer (contramap, nullTracer, stdoutTr
5250
import Data.Aeson (FromJSON, ToJSON)
5351
import qualified Data.ByteString.Lazy as LBS
5452
import Data.Foldable (for_)
55-
import Data.List.NonEmpty (NonEmpty((:|)))
53+
import Data.List.NonEmpty (NonEmpty ((:|)))
5654
import qualified Data.Text as Text
5755
import Data.Time.Clock (getCurrentTime)
5856
import Data.Void (Void, absurd)
@@ -70,8 +68,10 @@ import qualified Trace.Forward.Configuration.TraceObject as TOF
7068
import Trace.Forward.Run.DataPoint.Forwarder
7169
import Trace.Forward.Run.TraceObject.Forwarder
7270
import Trace.Forward.Utils.DataPoint
71+
import Trace.Forward.Utils.ForwardSink (ForwardSink)
7372
import Trace.Forward.Utils.TraceObject
74-
import Trace.Forward.Utils.ForwardSink (ForwardSink)
73+
import Trace.Forward.Utils.Version (ForwardingVersion (..), ForwardingVersionData (..),
74+
forwardingCodecCBORTerm, forwardingVersionCodec)
7575

7676
data ForwardersMode = Initiator | Responder
7777

cardano-tracer/test/cardano-tracer-test-ext.hs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ import qualified System.Process as Sys
2929

3030
import Test.Tasty
3131
import Test.Tasty.QuickCheck
32-
import Trace.Forward.Forwarding (initForwarding)
33-
import Trace.Forward.Utils.TraceObject (writeToSink)
32+
33+
import Trace.Forward.Forwarding (initForwarding)
34+
import Trace.Forward.Utils.TraceObject (writeToSink)
3435

3536
main :: IO ()
3637
main = do

trace-dispatcher/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
## 2.10.0 -- July, 2025
44
* Forwarding protocol supports connections over TCP socket, in addition to Unix domain sockets.
55
* Failure to initialise the `PrometheusSimple` backend is now lenient - i.e., won't result in an exception being propagated.
6+
* `trace-forward` now depends on `trace-dispatcher`, and not the other way round.
7+
* Improves the structure and metadata of generated tracer documentation.
68

79
## 2.9.2 -- May 2025
810
* New config field `traceOptionLedgerMetricsFrequency`.

trace-dispatcher/src/Cardano/Logging/Tracer/DataPoint.hs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
{-# LANGUAGE GADTs #-}
44
{-# LANGUAGE RecordWildCards #-}
55
{-# LANGUAGE ScopedTypeVariables #-}
6-
{-# LANGUAGE GADTs #-}
76

87
module Cardano.Logging.Tracer.DataPoint
98
(

0 commit comments

Comments
 (0)