Safe Haskell	None
Language	Haskell2010

Web.Spock.Logging

Description

Request correlation and structured logging, independent of any logger library. Enable through sc_logging or use the middleware directly in a WAI application.

Documentation

data LoggingConfig Source #

Constructors

LoggingConfig

Fields

lc_logEvent :: LogEvent -> IO ()
lc_requestIdHeader :: HeaderName
lc_trustIncomingRequestId :: Bool
Opt in only behind a trusted proxy. Accepted values contain 1-128 ASCII letters, digits, dots, underscores, or hyphens; duplicates are rejected.
lc_generateRequestId :: IO Text
lc_logFailure :: SomeException -> IO ()
Called when the sink fails. Synchronous failures in logging callbacks cannot change responses. Asynchronous cancellation is always propagated.

defaultLoggingConfig :: (LogEvent -> IO ()) -> LoggingConfig Source #

data RequestContext Source #

Constructors

RequestContext
Fields rc_requestId :: Text rc_method :: Text rc_path :: Text Raw path only; excludes query strings, headers, and request bodies.

Instances

Instances details

Eq RequestContext Source #
Instance details Defined in Web.Spock.Logging Methods (==) :: RequestContext -> RequestContext -> Bool (/=) :: RequestContext -> RequestContext -> Bool
Show RequestContext Source #
Instance details Defined in Web.Spock.Logging Methods showsPrec :: Int -> RequestContext -> ShowS show :: RequestContext -> String showList :: [RequestContext] -> ShowS

data LogLevel Source #

Constructors

LogDebug
LogInfo
LogWarning
LogError

Instances

Instances details

Eq LogLevel Source #
Instance details Defined in Web.Spock.Logging Methods (==) :: LogLevel -> LogLevel -> Bool (/=) :: LogLevel -> LogLevel -> Bool
Show LogLevel Source #
Instance details Defined in Web.Spock.Logging Methods showsPrec :: Int -> LogLevel -> ShowS show :: LogLevel -> String showList :: [LogLevel] -> ShowS

data LogEvent Source #

Constructors

LogEvent
Fields le_time :: UTCTime le_request :: RequestContext le_event :: LogEventType

Instances

Instances details

Eq LogEvent Source #
Instance details Defined in Web.Spock.Logging Methods (==) :: LogEvent -> LogEvent -> Bool (/=) :: LogEvent -> LogEvent -> Bool
Show LogEvent Source #
Instance details Defined in Web.Spock.Logging Methods showsPrec :: Int -> LogEvent -> ShowS show :: LogEvent -> String showList :: [LogEvent] -> ShowS
ToJSON LogEvent Source #
Instance details Defined in Web.Spock.Logging Methods toJSON :: LogEvent -> Value toEncoding :: LogEvent -> Encoding toJSONList :: [LogEvent] -> Value toEncodingList :: [LogEvent] -> Encoding omitField :: LogEvent -> Bool

data LogEventType Source #

Constructors

AccessLog Int Word64	Status and elapsed microseconds until the response is available. Streaming body transmission is not included in the duration.
MessageLog LogLevel Text [(Text, Value)]
ErrorLog Text

Instances

Instances details

Eq LogEventType Source #
Instance details Defined in Web.Spock.Logging Methods (==) :: LogEventType -> LogEventType -> Bool (/=) :: LogEventType -> LogEventType -> Bool
Show LogEventType Source #
Instance details Defined in Web.Spock.Logging Methods showsPrec :: Int -> LogEventType -> ShowS show :: LogEventType -> String showList :: [LogEventType] -> ShowS

data RequestLogger Source #

newRequestLogger :: LoggingConfig -> IO RequestLogger Source #

requestLoggingMiddleware :: RequestLogger -> Middleware Source #

lookupRequestLogger :: RequestLogger -> Request -> Maybe (RequestContext, LogEventType -> IO ()) Source #

emitRequestLog :: RequestLogger -> RequestContext -> LogEventType -> IO () Source #