Safe Haskell	None
Language	GHC2024

Arbiter.Worker.Logger

Contents

Log Configuration
Log Levels
Emitting
Repeat suppression
Re-exports for structured context

Description

The worker's own structured JSON logging: its level, its destination, and the context every message carries. Application-level job logging belongs on ObservabilityHooks.

Synopsis

data LogConfig = LogConfig {
- minLogLevel :: LogLevel
- logDestination :: LogDestination
- additionalContext :: IO [Pair]
- identityContext :: [Pair]
- failureRepeatInterval :: NominalDiffTime
}
data LogDestination
- = LogStdout
- | LogStderr
- | LogFastLogger LoggerSet
- | LogCallback (LogLevel -> Text -> [Pair] -> IO ())
- | LogTee LogDestination LogDestination
- | LogDiscard
defaultLogConfig :: LogConfig
silentLogConfig :: LogConfig
data LogLevel
- = Debug
- | Info
- | Warning
- | Error
tryLog :: MonadUnliftIO m => LogConfig -> LogLevel -> Text -> m ()
warnEx :: MonadUnliftIO m => LogConfig -> Text -> SomeException -> m ()
recoveryLevel :: LogConfig -> LogLevel -> LogLevel
hubLogFor :: LogConfig -> HubLog
data FailureGate
newFailureGate :: MonadIO m => m FailureGate
reportOutcome :: MonadUnliftIO m => LogConfig -> LogLevel -> FailureGate -> Text -> Either SomeException a -> m ()
tryReported :: MonadUnliftIO m => LogConfig -> LogLevel -> FailureGate -> Text -> m a -> m (Either SomeException a)
data FailureGates
newFailureGates :: MonadIO m => m FailureGates
tryReportedOn :: MonadUnliftIO m => LogConfig -> LogLevel -> FailureGates -> Text -> m a -> m (Either SomeException a)
type Pair = (Key, Value)
(.=) :: (KeyValue e kv, ToJSON v) => Key -> v -> kv

Log Configuration

Source #data LogConfig

How the worker emits its own logs.

Constructors

LogConfig

Fields

minLogLevel :: LogLevel
Minimum severity to emit. Messages below this level are dropped. Default: Info.
logDestination :: LogDestination
Where to write logs. Default: LogStdout.
additionalContext :: IO [Pair]
Context merged into every message, read at log time. Default: pure [].
identityContext :: [Pair]
The library's pool and worker pairs. additionalContext wins on a collision. Default: [].
failureRepeatInterval :: NominalDiffTime
How often a standing failure says so again. Default: 60s.

Source #data LogDestination

Where Arbiter writes log output.

Constructors

LogStdout	Log to stdout (default)
LogStderr	Log to stderr
LogFastLogger LoggerSet	Log to a custom fast-logger `LoggerSet`
LogCallback (LogLevel -> Text -> [Pair] -> IO ())	Log to a user-provided callback. The callback receives the `LogLevel`, the plain message `Text`, and all structured context as `[Pair]` such as job information and additional context. Use this callback to send Arbiter logs to an application logging system. let cb level msg ctx = myLogger level msg ctx in defaultLogConfig { logDestination = LogCallback cb }
LogTee LogDestination LogDestination	Emit every message to both destinations, the first one before the second.
LogDiscard	Discard all logs (silent mode)

Source #defaultLogConfig :: LogConfig

Default log configuration: Info level to stdout, no additional context.

Source #silentLogConfig :: LogConfig

Silent log configuration: discards all logs.

Log Levels

Source #data LogLevel

Log severity levels.

Constructors

Debug
Info
Warning
Error

Instances

Instances details

Eq LogLevel Source #
Instance details Defined in Arbiter.Worker.Logger Methods #(==) :: LogLevel -> LogLevel -> Bool #(/=) :: LogLevel -> LogLevel -> Bool
Ord LogLevel Source #
Instance details Defined in Arbiter.Worker.Logger Methods #compare :: LogLevel -> LogLevel -> Ordering #(<) :: LogLevel -> LogLevel -> Bool #(<=) :: LogLevel -> LogLevel -> Bool #(>) :: LogLevel -> LogLevel -> Bool #(>=) :: LogLevel -> LogLevel -> Bool #max :: LogLevel -> LogLevel -> LogLevel #min :: LogLevel -> LogLevel -> LogLevel
Bounded LogLevel Source #
Instance details Defined in Arbiter.Worker.Logger Methods #minBound :: LogLevel #maxBound :: LogLevel
Enum LogLevel Source #
Instance details Defined in Arbiter.Worker.Logger Methods #succ :: LogLevel -> LogLevel #pred :: LogLevel -> LogLevel #toEnum :: Int -> LogLevel #fromEnum :: LogLevel -> Int #enumFrom :: LogLevel -> [LogLevel] #enumFromThen :: LogLevel -> LogLevel -> [LogLevel] #enumFromTo :: LogLevel -> LogLevel -> [LogLevel] #enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]
Read LogLevel Source #
Instance details Defined in Arbiter.Worker.Logger Methods #readsPrec :: Int -> ReadS LogLevel #readList :: ReadS [LogLevel] #readPrec :: ReadPrec LogLevel #readListPrec :: ReadPrec [LogLevel]
Show LogLevel Source #
Instance details Defined in Arbiter.Worker.Logger Methods #showsPrec :: Int -> LogLevel -> ShowS #show :: LogLevel -> String #showList :: [LogLevel] -> ShowS