cardano-wallet-core-2022.7.1: The Wallet Backend for a Cardano node.
Safe Haskell None
Language Haskell2010

Network.Wai.Middleware.Logging

Synopsis

Middleware

withApiLogger :: Tracer IO ApiLog -> ApiLoggerSettings -> Middleware Source #

Installs a request & response logger on a Wai application.

The logger logs requests' and responses' bodies along with a few other useful piece of information.

Settings

newApiLoggerSettings :: IO ApiLoggerSettings Source #

Create a new opaque ApiLoggerSettings

data ApiLoggerSettings Source #

API logger settings

obfuscateKeys :: ( Request -> [ Text ]) -> ApiLoggerSettings -> ApiLoggerSettings Source #

Define a set of top-level object keys that should be obfuscated for a given request in a JSON format.

data HandlerLog Source #

Tracer events related to the handling of a single request.

Constructors

LogRequestStart
LogRequest Request
LogRequestBody [ Text ] ByteString

Request content, with list of sensitive json keys.

LogResponse NominalDiffTime Request ( Maybe Status )
LogResponseBody ByteString
LogRequestFinish

Instances

Instances details
Show HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

showsPrec :: Int -> HandlerLog -> ShowS Source #

show :: HandlerLog -> String Source #

showList :: [ HandlerLog ] -> ShowS Source #

Generic HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Associated Types

type Rep HandlerLog :: Type -> Type Source #

Methods

from :: HandlerLog -> Rep HandlerLog x Source #

to :: Rep HandlerLog x -> HandlerLog Source #

ToJSON HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

toJSON :: HandlerLog -> Value Source #

toEncoding :: HandlerLog -> Encoding Source #

toJSONList :: [ HandlerLog ] -> Value Source #

toEncodingList :: [ HandlerLog ] -> Encoding Source #

ToText HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

toText :: HandlerLog -> Text Source #

HasPrivacyAnnotation HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

getPrivacyAnnotation :: HandlerLog -> PrivacyAnnotation

HasSeverityAnnotation HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

getSeverityAnnotation :: HandlerLog -> Severity

type Rep HandlerLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

type Rep HandlerLog = D1 (' MetaData "HandlerLog" "Network.Wai.Middleware.Logging" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) (( C1 (' MetaCons "LogRequestStart" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: ( C1 (' MetaCons "LogRequest" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Request )) :+: C1 (' MetaCons "LogRequestBody" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ Text ]) :*: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )))) :+: ( C1 (' MetaCons "LogResponse" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 NominalDiffTime ) :*: ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Request ) :*: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Status )))) :+: ( C1 (' MetaCons "LogResponseBody" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )) :+: C1 (' MetaCons "LogRequestFinish" ' PrefixI ' False ) ( U1 :: Type -> Type ))))

data ApiLog Source #

API handler trace events are associated with a unique request ID.

Constructors

ApiLog

Fields

Instances

Instances details
Show ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

showsPrec :: Int -> ApiLog -> ShowS Source #

show :: ApiLog -> String Source #

showList :: [ ApiLog ] -> ShowS Source #

Generic ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Associated Types

type Rep ApiLog :: Type -> Type Source #

Methods

from :: ApiLog -> Rep ApiLog x Source #

to :: Rep ApiLog x -> ApiLog Source #

ToJSON ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

toJSON :: ApiLog -> Value Source #

toEncoding :: ApiLog -> Encoding Source #

toJSONList :: [ ApiLog ] -> Value Source #

toEncodingList :: [ ApiLog ] -> Encoding Source #

FromJSON ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

parseJSON :: Value -> Parser ApiLog Source #

parseJSONList :: Value -> Parser [ ApiLog ] Source #

ToText ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

toText :: ApiLog -> Text Source #

HasPrivacyAnnotation ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

getPrivacyAnnotation :: ApiLog -> PrivacyAnnotation

HasSeverityAnnotation ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

getSeverityAnnotation :: ApiLog -> Severity

ToObject ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

toObject :: TracingVerbosity -> ApiLog -> Object

textTransformer :: ApiLog -> Object -> Text

type Rep ApiLog Source #
Instance details

Defined in Network.Wai.Middleware.Logging

type Rep ApiLog = D1 (' MetaData "ApiLog" "Network.Wai.Middleware.Logging" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ApiLog" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "requestId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 RequestId ) :*: S1 (' MetaSel (' Just "logMsg") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 HandlerLog )))

newtype RequestId Source #

Just a wrapper for readability

Constructors

RequestId Integer

Instances

Instances details
Eq RequestId Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

(==) :: RequestId -> RequestId -> Bool Source #

(/=) :: RequestId -> RequestId -> Bool Source #

Show RequestId Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

showsPrec :: Int -> RequestId -> ShowS Source #

show :: RequestId -> String Source #

showList :: [ RequestId ] -> ShowS Source #

Generic RequestId Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Associated Types

type Rep RequestId :: Type -> Type Source #

Methods

from :: RequestId -> Rep RequestId x Source #

to :: Rep RequestId x -> RequestId Source #

ToJSON RequestId Source #
Instance details

Defined in Network.Wai.Middleware.Logging

Methods

toJSON :: RequestId -> Value Source #

toEncoding :: RequestId -> Encoding Source #

toJSONList :: [ RequestId ] -> Value Source #

toEncodingList :: [ RequestId ] -> Encoding Source #

type Rep RequestId Source #
Instance details

Defined in Network.Wai.Middleware.Logging

type Rep RequestId = D1 (' MetaData "RequestId" "Network.Wai.Middleware.Logging" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "RequestId" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Integer )))