Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Node.Configuration.Logging

Synopsis

data LoggingLayer = LoggingLayer {
- llBasicTrace :: forall m. MonadIO m => Trace m Text
- llLogDebug :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
- llLogInfo :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
- llLogNotice :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
- llLogWarning :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
- llLogError :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
- llAppendName :: forall m a. Show a => LoggerName -> Trace m a -> Trace m a
- llBracketMonadIO :: forall a t. Show a => Trace IO a -> Severity -> Text -> IO t -> IO t
- llBracketMonadM :: forall m a t. (MonadCatch m, MonadIO m, Show a) => Trace m a -> Severity -> Text -> m t -> m t
- llBracketMonadX :: forall m a t. (MonadIO m, Show a) => Trace m a -> Severity -> Text -> m t -> m t
- llBracketStmIO :: forall a t. Show a => Trace IO a -> Severity -> Text -> STM t -> IO t
- llBracketStmLogIO :: forall a t. Show a => Trace IO a -> Severity -> Text -> STM (t, [(LOMeta, LOContent a)]) -> IO t
- llConfiguration :: Configuration
- llAddBackend :: Backend Text -> BackendKind -> IO ()
- llSwitchboard :: Switchboard Text
- llEKGDirect :: Maybe EKGDirect
}
data EKGDirect = EKGDirect {
- ekgServer :: Server
- ekgGauges :: MVar (Map Text Gauge)
- ekgLabels :: MVar (Map Text Label)
- ekgCounters :: MVar (Map Text Counter)
}
createLoggingLayer :: Text -> NodeConfiguration -> SomeConsensusProtocol -> ExceptT ConfigError IO LoggingLayer
nodeBasicInfo :: NodeConfiguration -> SomeConsensusProtocol -> UTCTime -> IO [LogObject Text]
shutdownLoggingLayer :: LoggingLayer -> IO ()
traceCounter :: Text -> Trace IO Text -> Int -> IO ()
type Trace (m :: Type -> Type) a = Tracer m (LoggerName, LogObject a)
data Configuration
type LoggerName = Text
data Severity
- = Debug
- | Info
- | Notice
- | Warning
- | Error
- | Critical
- | Alert
- | Emergency
mkLOMeta :: MonadIO m => Severity -> PrivacyAnnotation -> m LOMeta
data LOMeta = LOMeta {
- tstamp :: !UTCTime
- tid :: !Text
- hostname :: !Text
- severity :: !Severity
- privacy :: !PrivacyAnnotation
}
data LOContent a
- = LogMessage a
- | LogError !Text
- | LogValue !Text !Measurable
- | LogStructuredText Object Text
- | LogStructured Object
- | ObserveOpen !CounterState
- | ObserveDiff !CounterState
- | ObserveClose !CounterState
- | AggregatedMessage [(Text, Aggregated)]
- | MonitoringEffect !MonitorAction
- | Command !CommandValue
- | KillPill

Documentation

data LoggingLayer Source #

The LoggingLayer interface that we can expose. We want to do this since we want to be able to mock out any function tied to logging.

The good side of this is that _each function has it's own effects_ and that is ideal for tracking the functions effects and constraining the user (programmer) of those function to use specific effects in them. https://github.com/input-output-hk/cardano-sl/blob/develop/util/src/Pos/Util/Log/LogSafe.hs

Constructors

LoggingLayer

Fields

llBasicTrace :: forall m. MonadIO m => Trace m Text
llLogDebug :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
llLogInfo :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
llLogNotice :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
llLogWarning :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
llLogError :: forall m a. (MonadIO m, Show a) => Trace m a -> a -> m ()
llAppendName :: forall m a. Show a => LoggerName -> Trace m a -> Trace m a
llBracketMonadIO :: forall a t. Show a => Trace IO a -> Severity -> Text -> IO t -> IO t
llBracketMonadM :: forall m a t. (MonadCatch m, MonadIO m, Show a) => Trace m a -> Severity -> Text -> m t -> m t
llBracketMonadX :: forall m a t. (MonadIO m, Show a) => Trace m a -> Severity -> Text -> m t -> m t
llBracketStmIO :: forall a t. Show a => Trace IO a -> Severity -> Text -> STM t -> IO t
llBracketStmLogIO :: forall a t. Show a => Trace IO a -> Severity -> Text -> STM (t, [(LOMeta, LOContent a)]) -> IO t
llConfiguration :: Configuration
llAddBackend :: Backend Text -> BackendKind -> IO ()
llSwitchboard :: Switchboard Text
llEKGDirect :: Maybe EKGDirect

