Observe.Event.Servant.Client

This module offers a variant of servant-client's ClientM which instruments all requests with Events. It also has miscellaneous helpers for instrumenting servant-client functionality in other ways.

ClientM

type ClientM em s = TransEventMonad (ReaderT (ClientEnv s)) (TransEventMonad (ExceptT ClientError) em)

A monad to use in place of ClientM to get instrumentation on requests.

Note that ClientM is only RunClient when the selector of the ambient EventBackend is s, see the instance under ClientEnv.

data ClientEnv s

An instrumented ClientEnv

Constructors

ClientEnv

Fields

• env :: !ClientEnv
• injectRunRequest :: !(InjectSelector RunRequest s)

Instances

(MonadIO (em r s), MonadWithEvent em) => RunClient (ClientM em s r s)

Defined in Observe.Event.Servant.Client

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> ClientM em s r s Response

throwClientError :: ClientError -> ClientM em s r s a

runClientM :: ClientM em s r s' a -> ClientEnv s -> em r s' (Either ClientError a)

Instrumented version of runClientM

Instrumentation

data RunRequest f where

Selector for events in ClientM

Constructors

RunRequest :: RunRequest RunRequestField

runRequestJSON :: RenderSelectorJSON RunRequest

Render a RunRequest and the fields of its selected events as JSON

data RunRequestField

A field for RunRequest events.

Constructors

ReqField Request

ResField Response

runRequestFieldJSON :: RenderFieldJSON RunRequestField

Render a RunRequestField as JSON.

Miscellaneous instrumentation

clientErrorJSON :: RenderFieldJSON ClientError

Render a ClientError, considered as an Event field, as JSON

responseJSON :: Response -> Bool -> Value

Render a Response as JSON, optionally forcing rendering the body even if it's large.