Safe Haskell	None
Language	Haskell2010

System.Log.Simple.Base

Synopsis

data Level
- = Trace
- | Debug
- | Info
- | Warning
- | Error
- | Fatal
level :: Text -> Maybe Level
level_ :: Text -> Level
newtype Component = Component {
- componentPath :: [Text]
}
newtype Scope = Scope {
- scopePath :: [Text]
}
data Message = Message {
- messageTime :: ZonedTime
- messageLevel :: Level
- messageComponent :: Component
- messageScope :: Scope
- messageText :: Text
}
type Converter a = Message -> a
type Consumer a = ContT () IO (a -> IO ())
consumer :: (((a -> IO ()) -> IO ()) -> IO ()) -> Consumer a
type LogHandler = Consumer Message
handler :: Converter a -> Consumer a -> Consumer Message
data LogConfig = LogConfig {
- _logConfigMap :: Map Component Level
}
defCfg :: LogConfig
logCfg :: [(Component, Level)] -> LogConfig
componentCfg :: Component -> Lens' LogConfig (Maybe Level)
componentLevel :: LogConfig -> Component -> Level
data Log = Log {
- logComponent :: Component
- logScope :: Scope
- logPost :: Message -> IO ()
- logStop :: IO ()
- logConfig :: MVar LogConfig
- logHandlers :: MVar [LogHandler]
- logRestartHandlers :: IO ()
}
newLog :: LogConfig -> [LogHandler] -> IO Log
rootLog :: Log -> Log
getLog :: Component -> Scope -> Log -> Log
subLog :: Component -> Scope -> Log -> Log
getLogConfig :: MonadIO m => Log -> m LogConfig
updateLogConfig :: MonadIO m => Log -> (LogConfig -> LogConfig) -> m LogConfig
updateLogHandlers :: MonadIO m => Log -> ([LogHandler] -> [LogHandler]) -> m ()
writeLog :: MonadIO m => Log -> Level -> Text -> m ()
stopLog :: MonadIO m => Log -> m ()

Documentation

data Level Source #

Level of message

Constructors

Trace
Debug
Info
Warning
Error
Fatal

Instances

Bounded Level Source #
Instance details Defined in System.Log.Simple.Base Methods minBound :: Level # maxBound :: Level #
Enum Level Source #
Instance details 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 Source #
Instance details Defined in System.Log.Simple.Base Methods (==) :: Level -> Level -> Bool # (/=) :: Level -> Level -> Bool #
Ord Level Source #
Instance details 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 Source #
Instance details Defined in System.Log.Simple.Base Methods readsPrec :: Int -> ReadS Level # readList :: ReadS [Level] # readPrec :: ReadPrec Level # readListPrec :: ReadPrec [Level] #
Show Level Source #
Instance details Defined in System.Log.Simple.Base Methods showsPrec :: Int -> Level -> ShowS # show :: Level -> String # showList :: [Level] -> ShowS #
Default Level Source #
Instance details Defined in System.Log.Simple.Base Methods def :: Level #
Formattable Level Source #
Instance details Defined in System.Log.Simple.Base Methods formattable :: Level -> FormatFlags -> Formatted #

level :: Text -> Maybe Level Source #

Parse level

level_ :: Text -> Level Source #

Parse level, failing on invalid input

newtype Component Source #

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 Source #
Instance details Defined in System.Log.Simple.Base Methods (==) :: Component -> Component -> Bool # (/=) :: Component -> Component -> Bool #
Ord Component Source #
Instance details 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 Source #
Instance details Defined in System.Log.Simple.Base Methods readsPrec :: Int -> ReadS Component # readList :: ReadS [Component] # readPrec :: ReadPrec Component # readListPrec :: ReadPrec [Component] #
Show Component Source #
Instance details Defined in System.Log.Simple.Base Methods showsPrec :: Int -> Component -> ShowS # show :: Component -> String # showList :: [Component] -> ShowS #
IsString Component Source #
Instance details Defined in System.Log.Simple.Base Methods fromString :: String -> Component #
Semigroup Component Source #
Instance details Defined in System.Log.Simple.Base Methods (<>) :: Component -> Component -> Component # sconcat :: NonEmpty Component -> Component # stimes :: Integral b => b -> Component -> Component #
Monoid Component Source #
Instance details Defined in System.Log.Simple.Base Methods mempty :: Component # mappend :: Component -> Component -> Component # mconcat :: [Component] -> Component #
NFData Component Source #
Instance details Defined in System.Log.Simple.Base Methods rnf :: Component -> () #
Formattable Component Source #
Instance details Defined in System.Log.Simple.Base Methods formattable :: Component -> FormatFlags -> Formatted #

