Blammo.Logging.LogSettings

Documentation

data LogSettings

data LogLevels

Instances

Show LogLevels

Defined in Blammo.Logging.LogSettings.LogLevels

Methods

showsPrec :: Int -> LogLevels -> ShowS

show :: LogLevels -> String

showList :: [LogLevels] -> ShowS

Eq LogLevels

Defined in Blammo.Logging.LogSettings.LogLevels

Methods

(==) :: LogLevels -> LogLevels -> Bool

(/=) :: LogLevels -> LogLevels -> Bool

data LogDestination

Constructors

LogDestinationStdout

LogDestinationStderr

LogDestinationFile FilePath

data LogFormat

Constructors

LogFormatJSON

LogFormatTerminal

data LogColor

Constructors

LogColorAuto

LogColorAlways

LogColorNever

Instances

Show LogColor

Defined in Blammo.Logging.LogSettings

Methods

showsPrec :: Int -> LogColor -> ShowS

show :: LogColor -> String

showList :: [LogColor] -> ShowS

Eq LogColor

Defined in Blammo.Logging.LogSettings

Methods

(==) :: LogColor -> LogColor -> Bool

(/=) :: LogColor -> LogColor -> Bool

Reading settings, e.g. from ENV

readLogLevels :: String -> Either String LogLevels

readLogDestination :: String -> Either String LogDestination

readLogFormat :: String -> Either String LogFormat

readLogColor :: String -> Either String LogColor

Construction

defaultLogSettings :: LogSettings

Modify

setLogSettingsLevels :: LogLevels -> LogSettings -> LogSettings

setLogSettingsDestination :: LogDestination -> LogSettings -> LogSettings

setLogSettingsFormat :: LogFormat -> LogSettings -> LogSettings

setLogSettingsColor :: LogColor -> LogSettings -> LogSettings

setLogSettingsBreakpoint :: Int -> LogSettings -> LogSettings

setLogSettingsConcurrency :: Maybe Int -> LogSettings -> LogSettings

Set the number of LoggerSet Buffers used by fast-logger

A value of Nothing means to use getNumCapabilities. Higher is more performant, but may deliver messages out of order. The defualt is set for TTY usage (so, 1), but is also changed through setLogSettingsFormat is used.

Support for this option depends on your version of fast-logger:

fast-logger | Destination	Supported?
>=3.1.1 | anywhere	yes
>=3.0.5 | file	yes
>=3.0.5 | stdout/stderr	no
<3.0.5 | anywhere	no

Access

getLogSettingsLevels :: LogSettings -> LogLevels

getLogSettingsDestination :: LogSettings -> LogDestination

getLogSettingsFormat :: LogSettings -> LogFormat

getLogSettingsColor :: LogSettings -> LogColor

getLogSettingsBreakpoint :: LogSettings -> Int

getLogSettingsConcurrency :: LogSettings -> Maybe Int

Logic

shouldLogLevel :: LogSettings -> LogSource -> LogLevel -> Bool

shouldColorAuto :: Applicative m => LogSettings -> m Bool -> m Bool

shouldColorHandle :: MonadIO m => LogSettings -> Handle -> m Bool