Safe Haskell	Safe-Inferred
Language	Haskell2010

Hermod.Tracing.API

Description

Stable public API for the Hermod tracing system.

This is the single-import front door for hermod-tracing-api. It re-exports everything a package needs to:

Define trace types: write LogFormatting (human/machine rendering, metrics) and MetaTrace (namespace, severity, documentation) instances for your domain message types.
Dispatch messages: call traceWith to emit, contramapM to adapt types, foldTraceM to accumulate state, routingTrace to fan out.
Filter: filterTrace, filterTraceMaybe.

For tracer authors

Trace                  -- the central carrier opaque type
LogFormatting(..)      -- typeclass: forMachine, forHuman, asMetrics
MetaTrace(..)          -- typeclass: namespaceFor, severityFor, documentFor, …
Metric(..)             -- metric payload (IntM, DoubleM, CounterM, LabelSetM)
Namespace(..)          -- hierarchical trace identifier
SeverityS(..)          -- message severity (Debug … Emergency)
SeverityF(..)          -- severity filter (Nothing = Silence)
Privacy(..)            -- Public | Confidential
DetailLevel(..)        -- DMinimal … DMaximum
Folding(..)            -- wrapper for fold-based stateful tracers

Configuration and control (consumed by `hermod-tracing-core`)

TraceConfig, ConfigOption, BackendConfig, ConfigReflection, DocCollector, ForwarderAddr, ForwarderMode, TraceOptionForwarder, PrometheusSimpleRun. These appear in type signatures throughout the system; tracer authors typically do not construct them directly.

Synopsis

data Trace (m :: Type -> Type) a
newtype Folding a b = Folding b
data CounterAction
- = CounterIncrement
- | CounterAdd Word64
data DetailLevel
- = DMinimal
- | DNormal
- | DDetailed
- | DMaximum
data Metric
- = IntM Text Integer
- | DoubleM Text Double
- | CounterM Text CounterAction
- | LabelSetM Text [(Text, Text)]
data Namespace a = Namespace {
- nsPrefix :: [Text]
- nsInner :: [Text]
}
data Privacy
- = Confidential
- | Public
newtype SeverityF = SeverityF (Maybe SeverityS)
data SeverityS
- = Debug
- | Info
- | Notice
- | Warning
- | Error
- | Critical
- | Alert
- | Emergency
data BackendConfig
- = Forwarder
- | Stdout FormatLogging
- | EKGBackend
- | DatapointBackend
- | PrometheusSimple Bool (Maybe HostName) PortNumber
data ConfigOption
- = ConfSeverity {
  - severity :: SeverityF
  }
- | ConfDetail {
  - detail :: DetailLevel
  }
- | ConfBackend {
  - backends :: [BackendConfig]
  }
- | ConfLimiter {
  - maxFrequency :: Double
  }
