Skip to content

Commit 121826b

Browse files
jutarojutaro
committed
trace-dispatcher: Review fixes2
1 parent 24938d2 commit 121826b

File tree

7 files changed

+43
-39
lines changed

7 files changed

+43
-39
lines changed

‎cardano-node/src/Cardano/Node/Tracing/Documentation.hs‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@
77
{-# LANGUAGE RecordWildCards #-}
88
{-# LANGUAGE ScopedTypeVariables #-}
99
{-# LANGUAGE StandaloneDeriving #-}
10+
{-# LANGUAGE TemplateHaskell #-}
1011
{-# LANGUAGE TypeOperators #-}
12+
1113
{-# OPTIONS_GHC -Wno-orphans #-}
12-
{-# LANGUAGE TemplateHaskell #-}
1314

1415
module Cardano.Node.Tracing.Documentation
1516
( TraceDocumentationCmd (..)
@@ -19,7 +20,7 @@ module Cardano.Node.Tracing.Documentation
1920
, docTracersFirstPhase
2021
) where
2122

22-
import Cardano.Node.Tracing.NodeStartupInfo () -- MetaTrace NodeVersionTrace
23+
import Cardano.Git.Rev (gitRev)
2324
import Cardano.Logging as Logging
2425
import Cardano.Logging.Resources
2526
import Cardano.Logging.Resources.Types ()
@@ -30,6 +31,7 @@ import Cardano.Node.TraceConstraints
3031
import Cardano.Node.Tracing.DefaultTraceConfig (defaultCardanoConfig)
3132
import Cardano.Node.Tracing.Formatting ()
3233
import Cardano.Node.Tracing.NodeInfo ()
34+
import Cardano.Node.Tracing.NodeStartupInfo ()
3335
import qualified Cardano.Node.Tracing.StateRep as SR
3436
import Cardano.Node.Tracing.Tracers.BlockReplayProgress
3537
import Cardano.Node.Tracing.Tracers.ChainDB
@@ -112,17 +114,17 @@ import Control.Exception (SomeException)
112114
import Control.Monad (forM_)
113115
import Data.Aeson.Types (ToJSON)
114116
import Data.Proxy (Proxy (..))
117+
import Data.Text (pack)
115118
import qualified Data.Text.IO as T
119+
import Data.Time (getZonedTime)
120+
import Data.Version (showVersion)
116121
import GHC.Generics (Generic)
117122
import qualified Network.Mux as Mux
118123
import qualified Network.Socket as Socket
119124
import qualified Options.Applicative as Opt
120125
import System.IO
121-
import Data.Time (getZonedTime)
122-
import Data.Text (pack)
123-
import Cardano.Git.Rev (gitRev)
124-
import Paths_cardano_node (version)
125-
import Data.Version (showVersion)
126+
127+
import Paths_cardano_node (version)
126128

127129

128130
data TraceDocumentationCmd
@@ -848,7 +850,7 @@ docTracersSecondPhase ::
848850
-> DocTracer
849851
-> IO ()
850852
docTracersSecondPhase outputFileName mbMetricsHelpFilename trConfig bl = do
851-
text <- docuResultsToText bl trConfig
853+
let text = docuResultsToText bl trConfig
852854
time <- getZonedTime
853855
let stamp = "Generated at "
854856
<> pack (show time)

‎trace-dispatcher/src/Cardano/Logging/DocuGenerator.hs‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ module Cardano.Logging.DocuGenerator (
2626

2727
import Cardano.Logging.ConfigurationParser ()
2828
import Cardano.Logging.DocuGenerator.Tree
29-
import Cardano.Logging.DocuResult (DocuResult (..))
30-
import qualified Cardano.Logging.DocuResult as DocuResult
29+
import Cardano.Logging.DocuGenerator.Result (DocuResult (..))
30+
import qualified Cardano.Logging.DocuGenerator.Result as DocuResult
3131
import Cardano.Logging.Types
3232

3333
import Prelude hiding (lines, unlines)
@@ -431,8 +431,8 @@ docItDatapoint _backend (LoggingContext {}, _) = pure ()
431431

432432

433433
-- Finally generate a text from all the builders
434-
docuResultsToText :: DocTracer -> TraceConfig -> IO Text
435-
docuResultsToText dt@DocTracer {..} configuration = do
434+
docuResultsToText :: DocTracer -> TraceConfig -> Text
435+
docuResultsToText dt@DocTracer {..} configuration =
436436
let traceBuilders = sortBy (\ (l,_) (r,_) -> compare l r)
437437
(filter (DocuResult.isTracer . snd) dtBuilderList)
438438
metricsBuilders = sortBy (\ (l,_) (r,_) -> compare l r)
@@ -464,20 +464,20 @@ docuResultsToText dt@DocTracer {..} configuration = do
464464

465465
legend = fromText $ utf16CircledT <> "- This is the root of a tracer\n\n" <>
466466
utf16CircledS <> "- This is the root of a tracer that is silent because of the current configuration\n\n" <>
467-
utf16CircledM <> "- This is the root of a tracer, that provides metrics\n\n"
468-
pure $ toStrict $ toLazyText (
469-
header
470-
<> header1
471-
<> toc
472-
<> header2
473-
<> contentT
474-
<> header3
475-
<> contentM
476-
<> header4
477-
<> contentD
478-
<> config
479-
<> numbers
480-
<> legend)
467+
utf16CircledM <> "- This is the root of a tracer, that provides metrics\n\n" in
468+
toStrict $ toLazyText $
469+
header
470+
<> header1
471+
<> toc
472+
<> header2
473+
<> contentT
474+
<> header3
475+
<> contentM
476+
<> header4
477+
<> contentD
478+
<> config
479+
<> numbers
480+
<> legend
481481

482482
generateTOC :: DocTracer -> [[Text]] -> [[Text]] -> [[Text]] -> Builder
483483
generateTOC DocTracer {..} traces metrics datapoints =

trace-dispatcher/src/Cardano/Logging/DocuResult.hs renamed to trace-dispatcher/src/Cardano/Logging/DocuGenerator/Result.hs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
module Cardano.Logging.DocuResult
2-
(DocuResult(..)
3-
, unpackDocu
4-
, isTracer
5-
, isMetric
6-
, isDatapoint)
7-
where
1+
module Cardano.Logging.DocuGenerator.Result (DocuResult(..), unpackDocu, isTracer, isMetric, isDatapoint) where
82

93
import Data.Text.Internal.Builder
104

‎trace-dispatcher/src/Cardano/Logging/Types.hs‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
{-# LANGUAGE StandaloneKindSignatures #-}
21
{-# LANGUAGE DeriveAnyClass #-}
32
{-# LANGUAGE DeriveGeneric #-}
43
{-# LANGUAGE DerivingStrategies #-}
54
{-# LANGUAGE GADTs #-}
65
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
76
{-# LANGUAGE RankNTypes #-}
7+
{-# LANGUAGE RecordWildCards #-}
88
{-# LANGUAGE ScopedTypeVariables #-}
9+
{-# LANGUAGE StandaloneKindSignatures #-}
910

1011
{-# OPTIONS_GHC -Wno-partial-fields #-}
1112

@@ -66,9 +67,9 @@ import qualified Control.Tracer as T
6667
import qualified Data.Aeson as AE
6768
import qualified Data.Aeson.Encoding as AE
6869
import Data.Bool (bool)
69-
import Data.Kind (Type)
7070
import qualified Data.HashMap.Strict as HM
7171
import Data.IORef
72+
import Data.Kind (Type)
7273
import Data.Map.Strict (Map)
7374
import qualified Data.Map.Strict as Map
7475
import Data.Set (Set)
@@ -493,7 +494,6 @@ data TraceOptionForwarder = TraceOptionForwarder {
493494
, tofVerbosity :: Verbosity
494495
, tofMaxReconnectDelay :: Word
495496
} deriving stock (Eq, Ord, Show, Generic)
496-
deriving anyclass AE.ToJSON
497497

498498
-- A word regarding queue sizes:
499499
-- In case of a missing forwarding service consumer, traces messages will be
@@ -520,6 +520,15 @@ instance AE.FromJSON TraceOptionForwarder where
520520
parseJSON _ = mempty
521521

522522

523+
instance AE.ToJSON TraceOptionForwarder where
524+
toJSON TraceOptionForwarder{..} = AE.object
525+
[
526+
"connQueueSize" AE..= tofConnQueueSize,
527+
"disconnQueueSize" AE..= tofDisconnQueueSize,
528+
"verbosity" AE..= tofVerbosity,
529+
"maxReconnectDelay" AE..= tofMaxReconnectDelay
530+
]
531+
523532
defaultForwarder :: TraceOptionForwarder
524533
defaultForwarder = TraceOptionForwarder {
525534
tofConnQueueSize = 1024

‎trace-dispatcher/src/Cardano/Logging/Utils.hs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ module Cardano.Logging.Utils
33
where
44

55
import Cardano.Logging.Types (HowToConnect)
6-
76
import Control.Concurrent (threadDelay)
87
import Control.Exception (SomeAsyncException (..), fromException, tryJust)
98
import Control.Tracer (stdoutTracer, traceWith)

‎trace-dispatcher/test/Cardano/Logging/Test/Unit/Documentation.hs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ docTracers = do
2525
configureTracers confState config1 [t1, t2]
2626
b1 <- documentTracer (t1 :: Trace IO (TraceForgeEvent LogBlock))
2727
b2 <- documentTracer (t2 :: Trace IO (TraceForgeEvent LogBlock))
28-
docuResultsToText (b1 <> b2) config1
28+
pure (docuResultsToText (b1 <> b2) config1)
2929

3030
config1 :: TraceConfig
3131
config1 = TraceConfig {

‎trace-dispatcher/trace-dispatcher.cabal‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ library
4646
Cardano.Logging.ConfigurationParser
4747
Cardano.Logging.Consistency
4848
Cardano.Logging.DocuGenerator
49+
Cardano.Logging.DocuGenerator.Result
4950
Cardano.Logging.DocuGenerator.Tree
50-
Cardano.Logging.DocuResult
5151
Cardano.Logging.Formatter
5252
Cardano.Logging.Forwarding
5353
Cardano.Logging.FrequencyLimiter

0 commit comments

Comments
 (0)