Freckle.App.Wai

Integration of Freckle.App tooling with Network.Wai

Documentation

noCacheMiddleware :: Middleware

Middleware that adds header to disable all caching

denyFrameEmbeddingMiddleware :: Middleware

Middleware that adds header to deny all frame embedding

CORS

corsMiddleware

Arguments

:: (ByteString -> Bool)

Predicate that returns True for valid Origin values

-> [ByteString]

Extra headers to add to Expose-Headers

-> Middleware

Logs

requestLogger :: HasLogger env => env -> Middleware

Log requests (more accurately, responses) as they happen

In JSON format, logged messages look like:

{
  ...
  message: {
    text: "GET foobar => 200 OK",
    meta: {
      method: GET,
      path: "foobar",
      query: "?baz=bat&quix=quo",
      status: {
        code: 200,
        message: OK
      },
      durationMs: 1322.2,
      requestHeaders: {
        Authorization: "***",
        Accept: "text/html",
        Cookie: "***"
      },
      responseHeaders: {
        Set-Cookie: "***",
        Expires: "never"
      }
    }
  }
}

addThreadContextFromRequest :: (Request -> [Pair]) -> Middleware

addThreadContext, but have the Request available

Tracing

newOpenTelemetryWaiMiddleware :: IO Middleware

Deprecated: Use OpenTelemetry.Instrumentation.Wai.newOpenTelemetryWaiMiddleware

addThreadContextFromTracing :: Middleware

Middleware that adds trace context to logging context

Metrics

addThreadContextFromStatsTags :: HasStatsClient env => env -> Middleware

Add any tags in the ambient StatsClient to the logging context

requestStats :: HasStatsClient env => env -> (Request -> [(Text, Text)]) -> Middleware

Emit requests and response_time_ms metrics