newtype Scope Source #

Log scope, also stored in reverse order

Constructors

Scope
Fields scopePath :: [Text]

Instances

Eq Scope Source #
Instance details Defined in System.Log.Simple.Base Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Ord Scope Source #
Instance details 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 Source #
Instance details Defined in System.Log.Simple.Base Methods readsPrec :: Int -> ReadS Scope # readList :: ReadS [Scope] # readPrec :: ReadPrec Scope # readListPrec :: ReadPrec [Scope] #
Show Scope Source #
Instance details Defined in System.Log.Simple.Base Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
IsString Scope Source #
Instance details Defined in System.Log.Simple.Base Methods fromString :: String -> Scope #
Semigroup Scope Source #
Instance details Defined in System.Log.Simple.Base Methods (<>) :: Scope -> Scope -> Scope # sconcat :: NonEmpty Scope -> Scope # stimes :: Integral b => b -> Scope -> Scope #
Monoid Scope Source #
Instance details Defined in System.Log.Simple.Base Methods mempty :: Scope # mappend :: Scope -> Scope -> Scope # mconcat :: [Scope] -> Scope #
NFData Scope Source #
Instance details Defined in System.Log.Simple.Base Methods rnf :: Scope -> () #
Formattable Scope Source #
Instance details Defined in System.Log.Simple.Base Methods formattable :: Scope -> FormatFlags -> Formatted #

data Message Source #

Log message

Constructors

Message
Fields messageTime :: ZonedTime messageLevel :: Level messageComponent :: Component messageScope :: Scope messageText :: Text

Instances

Read Message Source #
Instance details Defined in System.Log.Simple.Base Methods readsPrec :: Int -> ReadS Message # readList :: ReadS [Message] # readPrec :: ReadPrec Message # readListPrec :: ReadPrec [Message] #
Show Message Source #
Instance details Defined in System.Log.Simple.Base Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
NFData Message Source #
Instance details Defined in System.Log.Simple.Base Methods rnf :: Message -> () #

type Converter a = Message -> a Source #

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

Returns function which accepts consumed value

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

Make consumer

type LogHandler = Consumer Message Source #

Message handler

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

data LogConfig Source #

Constructors

LogConfig
Fields _logConfigMap :: Map Component Level

Instances

Show LogConfig Source #
Instance details Defined in System.Log.Simple.Base Methods showsPrec :: Int -> LogConfig -> ShowS # show :: LogConfig -> String # showList :: [LogConfig] -> ShowS #
Default LogConfig Source #
Instance details Defined in System.Log.Simple.Base Methods def :: LogConfig #
Ixed LogConfig Source #
Instance details Defined in System.Log.Simple.Base Methods ix :: Index LogConfig -> Traversal' LogConfig (IxValue LogConfig) #
At LogConfig Source #
Instance details Defined in System.Log.Simple.Base Methods at :: Index LogConfig -> Lens' LogConfig (Maybe (IxValue LogConfig)) #
type Index LogConfig Source #
Instance details Defined in System.Log.Simple.Base type Index LogConfig = Component
type IxValue LogConfig Source #
Instance details Defined in System.Log.Simple.Base type IxValue LogConfig = Level

defCfg :: LogConfig Source #

Default log config — info level

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

Make log config by list of components and levels

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

Component config level lens

componentLevel :: LogConfig -> Component -> Level Source #

Get politics for specified component

data Log Source #

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) Source #
Instance details 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 Source #

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 Source #

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

getLog :: Component -> Scope -> Log -> Log Source #

Get log for specified component and scope

subLog :: Component -> Scope -> Log -> Log Source #

Get sub-log

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

Read log config

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

Modify log config

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

Update log handlers, this restarts handlers thread

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

Write message to log for current component and scope

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

Wait log messages and stop log