Logging.Class

Documentation

class Filterable a where

A class represents a common trait of filtering LogRecords

Methods

filter :: a -> LogRecord -> Bool

Instances

Filterable Filter

Defined in Logging.Filter

Methods

filter :: Filter -> LogRecord -> Bool

Filterable Sink

Defined in Logging.Sink

Methods

filter :: Sink -> LogRecord -> Bool

Filterable a => Filterable [a]

Defined in Logging.Class.Filterable

Methods

filter :: [a] -> LogRecord -> Bool

data SomeHandler where

Generalised Handler instance, it wraps all other Handler instances into one type.

The SomeHandler type is the root of the handler type hierarchy.

Constructors

SomeHandler :: Handler h => h -> SomeHandler

Instances

Eq SomeHandler

Defined in Logging.Class.Handler

Methods

(==) :: SomeHandler -> SomeHandler -> Bool

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

Handler SomeHandler

Defined in Logging.Class.Handler

Methods

open :: SomeHandler -> IO ()

emit :: SomeHandler -> LogRecord -> IO ()

close :: SomeHandler -> IO ()

handle :: SomeHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe SomeHandler

toHandler :: SomeHandler -> SomeHandler

HasType Format1 SomeHandler

Defined in Logging.Class.Handler

Methods

typed :: Lens SomeHandler SomeHandler Format1 Format1

getTyped :: SomeHandler -> Format1

setTyped :: Format1 -> SomeHandler -> SomeHandler

HasType Level SomeHandler

Defined in Logging.Class.Handler

Methods

typed :: Lens SomeHandler SomeHandler Level Level

getTyped :: SomeHandler -> Level

setTyped :: Level -> SomeHandler -> SomeHandler

HasType Filterer SomeHandler

Defined in Logging.Class.Handler

Methods

typed :: Lens SomeHandler SomeHandler Filterer Filterer

getTyped :: SomeHandler -> Filterer

setTyped :: Filterer -> SomeHandler -> SomeHandler

class (HasType Level a, HasType Filterer a, HasType Format1 a, Typeable a, Eq a) => Handler a where

A type class that abstracts the characteristics of a Handler

Minimal complete definition

emit

Methods

open :: a -> IO ()

Initialize the Handler instance

emit :: a -> LogRecord -> IO ()

Emit log event, prepare log data, and send to bancked.

e.g. 1) Format LogRecord into data in specific format (json, html, etc.), 2) write the data to a file or send the data to a server.

close :: a -> IO ()

Terminate the Handler instance

handle :: a -> LogRecord -> IO Bool

Handle LogRecord and decide whether to call emit.

The default implementation is to filter LogRecord by level and Handler's filterer, if rejected, do nothing and return False, otherwise call emit and return True.

Note: You can override the default implementation.

fromHandler :: SomeHandler -> Maybe a

toHandler :: a -> SomeHandler

Instances

Handler SomeHandler

Defined in Logging.Class.Handler

Methods

open :: SomeHandler -> IO ()

emit :: SomeHandler -> LogRecord -> IO ()

close :: SomeHandler -> IO ()

handle :: SomeHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe SomeHandler

toHandler :: SomeHandler -> SomeHandler

Handler TimeRotatingFileHandler

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

open :: TimeRotatingFileHandler -> IO ()

emit :: TimeRotatingFileHandler -> LogRecord -> IO ()

close :: TimeRotatingFileHandler -> IO ()

handle :: TimeRotatingFileHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe TimeRotatingFileHandler

toHandler :: TimeRotatingFileHandler -> SomeHandler

Handler StreamHandler

Defined in Logging.Handler.StreamHandler

Methods

open :: StreamHandler -> IO ()

emit :: StreamHandler -> LogRecord -> IO ()

close :: StreamHandler -> IO ()

handle :: StreamHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe StreamHandler

toHandler :: StreamHandler -> SomeHandler

Handler RotatingFileHandler

Defined in Logging.Handler.RotatingFileHandler

Methods

open :: RotatingFileHandler -> IO ()

emit :: RotatingFileHandler -> LogRecord -> IO ()

close :: RotatingFileHandler -> IO ()

handle :: RotatingFileHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe RotatingFileHandler

toHandler :: RotatingFileHandler -> SomeHandler

Handler FileHandler

Defined in Logging.Handler.FileHandler

Methods

open :: FileHandler -> IO ()

emit :: FileHandler -> LogRecord -> IO ()

close :: FileHandler -> IO ()

handle :: FileHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe FileHandler

toHandler :: FileHandler -> SomeHandler

class IsMessage a where

A class for datatypes that can be converted to log message.

Since: 0.8.0

Minimal complete definition

toMessage

Methods

toMessage :: a -> String

toMessageList :: [a] -> String

Instances

IsMessage Char

Defined in Logging.Class.Message

Methods

toMessage :: Char -> String

toMessageList :: [Char] -> String

IsMessage ByteString

Defined in Logging.Class.Message

Methods

toMessage :: ByteString -> String

toMessageList :: [ByteString] -> String

IsMessage ByteString

Defined in Logging.Class.Message

Methods

toMessage :: ByteString -> String

toMessageList :: [ByteString] -> String

IsMessage Text

Defined in Logging.Class.Message

Methods

toMessage :: Text -> String

toMessageList :: [Text] -> String

IsMessage Value

Defined in Logging.Class.Message

Methods

toMessage :: Value -> String

toMessageList :: [Value] -> String

IsMessage Text

Defined in Logging.Class.Message

Methods

toMessage :: Text -> String

toMessageList :: [Text] -> String

IsMessage SomeException

Defined in Logging.Class.Message

Methods

toMessage :: SomeException -> String

toMessageList :: [SomeException] -> String

IsMessage a => IsMessage [a]

Defined in Logging.Class.Message

Methods

toMessage :: [a] -> String

toMessageList :: [[a]] -> String