Safe Haskell	None
Language	Haskell2010

Colog.Json.Internal.Structured

Contents

Log datastructure.
Internals.

Description

Structure for tracing context.

We assume that each message (Message) can be tagged with two types of values:

segment - path that tells where are we in the codebase.
attrbibutes - additional key-value tags, where value is an arbitrary json object.

Segment is needed in a case if we want to apply differrent logging rules to the differrent parts of the codebase. For example we may way to log all the messages in the component one but not all the rest.

In addition each Message provides some common fields:

"thread" - id of the thread that emits message
"severity" - message severity

All messages in the same context share segment and attributes. So when exported to the log analytics systems it's easy to load all the information associated with it.

*Compatibility note** internal structure of the message may be changed in the future in case if it's proven that another implementation is faster or more memory efficient. However the higher level API is likely to be stable.

Synopsis

data Structured
- = Segment Text
- | Attr Text Encoding
data Message = Message {
- message_severity :: Severity
- thread_id :: Int
- attributes :: Seq Structured
- message :: LogStr
}
newtype LogStr = LogStr Builder
newtype PushContext = PushContext (Seq Structured -> Seq Structured)
data Severity
- = DebugS
- | InfoS
- | NoticeS
- | WarningS
- | ErrorS
- | CriticalS
- | AlertS
- | EmergencyS
encodeSeverity :: Severity -> Encoding
showLS :: Show a => a -> LogStr
ls :: StringConv a Text => a -> LogStr
sl :: ToJSON a => Text -> a -> PushContext
mkThreadId :: ThreadId -> Int

Log datastructure.

data Structured Source #

Part of the structured message.

Constructors

Segment Text	Part of the message that is associated this the context of code.
Attr Text Encoding	Add attribute to the list.

data Message Source #

Log message.

Constructors

Message
Fields message_severity :: Severity Message severity. thread_id :: Int Thread that emitted message. attributes :: Seq Structured List of attributes associated with the context. message :: LogStr Message to log.

newtype LogStr Source #

Efficient message builder.

Constructors

LogStr Builder

Instances

Instances details

IsString LogStr Source #
Instance details Defined in Colog.Json.Internal.Structured Methods fromString :: String -> LogStr #
Semigroup LogStr Source #
Instance details Defined in Colog.Json.Internal.Structured Methods (<>) :: LogStr -> LogStr -> LogStr # sconcat :: NonEmpty LogStr -> LogStr # stimes :: Integral b => b -> LogStr -> LogStr #
Monoid LogStr Source #
Instance details Defined in Colog.Json.Internal.Structured Methods mempty :: LogStr # mappend :: LogStr -> LogStr -> LogStr # mconcat :: [LogStr] -> LogStr #

newtype PushContext Source #

Wrapper over the structured message builder.

Constructors

PushContext (Seq Structured -> Seq Structured)

Internals.

data Severity Source #

Logger severity.

Constructors

DebugS	Debug level, intended for internal information
InfoS	Info level, that may be interesting to the user
NoticeS	Notice, information that
WarningS	Warning, information possible problem problem of some sort
ErrorS	Error, information about a problem
CriticalS	Critical error, intended for error that may break the system
AlertS	Critical error where immediate actions should be taken
EmergencyS	System wide emergency

Instances

Instances details

Bounded Severity Source #
Instance details Defined in Colog.Json.Internal.Structured Methods minBound :: Severity # maxBound :: Severity #
Enum Severity Source #
Instance details Defined in Colog.Json.Internal.Structured Methods succ :: Severity -> Severity # pred :: Severity -> Severity # toEnum :: Int -> Severity # fromEnum :: Severity -> Int # enumFrom :: Severity -> [Severity] # enumFromThen :: Severity -> Severity -> [Severity] # enumFromTo :: Severity -> Severity -> [Severity] # enumFromThenTo :: Severity -> Severity -> Severity -> [Severity] #
Eq Severity Source #
Instance details Defined in Colog.Json.Internal.Structured Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Ord Severity Source #
Instance details Defined in Colog.Json.Internal.Structured Methods compare :: Severity -> Severity -> Ordering # (<) :: Severity -> Severity -> Bool # (<=) :: Severity -> Severity -> Bool # (>) :: Severity -> Severity -> Bool # (>=) :: Severity -> Severity -> Bool # max :: Severity -> Severity -> Severity # min :: Severity -> Severity -> Severity #
Show Severity Source #
Instance details Defined in Colog.Json.Internal.Structured Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #

encodeSeverity :: Severity -> Encoding Source #

Convert severity into the one accepted by the loger.

showLS :: Show a => a -> LogStr Source #

Convert loggable value from any message that has show instance.

ls :: StringConv a Text => a -> LogStr Source #

Convert message can be converted.

sl :: ToJSON a => Text -> a -> PushContext Source #

"Simple logger" adds a key value to the context:

sl "foo" 123

Will add "foo":123 key pair to the current list of the attributes. Submitted value is stored with json encoding.

mkThreadId :: ThreadId -> Int Source #

Helper function to get id of the thread.