Safe Haskell	Safe-Inferred
Language	Haskell2010

Hermod.Tracing.Formatter

Synopsis

data FormattedMessage
- = FormattedHuman Bool Text
- | FormattedMachine Text
- | FormattedMetrics [Metric]
- | FormattedForwarder TraceObject
- | FormattedCBOR ByteString
data PreFormatted = PreFormatted {
- pfTime :: !UTCTime
- pfNamespace :: !Text
- pfThreadId :: !Text
- pfForHuman :: !(Maybe Text)
- pfForMachineObject :: Object
}
data TraceObject = TraceObject {
- toHuman :: !(Maybe Text)
- toMachine :: !Text
- toNamespace :: ![Text]
- toSeverity :: !SeverityS
- toDetails :: !DetailLevel
- toTimestamp :: !UTCTime
- toHostname :: !Text
- toThreadId :: !Text
}
metricsFormatter :: forall a m. (LogFormatting a, MonadIO m) => Trace m FormattedMessage -> Trace m a
preFormatted :: (LogFormatting a, MonadIO m) => Bool -> Trace m PreFormatted -> Trace m a
forwardFormatter :: forall a m. (MonadIO m, LogFormatting a) => Trace m FormattedMessage -> Trace m a
forwardFormatter' :: forall m. MonadIO m => Trace m FormattedMessage -> Trace m PreFormatted
machineFormatter :: forall a m. (MonadIO m, LogFormatting a) => Trace m FormattedMessage -> Trace m a
machineFormatter' :: forall m. MonadIO m => Trace m FormattedMessage -> Trace m PreFormatted
cborFormatter :: forall a m. (MonadIO m, LogFormatting a) => Trace m FormattedMessage -> Trace m a
cborFormatter' :: forall m. MonadIO m => Trace m FormattedMessage -> Trace m PreFormatted
humanFormatter :: forall a m. (MonadIO m, LogFormatting a) => Bool -> Trace m FormattedMessage -> Trace m a
humanFormatter' :: forall m. MonadIO m => Bool -> Trace m FormattedMessage -> Trace m PreFormatted

Documentation

data FormattedMessage Source #

Constructors

FormattedHuman Bool Text	The bool specifies if the formatting includes colours
FormattedMachine Text
FormattedMetrics [Metric]
FormattedForwarder TraceObject
FormattedCBOR ByteString

Instances

Instances details

Show FormattedMessage Source #
Instance details Defined in Hermod.Tracing.Formatter Methods showsPrec :: Int -> FormattedMessage -> ShowS Source # show :: FormattedMessage -> String Source # showList :: [FormattedMessage] -> ShowS Source #
Eq FormattedMessage Source #
Instance details Defined in Hermod.Tracing.Formatter Methods (==) :: FormattedMessage -> FormattedMessage -> Bool Source # (/=) :: FormattedMessage -> FormattedMessage -> Bool Source #

data PreFormatted Source #

Constructors

PreFormatted
Fields pfTime :: !UTCTime pfNamespace :: !Text pfThreadId :: !Text pfForHuman :: !(Maybe Text) pfForMachineObject :: Object

data TraceObject Source #

Used as interface object for ForwarderTracer

Constructors

TraceObject
Fields toHuman :: !(Maybe Text) toMachine :: !Text toNamespace :: ![Text] toSeverity :: !SeverityS toDetails :: !DetailLevel toTimestamp :: !UTCTime toHostname :: !Text toThreadId :: !Text

Instances

Instances details

Generic TraceObject Source #
Instance details Defined in Hermod.Tracing.Formatter Associated Types type Rep TraceObject :: Type -> Type Source # Methods from :: TraceObject -> Rep TraceObject x Source # to :: Rep TraceObject x -> TraceObject Source #
Show TraceObject Source #
Instance details Defined in Hermod.Tracing.Formatter Methods showsPrec :: Int -> TraceObject -> ShowS Source # show :: TraceObject -> String Source # showList :: [TraceObject] -> ShowS Source #
NFData TraceObject Source #
Instance details Defined in Hermod.Tracing.Formatter Methods rnf :: TraceObject -> () Source #
Eq TraceObject Source #
Instance details Defined in Hermod.Tracing.Formatter Methods (==) :: TraceObject -> TraceObject -> Bool Source # (/=) :: TraceObject -> TraceObject -> Bool Source #
Serialise TraceObject Source #
Instance details Defined in Hermod.Tracing.Formatter Methods encode :: TraceObject -> Encoding decode :: Decoder s TraceObject encodeList :: [TraceObject] -> Encoding decodeList :: Decoder s [TraceObject]
type Rep TraceObject Source #	Instances for `TraceObject` to forward it using 'trace-forward' library.
Instance details Defined in Hermod.Tracing.Formatter type Rep TraceObject = D1 ('MetaData "TraceObject" "Hermod.Tracing.Formatter" "hermod-tracing-core-1.0.0-3AGmFuCq3qp5M1u5yyD0b6" 'False) (C1 ('MetaCons "TraceObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "toHuman") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "toMachine") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "toNamespace") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "toSeverity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SeverityS))) :: ((S1 ('MetaSel ('Just "toDetails") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DetailLevel) :: S1 ('MetaSel ('Just "toTimestamp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime)) :: (S1 ('MetaSel ('Just "toHostname") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "toThreadId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))))

metricsFormatter :: forall a m. (LogFormatting a, MonadIO m) => Trace m FormattedMessage -> Trace m a Source #

Format this trace as metrics

preFormatted :: (LogFormatting a, MonadIO m) => Bool -> Trace m PreFormatted -> Trace m a Source #

Transform this trace to a preformatted message, so that double serialization is avoided

forwardFormatter :: forall a m. (MonadIO m, LogFormatting a) => Trace m FormattedMessage -> Trace m a Source #

forwardFormatter' :: forall m. MonadIO m => Trace m FormattedMessage -> Trace m PreFormatted Source #

Format this trace as TraceObject for the trace forwarder

machineFormatter :: forall a m. (MonadIO m, LogFormatting a) => Trace m FormattedMessage -> Trace m a Source #

machineFormatter' :: forall m. MonadIO m => Trace m FormattedMessage -> Trace m PreFormatted Source #

Format this trace as TraceObject for machine-readable text output (JSON)

cborFormatter :: forall a m. (MonadIO m, LogFormatting a) => Trace m FormattedMessage -> Trace m a Source #

cborFormatter' :: forall m. MonadIO m => Trace m FormattedMessage -> Trace m PreFormatted Source #

Format this trace in binary serialisation (CBOR)

humanFormatter :: forall a m. (MonadIO m, LogFormatting a) => Bool -> Trace m FormattedMessage -> Trace m a Source #

humanFormatter' :: forall m. MonadIO m => Bool -> Trace m FormattedMessage -> Trace m PreFormatted Source #

Format this trace in human readable text output