Network.Mattermost.Logging

Logging-Related Types

type Logger = LogEvent -> IO ()

A Logger is any function which responds to log events:

data LogEvent

If there is a Logger in the ConnectionData struct, it will be sporadically called with values of type LogEvent.

Constructors

LogEvent

Fields

• logFunction :: String
• logEventType :: LogEventType

Instances

Eq LogEvent

Methods

(==) :: LogEvent -> LogEvent -> Bool

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

Show LogEvent

Methods

showsPrec :: Int -> LogEvent -> ShowS

show :: LogEvent -> String

showList :: [LogEvent] -> ShowS

data LogEventType

A LogEventType describes the particular event that happened

Constructors

HttpRequest RequestMethod String (Maybe Value)

HttpResponse Int String (Maybe Value)

WebSocketRequest Value

WebSocketResponse (Either String Value)

Left means we got an exception trying to parse the response; Right means we succeeded and here it is.

WebSocketPing

WebSocketPong

Instances

Eq LogEventType

Methods

(==) :: LogEventType -> LogEventType -> Bool

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

Show LogEventType

Methods

showsPrec :: Int -> LogEventType -> ShowS

show :: LogEventType -> String

showList :: [LogEventType] -> ShowS

Basic Loggers

mmLoggerInfo :: Handle -> Logger

mmLoggerInfo prints which calls are happening and which endpoints are being hit, but without the payloads.

mmLoggerInfoFilter :: (LogEvent -> Bool) -> Handle -> Logger

mmLoggerInfoFilter is the same as mmLoggerInfo but takes a user-defined predicate that it uses to select which events to log before writing them to the provided Handle

mmLoggerDebug :: Handle -> Logger

mmLoggerDebug prints the full data of every logging event to the provided Handle.

mmLoggerDebugFilter :: (LogEvent -> Bool) -> Handle -> Logger

mmLoggerDebugFilter is the same as mmLoggerDebug but takes a user-defined predicate that it uses to select which events to log before writing them to the provided Handle

stderr variants

mmLoggerInfoErr :: Logger

mmLoggerInfoErr prints request/response data without payloads to stderr

mmLoggerInfoFilterErr :: (LogEvent -> Bool) -> Logger

mmLoggerInfoFilterErr takes a user-defined predicate that it uses to select which events to log before logging them to stderr.

mmLoggerDebugErr :: Logger

mmLoggerDebugErr prints the full data of every logging event to stderr.

mmLoggerDebugFilterErr :: (LogEvent -> Bool) -> Logger

mmLoggerDebugFilterErr takes a user-defined predicate that it uses to select which events to log before logging them to stderr.