Log.HttpRequest

A module for creating great logs in code that send or receive HTTP requests.

Documentation

data Details

A type describing an http request.

emptyDetails
  { method = Just "GET"
  , host = Just "https://noredink.com"
  }

Instances

Generic Details

Defined in Log.HttpRequest

Associated Types

type Rep Details :: Type -> Type

Methods

from :: Details -> Rep Details x

to :: Rep Details x -> Details

ToJSON Details

Defined in Log.HttpRequest

Methods

toJSON :: Details -> Value

toEncoding :: Details -> Encoding

toJSONList :: [Details] -> Value

toEncodingList :: [Details] -> Encoding

type Rep Details

Defined in Log.HttpRequest

type Rep Details = D1 ('MetaData "Details" "Log.HttpRequest" "nri-observability-0.1.0.2-DKVCVriCJA7X1Wdjf2hNR" 'False) (C1 ('MetaCons "Details" 'PrefixI 'True) (((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Dict Text Text)) :*: S1 ('MetaSel ('Just "httpVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newtype Incoming

Constructors

Incoming Details

Instances

ToJSON Incoming

Defined in Log.HttpRequest

Methods

toJSON :: Incoming -> Value

toEncoding :: Incoming -> Encoding

toJSONList :: [Incoming] -> Value

toEncodingList :: [Incoming] -> Encoding

TracingSpanDetails Incoming

Defined in Log.HttpRequest

Methods

toTracingSpanDetails :: Incoming -> SomeTracingSpanDetails

fromTracingSpanDetails :: SomeTracingSpanDetails -> Maybe Incoming

newtype Outgoing

Constructors

Outgoing Details

Instances

ToJSON Outgoing

Defined in Log.HttpRequest

Methods

toJSON :: Outgoing -> Value

toEncoding :: Outgoing -> Encoding

toJSONList :: [Outgoing] -> Value

toEncodingList :: [Outgoing] -> Encoding

TracingSpanDetails Outgoing

Defined in Log.HttpRequest

Methods

toTracingSpanDetails :: Outgoing -> SomeTracingSpanDetails

fromTracingSpanDetails :: SomeTracingSpanDetails -> Maybe Outgoing

emptyDetails :: Details

An empty details value to be modified by you.

method :: Details -> Maybe Text

The method of the http request.

host :: Details -> Maybe Text

The host the http request is made to.

path :: Details -> Maybe Text

The path portion of the request URI.

queryString :: Details -> Maybe Text

The query string portion of the request URI.

headers :: Details -> Dict Text Text

The headers on the request. Do not pass headers with sensitive information in there, filter them out first!

httpVersion :: Details -> Maybe Text

The version of the http protocol used.

endpoint :: Details -> Maybe Text

The endpoint called. This is like the path, but with the dynamic parts of the path replaced with arguments.

For example: > path teethupperleft/12 > endpoint teeth:quadrant/:number

status :: Details -> Maybe Int

The response status of the request.