System.Log.Simple.Base

Documentation

data Level

Level of message

Constructors

Trace

Debug

Info

Warning

Error

Fatal

Instances

Bounded Level

Defined in System.Log.Simple.Base

Methods

minBound :: Level

maxBound :: Level

Enum Level

Defined in System.Log.Simple.Base

Methods

succ :: Level -> Level

pred :: Level -> Level

toEnum :: Int -> Level

fromEnum :: Level -> Int

enumFrom :: Level -> [Level]

enumFromThen :: Level -> Level -> [Level]

enumFromTo :: Level -> Level -> [Level]

enumFromThenTo :: Level -> Level -> Level -> [Level]

Eq Level

Defined in System.Log.Simple.Base

Methods

(==) :: Level -> Level -> Bool

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

Ord Level

Defined in System.Log.Simple.Base

Methods

compare :: Level -> Level -> Ordering

(<) :: Level -> Level -> Bool

(<=) :: Level -> Level -> Bool

(>) :: Level -> Level -> Bool

(>=) :: Level -> Level -> Bool

max :: Level -> Level -> Level

min :: Level -> Level -> Level

Read Level

Defined in System.Log.Simple.Base

Methods

readsPrec :: Int -> ReadS Level

readList :: ReadS [Level]

readPrec :: ReadPrec Level

readListPrec :: ReadPrec [Level]

Show Level

Defined in System.Log.Simple.Base

Methods

showsPrec :: Int -> Level -> ShowS

show :: Level -> String

showList :: [Level] -> ShowS

Default Level

Defined in System.Log.Simple.Base

Methods

def :: Level

Formattable Level

Defined in System.Log.Simple.Base

Methods

formattable :: Level -> FormatFlags -> Formatted

level :: Text -> Maybe Level

Parse level

level_ :: Text -> Level

Parse level, failing on invalid input

newtype Component

Component — each one have separate log scopes and can have different politics Child component's root politics inherits its parent root politics Component name parts stored in reverse order

Constructors

Component

Fields

• componentPath :: [Text]

Instances

Eq Component

Defined in System.Log.Simple.Base

Methods

(==) :: Component -> Component -> Bool

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

Ord Component

Defined in System.Log.Simple.Base

Methods

compare :: Component -> Component -> Ordering

(<) :: Component -> Component -> Bool

(<=) :: Component -> Component -> Bool

(>) :: Component -> Component -> Bool

(>=) :: Component -> Component -> Bool

max :: Component -> Component -> Component

min :: Component -> Component -> Component

Read Component

Defined in System.Log.Simple.Base

Methods

readsPrec :: Int -> ReadS Component

readList :: ReadS [Component]

readPrec :: ReadPrec Component

readListPrec :: ReadPrec [Component]

Show Component

Defined in System.Log.Simple.Base

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

IsString Component

Defined in System.Log.Simple.Base

Methods

fromString :: String -> Component

Semigroup Component

Defined in System.Log.Simple.Base

Methods

(<>) :: Component -> Component -> Component

sconcat :: NonEmpty Component -> Component

stimes :: Integral b => b -> Component -> Component

Monoid Component

Defined in System.Log.Simple.Base

Methods

mempty :: Component

mappend :: Component -> Component -> Component

mconcat :: [Component] -> Component

NFData Component

Defined in System.Log.Simple.Base

Methods

rnf :: Component -> ()

Formattable Component

Defined in System.Log.Simple.Base

Methods

formattable :: Component -> FormatFlags -> Formatted

newtype Scope

Log scope, also stored in reverse order

Constructors

Scope

Fields

• scopePath :: [Text]

Instances

Eq Scope

Defined in System.Log.Simple.Base

Methods

(==) :: Scope -> Scope -> Bool

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

Ord Scope

Defined in System.Log.Simple.Base

Methods

compare :: Scope -> Scope -> Ordering

(<) :: Scope -> Scope -> Bool

(<=) :: Scope -> Scope -> Bool

(>) :: Scope -> Scope -> Bool

(>=) :: Scope -> Scope -> Bool

max :: Scope -> Scope -> Scope

min :: Scope -> Scope -> Scope

Read Scope

Defined in System.Log.Simple.Base

Methods

readsPrec :: Int -> ReadS Scope

readList :: ReadS [Scope]

readPrec :: ReadPrec Scope

readListPrec :: ReadPrec [Scope]

Show Scope

Defined in System.Log.Simple.Base

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

IsString Scope

Defined in System.Log.Simple.Base

Methods

fromString :: String -> Scope