data FormatLogging
- = HumanFormatColoured
- | HumanFormatUncoloured
- | MachineFormat
data ForwarderMode
- = Initiator
- | Responder
data PrometheusSimpleRun = PrometheusSimpleRun {
- connTimeout :: Maybe Word
- connCountGlobal :: Maybe Word
- connCountPerHost :: Maybe Word
- connPerSecond :: Maybe Double
}
data TraceConfig = TraceConfig {
- tcOptions :: Map [Text] [ConfigOption]
- tcForwarder :: Maybe TraceOptionForwarder
- tcApplicationName :: Maybe Text
- tcMetricsPrefix :: Maybe Text
- tcPeriodicTracers :: Map Text Word64
- tcPrometheusSimpleRun :: Maybe PrometheusSimpleRun
}
data TraceOptionForwarder = TraceOptionForwarder {
- tofQueueSize :: Word
- tofVerbosity :: Verbosity
- tofMaxReconnectDelay :: Word
}
data Verbosity
- = Maximum
- | Minimum
data ConfigReflection = ConfigReflection {
- crSilent :: IORef (Set [Text])
- crNoMetrics :: IORef (Set [Text])
- crAllTracers :: IORef (Set [Text])
}
newtype DocCollector = DocCollector (IORef (Map Int LogDoc))
class LogFormatting a where
- forMachine :: DetailLevel -> a -> Object
- forHuman :: a -> Text
- asMetrics :: a -> [Metric]
class MetaTrace a where
- namespaceFor :: a -> Namespace a
- severityFor :: Namespace a -> Maybe a -> Maybe SeverityS
- privacyFor :: Namespace a -> Maybe a -> Maybe Privacy
- detailsFor :: Namespace a -> Maybe a -> Maybe DetailLevel
- documentFor :: Namespace a -> Maybe Text
- metricsDocFor :: Namespace a -> [(Text, Text)]
- allNamespaces :: [Namespace a]
traceWith :: Monad m => Trace m a -> a -> m ()
unfold :: Folding a b -> b
routingTrace :: Monad m => (a -> m (Trace m a)) -> Trace m a -> Trace m a
filterTraceMaybe :: forall (m :: Type -> Type) a. Monad m => Trace m a -> Trace m (Maybe a)
emptyLoggingContext :: LoggingContext
getMetricName :: Metric -> Text
nsCast :: Namespace a -> Namespace b
nsGetComplete :: Namespace a -> [Text]
nsGetTuple :: Namespace a -> ([Text], [Text])
nsPrependInner :: Text -> Namespace a -> Namespace b
nsRawToText :: ([Text], [Text]) -> Text
nsReplaceInner :: [Text] -> Namespace a -> Namespace a
nsReplacePrefix :: [Text] -> Namespace a -> Namespace a
nsToText :: Namespace a -> Text
defaultForwarder :: TraceOptionForwarder
emptyTraceConfig :: TraceConfig
parsePrometheusString :: Text -> Either String BackendConfig
prometheusSimpleNoOverrides :: PrometheusSimpleRun
emptyConfigReflection :: IO ConfigReflection
emptyLogDoc :: Text -> [(Text, Text)] -> LogDoc
contramapM :: Monad m => Trace m b -> (a -> m b) -> Trace m a
contramapMCond :: Monad m => Trace m b -> (a -> m (Maybe b)) -> Trace m a
foldTraceM :: forall a acc m. MonadUnliftIO m => (acc -> a -> m acc) -> acc -> Trace m (Folding a acc) -> m (Trace m a)
foldCondTraceM :: forall a acc m. MonadUnliftIO m => (acc -> a -> m acc) -> acc -> (a -> Bool) -> Trace m (Folding a acc) -> m (Trace m a)
filterTrace :: Monad m => (a -> Bool) -> Trace m a -> Trace m a

Documentation

data Trace (m :: Type -> Type) a #

Instances

Instances details

