Observe.Event.Render.JSON

Instrumentors will need to provide instances of RenderSelectorJSON and RenderFieldJSON for their domain-specific types to use their Events with JSON-consuming EventBackends.

Documentation

type RenderSelectorJSON sel = forall f. sel f -> (Key, RenderFieldJSON f)

A function to render a given selector, its fields, as JSON.

The Key is the event name/category.

type RenderFieldJSON field = field -> (Key, Value)

A function to render a given field as JSON.

The Key is a field name, the Value is an arbitrary rendering of the field value (if any).

Rendering structured exceptions

type RenderExJSON stex = stex -> Value

A function to render a given structured exception to JSON.

SomeJSONException

renderJSONException :: RenderExJSON SomeJSONException

Render a SomeJSONException to JSON.

It is not necessary to use SomeJSONException for the base of your structured exceptions in a JSON backend, so long as you provide a RenderExJSON for your base exception type.

data SomeJSONException

A possible base type for structured exceptions renderable to JSON.

It is not necessary to use SomeJSONException for the base of your structured exceptions in a JSON backend, so long as you provide a RenderExJSON for your base exception type.

Constructors

forall e.(Exception e, ToJSON e) => SomeJSONException e

Instances

Exception SomeJSONException

Defined in Observe.Event.Render.JSON

Methods

toException :: SomeJSONException -> SomeException

fromException :: SomeException -> Maybe SomeJSONException

displayException :: SomeJSONException -> String

Show SomeJSONException

Defined in Observe.Event.Render.JSON

Methods

showsPrec :: Int -> SomeJSONException -> ShowS

show :: SomeJSONException -> String

showList :: [SomeJSONException] -> ShowS

jsonExceptionToException :: (Exception e, ToJSON e) => e -> SomeException

Used to create sub-classes of SomeJSONException.

jsonExceptionFromException :: Exception e => SomeException -> Maybe e

Used to create sub-classes of SomeJSONException.

Observe.Event.Dynamic support

renderDynamicEventSelectorJSON :: RenderSelectorJSON DynamicEventSelector

Render a DynamicEventSelector and all its sub-fields.

renderDynamicFieldJSON :: RenderFieldJSON DynamicField

Render a DynamicField