System.Log.Caster

Basics

data LogMsg

Log message.

Constructors

LogMsg

Fields

• logMsgLevel :: LogLevel
• logMsgTime :: UnixTime
• logMsgBuilder :: Builder

broadcastLog :: LogQueue -> LogChan -> IO ()

Connect LogQueue and TChan LogMsg.

newtype LogQueue

Queue of LogMsg.

Constructors

LogQueue (TQueue LogMsg)

newLogQueue :: IO LogQueue

Make new LogQueue

newtype LogChan

Channel of LogMsg.

Constructors

LogChan (TChan LogMsg)

newLogChan :: IO LogChan

Make new LogChan.

type Formatter = LogMsg -> Builder

Formatter.

type Listener = LogMsg -> IO ()

IO function takes LogMsg.

relayLog :: LogChan -> LogLevel -> Listener -> IO ()

Listen LogChan and give the LogMsg to given Listener.

Listeners

stdoutListener :: Listener

Stdout listener.

stdoutListenerWith :: Formatter -> Listener

Stdout listener with Formatter.

terminalListener :: Listener

Terminal listener. Log levels are colored.

handleListener :: Formatter -> Handle -> Listener

Make Listener from Handle

handleListenerFlush :: Formatter -> Handle -> Listener

Make Listener flushing buffer after getting LogMsg

Formatter

defaultFormatter :: Formatter

Default log formatter.

terminalFormatter :: Formatter

Formatter for term. It provides colored logs.

terminalFormatterWith :: Builder -> Builder -> Builder -> Builder -> Builder -> Builder -> Builder -> Builder -> Formatter

Formatter with specified colors for log levels. Parameters are just FB.Builder, so you can decorate as you like with ansi escaping.

Log levels

data LogLevel

Log levels. These are matched to syslog.

Constructors

LogDebug

LogInfo

LogNotice

LogWarn

LogError

LogCritical

LogAlert

LogEmergency

Instances

Eq LogLevel

Defined in System.Log.Caster.Core

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Defined in System.Log.Caster.Core

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

Show LogLevel

Defined in System.Log.Caster.Core

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

logAs :: (MonadIO m, ToBuilder s) => LogQueue -> LogLevel -> s -> m ()

Push a message to LogQueue.

debug :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

info :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

notice :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

warn :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

err :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

critical :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

alert :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

emergency :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

Useful string class and operator

class ToBuilder a where

Types which are able to be converted into Builder Builder toBuilde encodes String and Text as utf-8.

Methods

toBuilder :: a -> Builder

Instances

Show a => ToBuilder a

Defined in System.Log.Caster.Core

Methods

toBuilder :: a -> Builder

ToBuilder String

Defined in System.Log.Caster.Core

Methods

toBuilder :: String -> Builder

ToBuilder ByteString

Defined in System.Log.Caster.Core

Methods

toBuilder :: ByteString -> Builder

ToBuilder ByteString

Defined in System.Log.Caster.Core

Methods

toBuilder :: ByteString -> Builder

ToBuilder Builder

Defined in System.Log.Caster.Core

Methods

toBuilder :: Builder -> Builder0

ToBuilder Builder

Defined in System.Log.Caster.Core

Methods

toBuilder :: Builder -> Builder

ToBuilder Text

Defined in System.Log.Caster.Core

Methods

toBuilder :: Text -> Builder

ToBuilder Text

Defined in System.Log.Caster.Core

Methods

toBuilder :: Text -> Builder

fix :: Builder -> Builder

If you turn OverloadedStrings extension on, GHC can't deduce the type of string literal. This function fix the type to Builder Builder without type annotation.

($:) :: ToBuilder b => (Builder -> b) -> Builder -> b infixr 0

Infix version of fix.

(<:>) :: (ToBuilder a, ToBuilder b) => a -> b -> Builder infixr 6

Concat ToBuilder strings as Builder Builder.