Monad m => Contravariant (Trace m)
Instance details Defined in Hermod.Tracing.Types Methods contramap :: (a' -> a) -> Trace m a -> Trace m a' Source # (>$) :: b -> Trace m b -> Trace m a Source #
Monad m => Monoid (Trace m a)
Instance details Defined in Hermod.Tracing.Types Methods mempty :: Trace m a Source # mappend :: Trace m a -> Trace m a -> Trace m a Source # mconcat :: [Trace m a] -> Trace m a Source #
Monad m => Semigroup (Trace m a)
Instance details Defined in Hermod.Tracing.Types Methods (<>) :: Trace m a -> Trace m a -> Trace m a Source # sconcat :: NonEmpty (Trace m a) -> Trace m a Source # stimes :: Integral b => b -> Trace m a -> Trace m a Source #

newtype Folding a b #

Constructors

Folding b

Instances

Instances details

LogFormatting b => LogFormatting (Folding a b)
Instance details Defined in Hermod.Tracing.Types Methods forMachine :: DetailLevel -> Folding a b -> Object # forHuman :: Folding a b -> Text # asMetrics :: Folding a b -> [Metric] #

data CounterAction #

Constructors

CounterIncrement
CounterAdd Word64

Instances

Instances details

Generic CounterAction
Instance details Defined in Hermod.Tracing.Types.Annotations Associated Types type Rep CounterAction :: Type -> Type Source # Methods from :: CounterAction -> Rep CounterAction x Source # to :: Rep CounterAction x -> CounterAction Source #
Show CounterAction
Instance details Defined in Hermod.Tracing.Types.Annotations Methods showsPrec :: Int -> CounterAction -> ShowS Source # show :: CounterAction -> String Source # showList :: [CounterAction] -> ShowS Source #
NFData CounterAction
Instance details Defined in Hermod.Tracing.Types.Annotations Methods rnf :: CounterAction -> () Source #
Eq CounterAction
Instance details Defined in Hermod.Tracing.Types.Annotations Methods (==) :: CounterAction -> CounterAction -> Bool Source # (/=) :: CounterAction -> CounterAction -> Bool Source #
type Rep CounterAction
Instance details Defined in Hermod.Tracing.Types.Annotations type Rep CounterAction = D1 ('MetaData "CounterAction" "Hermod.Tracing.Types.Annotations" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) (C1 ('MetaCons "CounterIncrement" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CounterAdd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

data DetailLevel #

Constructors

DMinimal
DNormal
DDetailed
DMaximum

Instances

Instances details

FromJSON DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods parseJSON :: Value -> Parser DetailLevel parseJSONList :: Value -> Parser [DetailLevel] omittedField :: Maybe DetailLevel
ToJSON DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods toJSON :: DetailLevel -> Value toEncoding :: DetailLevel -> Encoding toJSONList :: [DetailLevel] -> Value toEncodingList :: [DetailLevel] -> Encoding omitField :: DetailLevel -> Bool
Bounded DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods minBound :: DetailLevel Source # maxBound :: DetailLevel Source #
Enum DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods succ :: DetailLevel -> DetailLevel Source # pred :: DetailLevel -> DetailLevel Source # toEnum :: Int -> DetailLevel Source # fromEnum :: DetailLevel -> Int Source # enumFrom :: DetailLevel -> [DetailLevel] Source # enumFromThen :: DetailLevel -> DetailLevel -> [DetailLevel] Source # enumFromTo :: DetailLevel -> DetailLevel -> [DetailLevel] Source # enumFromThenTo :: DetailLevel -> DetailLevel -> DetailLevel -> [DetailLevel] Source #
Generic DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Associated Types type Rep DetailLevel :: Type -> Type Source # Methods from :: DetailLevel -> Rep DetailLevel x Source # to :: Rep DetailLevel x -> DetailLevel Source #
Show DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods showsPrec :: Int -> DetailLevel -> ShowS Source # show :: DetailLevel -> String Source # showList :: [DetailLevel] -> ShowS Source #
NFData DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods rnf :: DetailLevel -> () Source #
Eq DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods (==) :: DetailLevel -> DetailLevel -> Bool Source # (/=) :: DetailLevel -> DetailLevel -> Bool Source #
Ord DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods compare :: DetailLevel -> DetailLevel -> Ordering Source # (<) :: DetailLevel -> DetailLevel -> Bool Source # (<=) :: DetailLevel -> DetailLevel -> Bool Source # (>) :: DetailLevel -> DetailLevel -> Bool Source # (>=) :: DetailLevel -> DetailLevel -> Bool Source # max :: DetailLevel -> DetailLevel -> DetailLevel Source # min :: DetailLevel -> DetailLevel -> DetailLevel Source #
Serialise DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations Methods encode :: DetailLevel -> Encoding decode :: Decoder s DetailLevel encodeList :: [DetailLevel] -> Encoding decodeList :: Decoder s [DetailLevel]
type Rep DetailLevel
Instance details Defined in Hermod.Tracing.Types.Annotations type Rep DetailLevel = D1 ('MetaData "DetailLevel" "Hermod.Tracing.Types.Annotations" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) ((C1 ('MetaCons "DMinimal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DNormal" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DDetailed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DMaximum" 'PrefixI 'False) (U1 :: Type -> Type)))

data Metric #

Constructors

IntM Text Integer
DoubleM Text Double
CounterM Text CounterAction
LabelSetM Text [(Text, Text)]

Instances

Instances details

Generic Metric
Instance details Defined in Hermod.Tracing.Types.Annotations Associated Types type Rep Metric :: Type -> Type Source # Methods from :: Metric -> Rep Metric x Source # to :: Rep Metric x -> Metric Source #
Show Metric
Instance details Defined in Hermod.Tracing.Types.Annotations Methods showsPrec :: Int -> Metric -> ShowS Source # show :: Metric -> String Source # showList :: [Metric] -> ShowS Source #
NFData Metric
Instance details Defined in Hermod.Tracing.Types.Annotations Methods rnf :: Metric -> () Source #
Eq Metric
Instance details Defined in Hermod.Tracing.Types.Annotations Methods (==) :: Metric -> Metric -> Bool Source # (/=) :: Metric -> Metric -> Bool Source #
type Rep Metric
Instance details Defined in Hermod.Tracing.Types.Annotations type Rep Metric = D1 ('MetaData "Metric" "Hermod.Tracing.Types.Annotations" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) ((C1 ('MetaCons "IntM" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :+: C1 ('MetaCons "DoubleM" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :+: (C1 ('MetaCons "CounterM" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CounterAction)) :+: C1 ('MetaCons "LabelSetM" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Text)]))))

data Namespace a #

Constructors

Namespace
Fields nsPrefix :: [Text] nsInner :: [Text]

Instances

Instances details

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

data Privacy #

Constructors

Confidential
Public

Instances

Instances details

Bounded Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Methods minBound :: Privacy Source # maxBound :: Privacy Source #
Enum Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Methods succ :: Privacy -> Privacy Source # pred :: Privacy -> Privacy Source # toEnum :: Int -> Privacy Source # fromEnum :: Privacy -> Int Source # enumFrom :: Privacy -> [Privacy] Source # enumFromThen :: Privacy -> Privacy -> [Privacy] Source # enumFromTo :: Privacy -> Privacy -> [Privacy] Source # enumFromThenTo :: Privacy -> Privacy -> Privacy -> [Privacy] Source #
Generic Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Associated Types type Rep Privacy :: Type -> Type Source # Methods from :: Privacy -> Rep Privacy x Source # to :: Rep Privacy x -> Privacy Source #
Show Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Methods showsPrec :: Int -> Privacy -> ShowS Source # show :: Privacy -> String Source # showList :: [Privacy] -> ShowS Source #
Eq Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Methods (==) :: Privacy -> Privacy -> Bool Source # (/=) :: Privacy -> Privacy -> Bool Source #
Ord Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Methods compare :: Privacy -> Privacy -> Ordering Source # (<) :: Privacy -> Privacy -> Bool Source # (<=) :: Privacy -> Privacy -> Bool Source # (>) :: Privacy -> Privacy -> Bool Source # (>=) :: Privacy -> Privacy -> Bool Source # max :: Privacy -> Privacy -> Privacy Source # min :: Privacy -> Privacy -> Privacy Source #
Serialise Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations Methods encode :: Privacy -> Encoding decode :: Decoder s Privacy encodeList :: [Privacy] -> Encoding decodeList :: Decoder s [Privacy]
type Rep Privacy
Instance details Defined in Hermod.Tracing.Types.Annotations type Rep Privacy = D1 ('MetaData "Privacy" "Hermod.Tracing.Types.Annotations" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) (C1 ('MetaCons "Confidential" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Public" 'PrefixI 'False) (U1 :: Type -> Type))

newtype SeverityF #

Constructors

SeverityF (Maybe SeverityS)

Instances

Instances details

FromJSON SeverityF
Instance details Defined in Hermod.Tracing.Types.Annotations Methods parseJSON :: Value -> Parser SeverityF parseJSONList :: Value -> Parser [SeverityF] omittedField :: Maybe SeverityF
ToJSON SeverityF
Instance details Defined in Hermod.Tracing.Types.Annotations Methods toJSON :: SeverityF -> Value toEncoding :: SeverityF -> Encoding toJSONList :: [SeverityF] -> Value toEncodingList :: [SeverityF] -> Encoding omitField :: SeverityF -> Bool
Enum SeverityF
Instance details Defined in Hermod.Tracing.Types.Annotations Methods succ :: SeverityF -> SeverityF Source # pred :: SeverityF -> SeverityF Source # toEnum :: Int -> SeverityF Source # fromEnum :: SeverityF -> Int Source # enumFrom :: SeverityF -> [SeverityF] Source # enumFromThen :: SeverityF -> SeverityF -> [SeverityF] Source # enumFromTo :: SeverityF -> SeverityF -> [SeverityF] Source # enumFromThenTo :: SeverityF -> SeverityF -> SeverityF -> [SeverityF] Source #
Show SeverityF
Instance details Defined in Hermod.Tracing.Types.Annotations Methods showsPrec :: Int -> SeverityF -> ShowS Source # show :: SeverityF -> String Source # showList :: [SeverityF] -> ShowS Source #
Eq SeverityF
Instance details Defined in Hermod.Tracing.Types.Annotations Methods (==) :: SeverityF -> SeverityF -> Bool Source # (/=) :: SeverityF -> SeverityF -> Bool Source #
Ord SeverityF
Instance details Defined in Hermod.Tracing.Types.Annotations Methods compare :: SeverityF -> SeverityF -> Ordering Source # (<) :: SeverityF -> SeverityF -> Bool Source # (<=) :: SeverityF -> SeverityF -> Bool Source # (>) :: SeverityF -> SeverityF -> Bool Source # (>=) :: SeverityF -> SeverityF -> Bool Source # max :: SeverityF -> SeverityF -> SeverityF Source # min :: SeverityF -> SeverityF -> SeverityF Source #

data SeverityS #

Constructors

Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency

Instances

Instances details

FromJSON SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods parseJSON :: Value -> Parser SeverityS parseJSONList :: Value -> Parser [SeverityS] omittedField :: Maybe SeverityS
ToJSON SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods toJSON :: SeverityS -> Value toEncoding :: SeverityS -> Encoding toJSONList :: [SeverityS] -> Value toEncodingList :: [SeverityS] -> Encoding omitField :: SeverityS -> Bool
Bounded SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods minBound :: SeverityS Source # maxBound :: SeverityS Source #
Enum SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods succ :: SeverityS -> SeverityS Source # pred :: SeverityS -> SeverityS Source # toEnum :: Int -> SeverityS Source # fromEnum :: SeverityS -> Int Source # enumFrom :: SeverityS -> [SeverityS] Source # enumFromThen :: SeverityS -> SeverityS -> [SeverityS] Source # enumFromTo :: SeverityS -> SeverityS -> [SeverityS] Source # enumFromThenTo :: SeverityS -> SeverityS -> SeverityS -> [SeverityS] Source #
Generic SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Associated Types type Rep SeverityS :: Type -> Type Source # Methods from :: SeverityS -> Rep SeverityS x Source # to :: Rep SeverityS x -> SeverityS Source #
Read SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods readsPrec :: Int -> ReadS SeverityS Source # readList :: ReadS [SeverityS] Source # readPrec :: ReadPrec SeverityS Source # readListPrec :: ReadPrec [SeverityS] Source #
Show SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods showsPrec :: Int -> SeverityS -> ShowS Source # show :: SeverityS -> String Source # showList :: [SeverityS] -> ShowS Source #
NFData SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods rnf :: SeverityS -> () Source #
Eq SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods (==) :: SeverityS -> SeverityS -> Bool Source # (/=) :: SeverityS -> SeverityS -> Bool Source #
Ord SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods compare :: SeverityS -> SeverityS -> Ordering Source # (<) :: SeverityS -> SeverityS -> Bool Source # (<=) :: SeverityS -> SeverityS -> Bool Source # (>) :: SeverityS -> SeverityS -> Bool Source # (>=) :: SeverityS -> SeverityS -> Bool Source # max :: SeverityS -> SeverityS -> SeverityS Source # min :: SeverityS -> SeverityS -> SeverityS Source #
Serialise SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations Methods encode :: SeverityS -> Encoding decode :: Decoder s SeverityS encodeList :: [SeverityS] -> Encoding decodeList :: Decoder s [SeverityS]
type Rep SeverityS
Instance details Defined in Hermod.Tracing.Types.Annotations type Rep SeverityS = D1 ('MetaData "SeverityS" "Hermod.Tracing.Types.Annotations" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" '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))))

data BackendConfig #

Constructors

Forwarder
Stdout FormatLogging
EKGBackend
DatapointBackend
PrometheusSimple Bool (Maybe HostName) PortNumber

Instances

Instances details

FromJSON BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config Methods parseJSON :: Value -> Parser BackendConfig parseJSONList :: Value -> Parser [BackendConfig] omittedField :: Maybe BackendConfig
ToJSON BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config Methods toJSON :: BackendConfig -> Value toEncoding :: BackendConfig -> Encoding toJSONList :: [BackendConfig] -> Value toEncodingList :: [BackendConfig] -> Encoding omitField :: BackendConfig -> Bool
Generic BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config Associated Types type Rep BackendConfig :: Type -> Type Source # Methods from :: BackendConfig -> Rep BackendConfig x Source # to :: Rep BackendConfig x -> BackendConfig Source #
Show BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> BackendConfig -> ShowS Source # show :: BackendConfig -> String Source # showList :: [BackendConfig] -> ShowS Source #
Eq BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config Methods (==) :: BackendConfig -> BackendConfig -> Bool Source # (/=) :: BackendConfig -> BackendConfig -> Bool Source #
Ord BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config Methods compare :: BackendConfig -> BackendConfig -> Ordering Source # (<) :: BackendConfig -> BackendConfig -> Bool Source # (<=) :: BackendConfig -> BackendConfig -> Bool Source # (>) :: BackendConfig -> BackendConfig -> Bool Source # (>=) :: BackendConfig -> BackendConfig -> Bool Source # max :: BackendConfig -> BackendConfig -> BackendConfig Source # min :: BackendConfig -> BackendConfig -> BackendConfig Source #
type Rep BackendConfig
Instance details Defined in Hermod.Tracing.Types.Config type Rep BackendConfig = D1 ('MetaData "BackendConfig" "Hermod.Tracing.Types.Config" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) ((C1 ('MetaCons "Forwarder" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Stdout" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FormatLogging))) :+: (C1 ('MetaCons "EKGBackend" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DatapointBackend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PrometheusSimple" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HostName)) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber))))))

