System.Wlog.LoggerConfig

Logger configuration.

Documentation

type LoggerMap = HashMap LoggerName LoggerTree

data RotationParameters

Parameters for logging rotation.

Constructors

RotationParameters

Fields

• rpLogLimit :: !Word64

  max size of file in bytes

• rpKeepFiles :: !Word

  number of files to keep

Instances

Show RotationParameters

Methods

showsPrec :: Int -> RotationParameters -> ShowS

show :: RotationParameters -> String

showList :: [RotationParameters] -> ShowS

Generic RotationParameters

Associated Types

type Rep RotationParameters :: * -> *

Methods

from :: RotationParameters -> Rep RotationParameters x

to :: Rep RotationParameters x -> RotationParameters

ToJSON RotationParameters

Methods

toJSON :: RotationParameters -> Value

toEncoding :: RotationParameters -> Encoding

toJSONList :: [RotationParameters] -> Value

toEncodingList :: [RotationParameters] -> Encoding

FromJSON RotationParameters

Methods

parseJSON :: Value -> Parser RotationParameters

parseJSONList :: Value -> Parser [RotationParameters]

Buildable RotationParameters

Methods

build :: RotationParameters -> Builder

type Rep RotationParameters

type Rep RotationParameters = D1 * (MetaData "RotationParameters" "System.Wlog.LoggerConfig" "log-warper-1.8.3-2dKzEZbl35JJcCzU7CqvIM" False) (C1 * (MetaCons "RotationParameters" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "rpLogLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Word64)) (S1 * (MetaSel (Just Symbol "rpKeepFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Word))))

fromScratch :: Monoid m => State m a -> m

Useful lens combinator to be used for logging initialization. Usually should be used with zoomLogger.

isValidRotation :: RotationParameters -> Bool

Checks if logger rotation parameters are valid.

Hierarchical tree of loggers (with lenses)

data HandlerWrap

Wrapper over file handler with additional rounding option.

Constructors

HandlerWrap

Fields

• _hwFilePath :: !FilePath

  Path to the file to be handled.

• _hwRounding :: !(Maybe Int)

  Round timestamps to this power of 10 picoseconds. Just 3 would round to nanoseconds. Just 12 would round to seconds.

Instances

Show HandlerWrap

Methods

showsPrec :: Int -> HandlerWrap -> ShowS

show :: HandlerWrap -> String

showList :: [HandlerWrap] -> ShowS

Generic HandlerWrap

Associated Types

type Rep HandlerWrap :: * -> *

Methods

from :: HandlerWrap -> Rep HandlerWrap x

to :: Rep HandlerWrap x -> HandlerWrap

ToJSON HandlerWrap

Methods

toJSON :: HandlerWrap -> Value

toEncoding :: HandlerWrap -> Encoding

toJSONList :: [HandlerWrap] -> Value

toEncodingList :: [HandlerWrap] -> Encoding

FromJSON HandlerWrap

Methods

parseJSON :: Value -> Parser HandlerWrap

parseJSONList :: Value -> Parser [HandlerWrap]

type Rep HandlerWrap

type Rep HandlerWrap = D1 * (MetaData "HandlerWrap" "System.Wlog.LoggerConfig" "log-warper-1.8.3-2dKzEZbl35JJcCzU7CqvIM" False) (C1 * (MetaCons "HandlerWrap" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_hwFilePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * FilePath)) (S1 * (MetaSel (Just Symbol "_hwRounding") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))

hwFilePath :: Lens' HandlerWrap FilePath

hwRounding :: Lens' HandlerWrap (Maybe Int)

data LoggerTree

Stores configuration for hierarchical loggers.

Constructors

LoggerTree

Fields

• _ltSubloggers :: !LoggerMap
• _ltFiles :: ![HandlerWrap]
• _ltSeverity :: !(Maybe Severities)

Instances

Show LoggerTree

Methods

showsPrec :: Int -> LoggerTree -> ShowS

show :: LoggerTree -> String

showList :: [LoggerTree] -> ShowS

Generic LoggerTree

Associated Types

type Rep LoggerTree :: * -> *

Methods

from :: LoggerTree -> Rep LoggerTree x

to :: Rep LoggerTree x -> LoggerTree

Semigroup LoggerTree

Methods

(<>) :: LoggerTree -> LoggerTree -> LoggerTree

sconcat :: NonEmpty LoggerTree -> LoggerTree

stimes :: Integral b => b -> LoggerTree -> LoggerTree

Monoid LoggerTree

Methods

mempty :: LoggerTree

mappend :: LoggerTree -> LoggerTree -> LoggerTree

mconcat :: [LoggerTree] -> LoggerTree

ToJSON LoggerTree

Methods

toJSON :: LoggerTree -> Value

toEncoding :: LoggerTree -> Encoding

toJSONList :: [LoggerTree] -> Value

toEncodingList :: [LoggerTree] -> Encoding

FromJSON LoggerTree

Methods

