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

Defined in System.Logger.Message

Methods

bytes :: Bool -> Builder

ToBytes Char

Defined in System.Logger.Message

Methods

bytes :: Char -> Builder

ToBytes Double

Defined in System.Logger.Message

Methods

bytes :: Double -> Builder

ToBytes Float

Defined in System.Logger.Message

Methods

bytes :: Float -> Builder

ToBytes Int

Defined in System.Logger.Message

Methods

bytes :: Int -> Builder

ToBytes Int8

Defined in System.Logger.Message

Methods

bytes :: Int8 -> Builder

ToBytes Int16

Defined in System.Logger.Message

Methods

bytes :: Int16 -> Builder

ToBytes Int32

Defined in System.Logger.Message

Methods

bytes :: Int32 -> Builder

ToBytes Int64

Defined in System.Logger.Message

Methods

bytes :: Int64 -> Builder

ToBytes Integer

Defined in System.Logger.Message

Methods

bytes :: Integer -> Builder

ToBytes Word

Defined in System.Logger.Message

Methods

bytes :: Word -> Builder

ToBytes Word8

Defined in System.Logger.Message

Methods

bytes :: Word8 -> Builder

ToBytes Word16

Defined in System.Logger.Message

Methods

bytes :: Word16 -> Builder

ToBytes Word32

Defined in System.Logger.Message

Methods

bytes :: Word32 -> Builder

ToBytes Word64

Defined in System.Logger.Message

Methods

bytes :: Word64 -> Builder

ToBytes ByteString

Defined in System.Logger.Message

Methods

bytes :: ByteString -> Builder

ToBytes ByteString

Defined in System.Logger.Message

Methods

bytes :: ByteString -> Builder

ToBytes Text

Defined in System.Logger.Message

Methods

bytes :: Text -> Builder

ToBytes Text

Defined in System.Logger.Message

Methods

bytes :: Text -> Builder

ToBytes Builder

Defined in System.Logger.Message

Methods

bytes :: Builder -> Builder

ToBytes [Char]

Defined in System.Logger.Message

Methods

bytes :: [Char] -> Builder

data Msg

Type representing log messages.

data Builder

Instances

IsString Builder

Defined in System.Logger.Message

Methods

fromString :: String -> Builder

Semigroup Builder

Defined in System.Logger.Message

Methods

(<>) :: Builder -> Builder -> Builder

sconcat :: NonEmpty Builder -> Builder

stimes :: Integral b => b -> Builder -> Builder

Monoid Builder

Defined in System.Logger.Message

Methods

mempty :: Builder

mappend :: Builder -> Builder -> Builder

mconcat :: [Builder] -> Builder

ToBytes Builder

Defined in System.Logger.Message

Methods

bytes :: Builder -> Builder

data Element

Constructors

Bytes Builder

Field Builder 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

builderSize :: Builder -> Int

builderBytes :: Builder -> Builder

render :: ([Element] -> Builder) -> (Msg -> Msg) -> ByteString

Construct elements, call a renderer, and run the whole builder into a ByteString.

renderDefault :: ByteString -> [Element] -> Builder

Simple Renderer with '=' between field names and values and a custom separator.

renderNetstr :: [Element] -> Builder

Renderer that uses netstring encoding for log lines.