data EKGDirect Source #

Constructors

EKGDirect
Fields ekgServer :: Server ekgGauges :: MVar (Map Text Gauge) ekgLabels :: MVar (Map Text Label) ekgCounters :: MVar (Map Text Counter)

createLoggingLayer :: Text -> NodeConfiguration -> SomeConsensusProtocol -> ExceptT ConfigError IO LoggingLayer Source #

Create logging feature for `cardano-node`

nodeBasicInfo :: NodeConfiguration -> SomeConsensusProtocol -> UTCTime -> IO [LogObject Text] Source #

shutdownLoggingLayer :: LoggingLayer -> IO () Source #

traceCounter :: Text -> Trace IO Text -> Int -> IO () Source #

type Trace (m :: Type -> Type) a = Tracer m (LoggerName, LogObject a) #

data Configuration #

type LoggerName = Text #

data Severity #

Constructors

Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency

Instances

Instances details

FromJSON Severity
Instance details Defined in Cardano.BM.Data.Severity Methods parseJSON :: Value -> Parser Severity parseJSONList :: Value -> Parser [Severity] omittedField :: Maybe Severity
ToJSON Severity
Instance details Defined in Cardano.BM.Data.Severity Methods toJSON :: Severity -> Value # toEncoding :: Severity -> Encoding toJSONList :: [Severity] -> Value toEncodingList :: [Severity] -> Encoding omitField :: Severity -> Bool
Monoid Severity
Instance details Defined in Cardano.BM.Data.Severity Methods mempty :: Severity Source # mappend :: Severity -> Severity -> Severity Source # mconcat :: [Severity] -> Severity Source #
Semigroup Severity
Instance details Defined in Cardano.BM.Data.Severity Methods (<>) :: Severity -> Severity -> Severity Source # sconcat :: NonEmpty Severity -> Severity Source # stimes :: Integral b => b -> Severity -> Severity Source #
Bounded Severity
Instance details Defined in Cardano.BM.Data.Severity Methods minBound :: Severity Source # maxBound :: Severity Source #
Enum Severity
Instance details Defined in Cardano.BM.Data.Severity Methods succ :: Severity -> Severity Source # pred :: Severity -> Severity Source # toEnum :: Int -> Severity Source # fromEnum :: Severity -> Int Source # enumFrom :: Severity -> [Severity] Source # enumFromThen :: Severity -> Severity -> [Severity] Source # enumFromTo :: Severity -> Severity -> [Severity] Source # enumFromThenTo :: Severity -> Severity -> Severity -> [Severity] Source #
Generic Severity
Instance details Defined in Cardano.BM.Data.Severity Associated Types type Rep Severity :: Type -> Type Source # Methods from :: Severity -> Rep Severity x Source # to :: Rep Severity x -> Severity Source #
Read Severity
Instance details Defined in Cardano.BM.Data.Severity Methods readsPrec :: Int -> ReadS Severity Source # readList :: ReadS [Severity] Source # readPrec :: ReadPrec Severity Source # readListPrec :: ReadPrec [Severity] Source #
Show Severity
Instance details Defined in Cardano.BM.Data.Severity Methods showsPrec :: Int -> Severity -> ShowS Source # show :: Severity -> String Source # showList :: [Severity] -> ShowS Source #
Eq Severity
Instance details Defined in Cardano.BM.Data.Severity Methods (==) :: Severity -> Severity -> Bool Source # (/=) :: Severity -> Severity -> Bool Source #
Ord Severity
Instance details Defined in Cardano.BM.Data.Severity Methods compare :: Severity -> Severity -> Ordering Source # (<) :: Severity -> Severity -> Bool Source # (<=) :: Severity -> Severity -> Bool Source # (>) :: Severity -> Severity -> Bool Source # (>=) :: Severity -> Severity -> Bool Source # max :: Severity -> Severity -> Severity Source # min :: Severity -> Severity -> Severity Source #
type Rep Severity
Instance details Defined in Cardano.BM.Data.Severity type Rep Severity = D1 ('MetaData "Severity" "Cardano.BM.Data.Severity" "iohk-monitoring-0.1.11.3-Lgd0soWIbRgDCCI8t5ovvD" 'False) (((C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Notice" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Warning" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Critical" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Alert" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Emergency" 'PrefixI 'False) (U1 :: Type -> Type))))

mkLOMeta :: MonadIO m => Severity -> PrivacyAnnotation -> m LOMeta #

data LOMeta #

Constructors

LOMeta
Fields tstamp :: !UTCTime tid :: !Text hostname :: !Text severity :: !Severity privacy :: !PrivacyAnnotation

Instances

Instances details

FromJSON LOMeta
Instance details Defined in Cardano.BM.Data.LogItem Methods parseJSON :: Value -> Parser LOMeta parseJSONList :: Value -> Parser [LOMeta] omittedField :: Maybe LOMeta
ToJSON LOMeta
Instance details Defined in Cardano.BM.Data.LogItem Methods toJSON :: LOMeta -> Value # toEncoding :: LOMeta -> Encoding toJSONList :: [LOMeta] -> Value toEncodingList :: [LOMeta] -> Encoding omitField :: LOMeta -> Bool
Show LOMeta
Instance details Defined in Cardano.BM.Data.LogItem Methods showsPrec :: Int -> LOMeta -> ShowS Source # show :: LOMeta -> String Source # showList :: [LOMeta] -> ShowS Source #
Eq LOMeta
Instance details Defined in Cardano.BM.Data.LogItem Methods (==) :: LOMeta -> LOMeta -> Bool Source # (/=) :: LOMeta -> LOMeta -> Bool Source #

data LOContent a #

Constructors

LogMessage a
LogError !Text
LogValue !Text !Measurable
LogStructuredText Object Text
LogStructured Object
ObserveOpen !CounterState
ObserveDiff !CounterState
ObserveClose !CounterState
AggregatedMessage [(Text, Aggregated)]
MonitoringEffect !MonitorAction
Command !CommandValue
KillPill

Instances

Instances details

FromJSON a => FromJSON (LOContent a)
Instance details Defined in Cardano.BM.Data.LogItem Methods parseJSON :: Value -> Parser (LOContent a) parseJSONList :: Value -> Parser [LOContent a] omittedField :: Maybe (LOContent a)
ToJSON a => ToJSON (LOContent a)
Instance details Defined in Cardano.BM.Data.LogItem Methods toJSON :: LOContent a -> Value # toEncoding :: LOContent a -> Encoding toJSONList :: [LOContent a] -> Value toEncodingList :: [LOContent a] -> Encoding omitField :: LOContent a -> Bool
Show a => Show (LOContent a)
Instance details Defined in Cardano.BM.Data.LogItem Methods showsPrec :: Int -> LOContent a -> ShowS Source # show :: LOContent a -> String Source # showList :: [LOContent a] -> ShowS Source #
Eq a => Eq (LOContent a)
Instance details Defined in Cardano.BM.Data.LogItem Methods (==) :: LOContent a -> LOContent a -> Bool Source # (/=) :: LOContent a -> LOContent a -> Bool Source #
ToJSON a => ToObject (LOContent a)
Instance details Defined in Cardano.BM.Data.Tracer Methods toObject :: TracingVerbosity -> LOContent a -> Object # textTransformer :: LOContent a -> Object -> Text #