HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulewai-extra-3.1.16Haskell2010

Network.Wai.Middleware.RequestLogger

  • 10 types
  • 11 values
  • Packagewai-extra-3.1.16
  • Exports21
  • LanguageHaskell2010
  • LicenceMIT
  • SourceRequestLogger.hs

Basic stdout logging

2 declarations

Create more versions

19 declarations

RequestLoggerSettings is an instance of Default. See Data.Default for more information.

outputFormat, autoFlush, and destination are record fields for the record type RequestLoggerSettings, so they can be used to modify settings values using record syntax.

Instances1Default
datadata ApacheSettings
#

Settings for the ApacheWithSettings OutputFormat. This is purposely kept as an abstract data type so that new settings can be added without breaking backwards compatibility. In order to create an ApacheSettings value, use defaultApacheSettings and the various 'setApache' functions to modify individual fields. For example:

setApacheIPAddrSource FromHeader defaultApacheSettings
datadata DetailedSettings
#

Settings for the Detailed OutputFormat.

mModifyParams allows you to pass a function to hide confidential information (such as passwords) from the logs. If result is Nothing, then the parameter is hidden. For example: > myformat = Detailed True (Just hidePasswords) > where hidePasswords p@(k,v) = if k = "password" then (k, "***REDACTED***") else p

mFilterRequests allows you to filter which requests are logged, based on the request and response.

Instances1Default
datadata IPAddrSource
#

Source from which the IP source address of the client is obtained.

Constructors

  • FromSocket

    From the peer address of the HTTP connection.

  • FromHeader

    From X-Real-IP or X-Forwarded-For in the HTTP header.

    This picks either X-Real-IP or X-Forwarded-For depending on which of these headers comes first in the ordered list of request headers.

    If the X-Forwarded-For header is picked, the value will be assumed to be a comma-separated list of IP addresses. The value will be parsed, and the left-most IP address will be used (which is mostly likely to be the actual client IP address).

  • FromHeaderCustom [HeaderName]

    From a custom HTTP header, useful in proxied environment.

    The header value will be assumed to be a comma-separated list of IP addresses. The value will be parsed, and the left-most IP address will be used (which is mostly likely to be the actual client IP address).

    Note that this still works as expected for a single IP address.

  • FromFallback

    Just like FromHeader, but falls back on the peer address if header is not found.

  • FromRequest (Request -> ByteString)

    This gives you the most flexibility to figure out the IP source address from the Request. The returned ByteString is used as the IP source address.