Network.Wai.Middleware.FilterLogger.Internal

Documentation

data FilterOptions

Options for controlling log filtering.

Constructors

FilterOptions

Fields

• detailed :: Bool

  Boolean value indicating whether to log output should be detailed or not. Details include the response size and request duration in ms. Default is True.

• logOnEmptyBody :: Bool

  Boolean value indicating whether to log messages when there is no request body. Default is True.

Instances

Default FilterOptions

Methods

def :: FilterOptions

class LogShowable a where

Typeclass for types that can be converted into a strict ByteString and be shown in a log.

Minimal complete definition

logShow

Methods

logShow :: a -> ByteString

Convert the type into a strict ByteString to be displayed in the logs.

Instances

LogShowable ByteString

Methods

logShow :: ByteString -> ByteString

LogShowable ByteString

Methods

logShow :: ByteString -> ByteString

logShowJSON :: ToJSON a => a -> ByteString

Helper function that can be used when you want to make an instance of ToJSON an instance of LogShowable. This helps avoid having to use UndecidableInstances.

logFilterJSON :: FromJSON a => ByteString -> Maybe a

Helper function that can be used when you want to make an instance of FromJSON an instance of LogFilterable. This helps avoid having to use UndecidableInstances.

class LogFilterable a where

Typeclass for types that can be converted into from a strict ByteString and will be used as arguments to LogFilter

Minimal complete definition

prep

Methods

prep :: ByteString -> Maybe a

Try to convert the type from a strict ByteString.

Instances

LogFilterable ByteString

Methods

prep :: ByteString -> Maybe ByteString

LogFilterable ByteString

Methods

prep :: ByteString -> Maybe ByteString

class (LogFilterable a, LogShowable a) => Loggable a

Helper Typeclass for types that implement both LogFilterable and LogShowable

Instances

Loggable ByteString

Loggable ByteString

type LogFilter a = a -> Maybe a

Type that represents a log filtering function. If the return type is Nothing, then no log message will be created. Otherwise, a log message will be created using the (potentially different) returned value.

mkDefaultFilterLogger :: Loggable a => LogFilter a -> Middleware

Make a filtering request logger with the default FilterOptions.

mkFilterLogger :: Loggable a => FilterOptions -> LogFilter a -> Middleware

Given a valid LogFilter and custom FilterOptions, construct a filtering request logger.