parseJSON :: Value -> Parser LoggerTree

parseJSONList :: Value -> Parser [LoggerTree]

type Rep LoggerTree

type Rep LoggerTree = D1 * (MetaData "LoggerTree" "System.Wlog.LoggerConfig" "log-warper-1.8.3-2dKzEZbl35JJcCzU7CqvIM" False) (C1 * (MetaCons "LoggerTree" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltSubloggers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * LoggerMap)) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [HandlerWrap])) (S1 * (MetaSel (Just Symbol "_ltSeverity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Severities))))))

ltFiles :: Lens' LoggerTree [HandlerWrap]

ltSeverity :: Lens' LoggerTree (Maybe Severities)

ltSubloggers :: Lens' LoggerTree LoggerMap

Global logger configuration

data LoggerConfig

Logger configuration which keeps RotationParameters and LoggerTree.

Constructors

LoggerConfig

Fields

• _lcRotation :: Maybe RotationParameters

  Rotation parameters for logger config. See Roller.

• _lcTermSeverityOut :: Maybe Severities

  Severity for terminal stdout output. If Nothing along with _lcTermSeverityErr then Warning and greater excluding Error are used.

• _lcTermSeverityErr :: Maybe Severities

  Severity for terminal stderr output. If Nothing along with _lcTermSeverityOut then Error is used.

• _lcShowTime :: Any

  Show time for non-error messages. Note that error messages always have timestamp.

• _lcShowTid :: Any

  Show ThreadId for current logging thread.

• _lcConsoleAction :: Last (Handle -> Text -> IO ())

  Specifies action for printing to console.

• _lcMapper :: Endo LoggerName

  Defines how to transform logger names in config.

• _lcLogsDirectory :: Maybe FilePath

  Specifies directory for log files. This can be useful to avoid prefixes if you have a lot of loggers. Another use case: different logger directories on different platforms.

• _lcTree :: LoggerTree

  Hierarchical tree of loggers.

Instances

Semigroup LoggerConfig

Methods

(<>) :: LoggerConfig -> LoggerConfig -> LoggerConfig

sconcat :: NonEmpty LoggerConfig -> LoggerConfig

stimes :: Integral b => b -> LoggerConfig -> LoggerConfig

Monoid LoggerConfig

Methods

mempty :: LoggerConfig

mappend :: LoggerConfig -> LoggerConfig -> LoggerConfig

mconcat :: [LoggerConfig] -> LoggerConfig

ToJSON LoggerConfig

This instances violates fromJSON . toJSON = identity rule but doesn't matter because it is used only for debugging.

Methods

toJSON :: LoggerConfig -> Value

toEncoding :: LoggerConfig -> Encoding

toJSONList :: [LoggerConfig] -> Value

toEncodingList :: [LoggerConfig] -> Encoding

FromJSON LoggerConfig

Methods

parseJSON :: Value -> Parser LoggerConfig

parseJSONList :: Value -> Parser [LoggerConfig]

Lenses

lcConsoleAction :: Lens' LoggerConfig (Last (Handle -> Text -> IO ()))

lcLogsDirectory :: Lens' LoggerConfig (Maybe FilePath)

lcMapper :: Lens' LoggerConfig (Endo LoggerName)

lcRotation :: Lens' LoggerConfig (Maybe RotationParameters)

lcShowTime :: Lens' LoggerConfig Any

lcShowTid :: Lens' LoggerConfig Any

lcTermSeverityOut :: Lens' LoggerConfig (Maybe Severities)

lcTermSeverityErr :: Lens' LoggerConfig (Maybe Severities)

lcTree :: Lens' LoggerConfig LoggerTree

zoomLogger :: LoggerName -> State LoggerTree () -> State LoggerTree ()

Zooming into logger name with putting specific key.

Builders for LoggerConfig

consoleActionB :: (Handle -> Text -> IO ()) -> LoggerConfig

customConsoleActionB :: Maybe (Handle -> Text -> IO ()) -> LoggerConfig

Setup lcConsoleOutput inside LoggerConfig.

mapperB :: (LoggerName -> LoggerName) -> LoggerConfig

Setup lcMapper inside LoggerConfig.

maybeLogsDirB :: Maybe FilePath -> LoggerConfig

Setup lcLogsDirectory inside LoggerConfig to optional prefix.

logsDirB :: FilePath -> LoggerConfig

Setup lcLogsDirectory inside LoggerConfig to specific prefix.

productionB :: LoggerConfig

Adds sensible predefined set of parameters to logger.

showTidB :: LoggerConfig

Setup lcShowTid to True inside LoggerConfig.

showTimeB :: LoggerConfig

Setup lcShowTime to True inside LoggerConfig.

termSeveritiesOutB :: Severities -> LoggerConfig

Setup lcTermSeverityOut to specified severity inside LoggerConfig.

termSeveritiesErrB :: Severities -> LoggerConfig

Setup lcTermSeverityErr to specified severity inside LoggerConfig.