Safe Haskell	None
Language	Haskell2010

Log.HttpRequest

Description

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

Synopsis

data Details
newtype Incoming = Incoming Details
newtype Outgoing = Outgoing Details
emptyDetails :: Details
method :: Details -> Maybe Text
host :: Details -> Maybe Text
path :: Details -> Maybe Text
queryString :: Details -> Maybe Text
headers :: Details -> Dict Text Text
httpVersion :: Details -> Maybe Text
endpoint :: Details -> Maybe Text
status :: Details -> Maybe Int

Documentation

data Details Source #

A type describing an http request.

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

Instances

Instances details

Generic Details Source #
Instance 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 Source #
Instance details Defined in Log.HttpRequest Methods toJSON :: Details -> Value # toEncoding :: Details -> Encoding # toJSONList :: [Details] -> Value # toEncodingList :: [Details] -> Encoding #
type Rep Details Source #
Instance details Defined in Log.HttpRequest type Rep Details = D1 ('MetaData "Details" "Log.HttpRequest" "nri-observability-0.1.1.4-inplace" '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 Source #

A wrapper around the Details type to indicate that we're reporting an incoming http, like a request sent from a frontend to an http server.

Constructors

Incoming Details

Instances

Instances details

ToJSON Incoming Source #
Instance details Defined in Log.HttpRequest Methods toJSON :: Incoming -> Value # toEncoding :: Incoming -> Encoding # toJSONList :: [Incoming] -> Value # toEncodingList :: [Incoming] -> Encoding #
TracingSpanDetails Incoming Source #
Instance details Defined in Log.HttpRequest Methods toTracingSpanDetails :: Incoming -> SomeTracingSpanDetails fromTracingSpanDetails :: SomeTracingSpanDetails -> Maybe Incoming

newtype Outgoing Source #

A wrapper around the Details type to indicate that this is an outgoing http request, for example a request we're making to an external weather API.

Constructors

Outgoing Details

Instances

Instances details

ToJSON Outgoing Source #
Instance details Defined in Log.HttpRequest Methods toJSON :: Outgoing -> Value # toEncoding :: Outgoing -> Encoding # toJSONList :: [Outgoing] -> Value # toEncodingList :: [Outgoing] -> Encoding #
TracingSpanDetails Outgoing Source #
Instance details Defined in Log.HttpRequest Methods toTracingSpanDetails :: Outgoing -> SomeTracingSpanDetails fromTracingSpanDetails :: SomeTracingSpanDetails -> Maybe Outgoing

emptyDetails :: Details Source #

An empty details value to be modified by you.

method :: Details -> Maybe Text Source #

The method of the http request.

host :: Details -> Maybe Text Source #

The host the http request is made to.

path :: Details -> Maybe Text Source #

The path portion of the request URI.

queryString :: Details -> Maybe Text Source #

The query string portion of the request URI.

headers :: Details -> Dict Text Text Source #

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

httpVersion :: Details -> Maybe Text Source #

The version of the http protocol used.

endpoint :: Details -> Maybe Text Source #

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 Source #

The response status of the request.