Safe Haskell	None
Language	GHC2024

Arbiter.Worker.Logger

Contents

Log configuration
Log levels
Failure gates
Re-exports for structured context
Internal

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
data FailureGates
newFailureGates :: MonadIO m => m FailureGates
type Pair = (Key, Value)
(.=) :: (KeyValue e kv, ToJSON v) => Key -> v -> kv
tryLog :: MonadUnliftIO m => LogConfig -> LogLevel -> Text -> m ()
warnEx :: MonadUnliftIO m => LogConfig -> Text -> SomeException -> m ()
withIdentity :: Pair -> LogConfig -> LogConfig
toHubLog :: 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)
tryReportedOn :: MonadUnliftIO m => LogConfig -> LogLevel -> FailureGates -> Text -> m a -> m (Either SomeException a)

Log configuration

data LogConfigSource #

Worker log level, destination, and context.

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, except that a LogCallback gets every pair, duplicates included. Default: [].
failureRepeatInterval :: NominalDiffTime
Repeat interval in seconds for a persistent failure. Default: 60.

data LogDestinationSource #

Where Arbiter writes log output.

Constructors

LogStdout	Log to stdout. The 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. 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.

defaultLogConfig :: LogConfigSource #

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

silentLogConfig :: LogConfigSource #

Silent log configuration: discards all logs.

Log levels

data LogLevelSource #

Log severity levels.

Constructors

Debug	Detail for diagnosis.
Info	Normal events.
Warning	Problems that do not stop work.
Error	Failed operations.

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#