data ConfigOption #

Constructors

ConfSeverity
Fields severity :: SeverityF
ConfDetail
Fields detail :: DetailLevel
ConfBackend
Fields backends :: [BackendConfig]
ConfLimiter
Fields maxFrequency :: Double

Instances

Instances details

Generic ConfigOption
Instance details Defined in Hermod.Tracing.Types.Config Associated Types type Rep ConfigOption :: Type -> Type Source # Methods from :: ConfigOption -> Rep ConfigOption x Source # to :: Rep ConfigOption x -> ConfigOption Source #
Show ConfigOption
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> ConfigOption -> ShowS Source # show :: ConfigOption -> String Source # showList :: [ConfigOption] -> ShowS Source #
Eq ConfigOption
Instance details Defined in Hermod.Tracing.Types.Config Methods (==) :: ConfigOption -> ConfigOption -> Bool Source # (/=) :: ConfigOption -> ConfigOption -> Bool Source #
Ord ConfigOption
Instance details Defined in Hermod.Tracing.Types.Config Methods compare :: ConfigOption -> ConfigOption -> Ordering Source # (<) :: ConfigOption -> ConfigOption -> Bool Source # (<=) :: ConfigOption -> ConfigOption -> Bool Source # (>) :: ConfigOption -> ConfigOption -> Bool Source # (>=) :: ConfigOption -> ConfigOption -> Bool Source # max :: ConfigOption -> ConfigOption -> ConfigOption Source # min :: ConfigOption -> ConfigOption -> ConfigOption Source #
type Rep ConfigOption
Instance details Defined in Hermod.Tracing.Types.Config type Rep ConfigOption = D1 ('MetaData "ConfigOption" "Hermod.Tracing.Types.Config" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) ((C1 ('MetaCons "ConfSeverity" 'PrefixI 'True) (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SeverityF)) :+: C1 ('MetaCons "ConfDetail" 'PrefixI 'True) (S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DetailLevel))) :+: (C1 ('MetaCons "ConfBackend" 'PrefixI 'True) (S1 ('MetaSel ('Just "backends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BackendConfig])) :+: C1 ('MetaCons "ConfLimiter" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))

data FormatLogging #

Constructors

HumanFormatColoured
HumanFormatUncoloured
MachineFormat

Instances

Instances details

Show FormatLogging
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> FormatLogging -> ShowS Source # show :: FormatLogging -> String Source # showList :: [FormatLogging] -> ShowS Source #
Eq FormatLogging
Instance details Defined in Hermod.Tracing.Types.Config Methods (==) :: FormatLogging -> FormatLogging -> Bool Source # (/=) :: FormatLogging -> FormatLogging -> Bool Source #
Ord FormatLogging
Instance details Defined in Hermod.Tracing.Types.Config Methods compare :: FormatLogging -> FormatLogging -> Ordering Source # (<) :: FormatLogging -> FormatLogging -> Bool Source # (<=) :: FormatLogging -> FormatLogging -> Bool Source # (>) :: FormatLogging -> FormatLogging -> Bool Source # (>=) :: FormatLogging -> FormatLogging -> Bool Source # max :: FormatLogging -> FormatLogging -> FormatLogging Source # min :: FormatLogging -> FormatLogging -> FormatLogging Source #

data ForwarderMode #

Constructors

Initiator
Responder

Instances

Instances details

FromJSON ForwarderMode
Instance details Defined in Hermod.Tracing.Types.Config Methods parseJSON :: Value -> Parser ForwarderMode parseJSONList :: Value -> Parser [ForwarderMode] omittedField :: Maybe ForwarderMode
Generic ForwarderMode
Instance details Defined in Hermod.Tracing.Types.Config Associated Types type Rep ForwarderMode :: Type -> Type Source # Methods from :: ForwarderMode -> Rep ForwarderMode x Source # to :: Rep ForwarderMode x -> ForwarderMode Source #
Show ForwarderMode
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> ForwarderMode -> ShowS Source # show :: ForwarderMode -> String Source # showList :: [ForwarderMode] -> ShowS Source #
Eq ForwarderMode
Instance details Defined in Hermod.Tracing.Types.Config Methods (==) :: ForwarderMode -> ForwarderMode -> Bool Source # (/=) :: ForwarderMode -> ForwarderMode -> Bool Source #
Ord ForwarderMode
Instance details Defined in Hermod.Tracing.Types.Config Methods compare :: ForwarderMode -> ForwarderMode -> Ordering Source # (<) :: ForwarderMode -> ForwarderMode -> Bool Source # (<=) :: ForwarderMode -> ForwarderMode -> Bool Source # (>) :: ForwarderMode -> ForwarderMode -> Bool Source # (>=) :: ForwarderMode -> ForwarderMode -> Bool Source # max :: ForwarderMode -> ForwarderMode -> ForwarderMode Source # min :: ForwarderMode -> ForwarderMode -> ForwarderMode Source #
type Rep ForwarderMode
Instance details Defined in Hermod.Tracing.Types.Config type Rep ForwarderMode = D1 ('MetaData "ForwarderMode" "Hermod.Tracing.Types.Config" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) (C1 ('MetaCons "Initiator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Responder" 'PrefixI 'False) (U1 :: Type -> Type))

data PrometheusSimpleRun #

Constructors

PrometheusSimpleRun
Fields connTimeout :: Maybe Word connCountGlobal :: Maybe Word connCountPerHost :: Maybe Word connPerSecond :: Maybe Double

Instances

Instances details

FromJSON PrometheusSimpleRun
Instance details Defined in Hermod.Tracing.Types.Config Methods parseJSON :: Value -> Parser PrometheusSimpleRun parseJSONList :: Value -> Parser [PrometheusSimpleRun] omittedField :: Maybe PrometheusSimpleRun
ToJSON PrometheusSimpleRun
Instance details Defined in Hermod.Tracing.Types.Config Methods toJSON :: PrometheusSimpleRun -> Value toEncoding :: PrometheusSimpleRun -> Encoding toJSONList :: [PrometheusSimpleRun] -> Value toEncodingList :: [PrometheusSimpleRun] -> Encoding omitField :: PrometheusSimpleRun -> Bool
Generic PrometheusSimpleRun
Instance details Defined in Hermod.Tracing.Types.Config Associated Types type Rep PrometheusSimpleRun :: Type -> Type Source # Methods from :: PrometheusSimpleRun -> Rep PrometheusSimpleRun x Source # to :: Rep PrometheusSimpleRun x -> PrometheusSimpleRun Source #
Show PrometheusSimpleRun
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> PrometheusSimpleRun -> ShowS Source # show :: PrometheusSimpleRun -> String Source # showList :: [PrometheusSimpleRun] -> ShowS Source #
type Rep PrometheusSimpleRun
Instance details Defined in Hermod.Tracing.Types.Config type Rep PrometheusSimpleRun = D1 ('MetaData "PrometheusSimpleRun" "Hermod.Tracing.Types.Config" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) (C1 ('MetaCons "PrometheusSimpleRun" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word)) :: S1 ('MetaSel ('Just "connCountGlobal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word))) :: (S1 ('MetaSel ('Just "connCountPerHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word)) :*: S1 ('MetaSel ('Just "connPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)))))

data TraceConfig #

Constructors

TraceConfig
Fields tcOptions :: Map [Text] [ConfigOption] tcForwarder :: Maybe TraceOptionForwarder tcApplicationName :: Maybe Text tcMetricsPrefix :: Maybe Text tcPeriodicTracers :: Map Text Word64 tcPrometheusSimpleRun :: Maybe PrometheusSimpleRun

Instances

Instances details

Show TraceConfig
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> TraceConfig -> ShowS Source # show :: TraceConfig -> String Source # showList :: [TraceConfig] -> ShowS Source #

data TraceOptionForwarder #

Constructors

TraceOptionForwarder
Fields tofQueueSize :: Word tofVerbosity :: Verbosity tofMaxReconnectDelay :: Word

Instances

Instances details

FromJSON TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config Methods parseJSON :: Value -> Parser TraceOptionForwarder parseJSONList :: Value -> Parser [TraceOptionForwarder] omittedField :: Maybe TraceOptionForwarder
ToJSON TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config Methods toJSON :: TraceOptionForwarder -> Value toEncoding :: TraceOptionForwarder -> Encoding toJSONList :: [TraceOptionForwarder] -> Value toEncodingList :: [TraceOptionForwarder] -> Encoding omitField :: TraceOptionForwarder -> Bool
Generic TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config Associated Types type Rep TraceOptionForwarder :: Type -> Type Source # Methods from :: TraceOptionForwarder -> Rep TraceOptionForwarder x Source # to :: Rep TraceOptionForwarder x -> TraceOptionForwarder Source #
Show TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> TraceOptionForwarder -> ShowS Source # show :: TraceOptionForwarder -> String Source # showList :: [TraceOptionForwarder] -> ShowS Source #
Eq TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config Methods (==) :: TraceOptionForwarder -> TraceOptionForwarder -> Bool Source # (/=) :: TraceOptionForwarder -> TraceOptionForwarder -> Bool Source #
Ord TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config Methods compare :: TraceOptionForwarder -> TraceOptionForwarder -> Ordering Source # (<) :: TraceOptionForwarder -> TraceOptionForwarder -> Bool Source # (<=) :: TraceOptionForwarder -> TraceOptionForwarder -> Bool Source # (>) :: TraceOptionForwarder -> TraceOptionForwarder -> Bool Source # (>=) :: TraceOptionForwarder -> TraceOptionForwarder -> Bool Source # max :: TraceOptionForwarder -> TraceOptionForwarder -> TraceOptionForwarder Source # min :: TraceOptionForwarder -> TraceOptionForwarder -> TraceOptionForwarder Source #
type Rep TraceOptionForwarder
Instance details Defined in Hermod.Tracing.Types.Config type Rep TraceOptionForwarder = D1 ('MetaData "TraceOptionForwarder" "Hermod.Tracing.Types.Config" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) (C1 ('MetaCons "TraceOptionForwarder" 'PrefixI 'True) (S1 ('MetaSel ('Just "tofQueueSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :: (S1 ('MetaSel ('Just "tofVerbosity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Verbosity) :: S1 ('MetaSel ('Just "tofMaxReconnectDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word))))

data Verbosity #

Constructors

Maximum
Minimum

Instances

Instances details

FromJSON Verbosity
Instance details Defined in Hermod.Tracing.Types.Config Methods parseJSON :: Value -> Parser Verbosity parseJSONList :: Value -> Parser [Verbosity] omittedField :: Maybe Verbosity
ToJSON Verbosity
Instance details Defined in Hermod.Tracing.Types.Config Methods toJSON :: Verbosity -> Value toEncoding :: Verbosity -> Encoding toJSONList :: [Verbosity] -> Value toEncodingList :: [Verbosity] -> Encoding omitField :: Verbosity -> Bool
Generic Verbosity
Instance details Defined in Hermod.Tracing.Types.Config Associated Types type Rep Verbosity :: Type -> Type Source # Methods from :: Verbosity -> Rep Verbosity x Source # to :: Rep Verbosity x -> Verbosity Source #
Show Verbosity
Instance details Defined in Hermod.Tracing.Types.Config Methods showsPrec :: Int -> Verbosity -> ShowS Source # show :: Verbosity -> String Source # showList :: [Verbosity] -> ShowS Source #
Eq Verbosity
Instance details Defined in Hermod.Tracing.Types.Config Methods (==) :: Verbosity -> Verbosity -> Bool Source # (/=) :: Verbosity -> Verbosity -> Bool Source #
Ord Verbosity
Instance details Defined in Hermod.Tracing.Types.Config Methods compare :: Verbosity -> Verbosity -> Ordering Source # (<) :: Verbosity -> Verbosity -> Bool Source # (<=) :: Verbosity -> Verbosity -> Bool Source # (>) :: Verbosity -> Verbosity -> Bool Source # (>=) :: Verbosity -> Verbosity -> Bool Source # max :: Verbosity -> Verbosity -> Verbosity Source # min :: Verbosity -> Verbosity -> Verbosity Source #
type Rep Verbosity
Instance details Defined in Hermod.Tracing.Types.Config type Rep Verbosity = D1 ('MetaData "Verbosity" "Hermod.Tracing.Types.Config" "hermod-tracing-api-1.0.0-LO80W9OfQJv10WJ5Ly2Uoc-internal" 'False) (C1 ('MetaCons "Maximum" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Minimum" 'PrefixI 'False) (U1 :: Type -> Type))

data ConfigReflection #

Constructors

ConfigReflection
Fields crSilent :: IORef (Set [Text]) crNoMetrics :: IORef (Set [Text]) crAllTracers :: IORef (Set [Text])

newtype DocCollector #

Constructors

DocCollector (IORef (Map Int LogDoc))

class LogFormatting a where #

Minimal complete definition

forMachine

Methods

forMachine :: DetailLevel -> a -> Object #

forHuman :: a -> Text #

asMetrics :: a -> [Metric] #

Instances

Instances details

LogFormatting b => LogFormatting (Folding a b)
Instance details Defined in Hermod.Tracing.Types Methods forMachine :: DetailLevel -> Folding a b -> Object # forHuman :: Folding a b -> Text # asMetrics :: Folding a b -> [Metric] #