System.Logger.Message

Msg and ToBytes assist in constructing log messages. For example:

> g <- new (setBufSize 1 . setOutput StdOut $ defSettings)
> info g $ msg "some text" ~~ "key" .= "value" ~~ "okay" .= True
2014-04-28T21:18:20Z, I, some text, key=value, okay=True
>

Documentation

class ToBytes a where

Convert some value to a Builder.

Methods

bytes :: a -> Builder

Instances

ToBytes Bool

ToBytes Char

ToBytes Double

ToBytes Float

ToBytes Int

ToBytes Int8

ToBytes Int16

ToBytes Int32

ToBytes Int64

ToBytes Integer

ToBytes Word

ToBytes Word8

ToBytes Word16

ToBytes Word32

ToBytes Word64

ToBytes ByteString

ToBytes ByteString

ToBytes Text

ToBytes Text

ToBytes Builder

ToBytes [Char]

data Msg

Type representing log messages.

data Builder

Instances

IsString Builder

Monoid Builder

ToBytes Builder

msg :: ToBytes a => a -> Msg -> Msg

Turn some value into a Msg.

field :: ToBytes a => ByteString -> a -> Msg -> Msg

Render some field, i.e. a key-value pair delimited by "=".

(.=) :: ToBytes a => ByteString -> a -> Msg -> Msg infixr 5

Alias of field.

(+++) :: (ToBytes a, ToBytes b) => a -> b -> Builder infixr 6

Concatenate two ToBytes values.

(~~) :: (b -> c) -> (a -> b) -> a -> c infixr 4

Alias of . with lowered precedence to allow combination with .= without requiring parentheses.

val :: ByteString -> Builder

Type restriction. Useful to disambiguate string literals when using OverloadedStrings pragma.

eval :: Builder -> ByteString

render :: ByteString -> Bool -> (Msg -> Msg) -> ByteString

Intersperse parts of the log message with the given delimiter and render the whole builder into a ByteString.

If the second parameter is set to True, netstrings encoding is used for the message elements. Cf. http://cr.yp.to/proto/netstrings.txt for details.