Semigroup Scope

Defined in System.Log.Simple.Base

Methods

(<>) :: Scope -> Scope -> Scope

sconcat :: NonEmpty Scope -> Scope

stimes :: Integral b => b -> Scope -> Scope

Monoid Scope

Defined in System.Log.Simple.Base

Methods

mempty :: Scope

mappend :: Scope -> Scope -> Scope

mconcat :: [Scope] -> Scope

NFData Scope

Defined in System.Log.Simple.Base

Methods

rnf :: Scope -> ()

Formattable Scope

Defined in System.Log.Simple.Base

Methods

formattable :: Scope -> FormatFlags -> Formatted

data Message

Log message

Constructors

Message

Fields

• messageTime :: ZonedTime
• messageLevel :: Level
• messageComponent :: Component
• messageScope :: Scope
• messageText :: Text

Instances

Read Message

Defined in System.Log.Simple.Base

Methods

readsPrec :: Int -> ReadS Message

readList :: ReadS [Message]

readPrec :: ReadPrec Message

readListPrec :: ReadPrec [Message]

Show Message

Defined in System.Log.Simple.Base

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

NFData Message

Defined in System.Log.Simple.Base

Methods

rnf :: Message -> ()

type Converter a = Message -> a

type Consumer a = ContT () IO (a -> IO ())

Returns function which accepts consumed value

consumer :: (((a -> IO ()) -> IO ()) -> IO ()) -> Consumer a

Make consumer

type LogHandler = Consumer Message

Message handler

handler :: Converter a -> Consumer a -> Consumer Message

data LogConfig

Constructors

LogConfig

Fields

• _logConfigMap :: Map Component Level

Instances

Show LogConfig

Defined in System.Log.Simple.Base

Methods

showsPrec :: Int -> LogConfig -> ShowS

show :: LogConfig -> String

showList :: [LogConfig] -> ShowS

Default LogConfig

Defined in System.Log.Simple.Base

Methods

def :: LogConfig

Ixed LogConfig

Defined in System.Log.Simple.Base

Methods

ix :: Index LogConfig -> Traversal' LogConfig (IxValue LogConfig)

At LogConfig

Defined in System.Log.Simple.Base

Methods

at :: Index LogConfig -> Lens' LogConfig (Maybe (IxValue LogConfig))

type Index LogConfig

Defined in System.Log.Simple.Base

type Index LogConfig = Component

type IxValue LogConfig

Defined in System.Log.Simple.Base

type IxValue LogConfig = Level

defCfg :: LogConfig

Default log config — info level

logCfg :: [(Component, Level)] -> LogConfig

Make log config by list of components and levels

componentCfg :: Component -> Lens' LogConfig (Maybe Level)

Component config level lens

componentLevel :: LogConfig -> Component -> Level

Get politics for specified component

data Log

Log

Constructors

Log

Fields

• logComponent :: Component

  Current log component

• logScope :: Scope

  Current log scope

• logPost :: Message -> IO ()

  Log message, it is low-level function, i.e. it doesn't take into account current component and scope and writes message as is

• logStop :: IO ()

  Stop log and wait until it writes all

• logConfig :: MVar LogConfig

  Log config

• logHandlers :: MVar [LogHandler]

  Handlers list

• logRestartHandlers :: IO ()

  Restart all handlers

Instances

Monad m => MonadReader Log (LogT m)

Defined in System.Log.Simple.Monad

Methods

ask :: LogT m Log

local :: (Log -> Log) -> LogT m a -> LogT m a

reader :: (Log -> a) -> LogT m a

newLog :: LogConfig -> [LogHandler] -> IO Log

Create log, returns root logger for root component

Messages from distinct threads and components are splitted in several chans, where they are processed, and then messages combined back and sent to log-thread

rootLog :: Log -> Log

Get root log, i.e. just drop current component and scope

getLog :: Component -> Scope -> Log -> Log

Get log for specified component and scope

subLog :: Component -> Scope -> Log -> Log

Get sub-log

getLogConfig :: MonadIO m => Log -> m LogConfig

Read log config

updateLogConfig :: MonadIO m => Log -> (LogConfig -> LogConfig) -> m LogConfig

Modify log config

updateLogHandlers :: MonadIO m => Log -> ([LogHandler] -> [LogHandler]) -> m ()

Update log handlers, this restarts handlers thread

writeLog :: MonadIO m => Log -> Level -> Text -> m ()

Write message to log for current component and scope

stopLog :: MonadIO m => Log -> m ()

Wait log messages and stop log