Observe.Event.Backend.OpenTelemetry

Documentation

data TracerEventBackend selector

An EventBackend built on a Tracer.

When no explicit parent is set, the backend will try to find a parent in the OpenTelemetry.Context.ThreadLocal Context. However, it will never update that Context, as the primitive EventBackend API has no way to determine if it's being consumed in a scoped context or one allowing for general interleaving.

When possible, events created with instantEvent will use the span event API. However, this requires a parent event (explicitly specified or found in the thread-local Context), so the backend will fallback to creating and finalizeing a new Span. If a span event is created, the resulting eventReference will be to its parent, as span events cannot be parents/links. Span events do not allow for non-parent links, so any causes are dropped; in the future, we may either add them as custom Attributes or fall back to a full span if any are specified.

Event Links are currently not given any attributes. In the future, arbitrary link metadata could be added to the core EventBackend API, in which case we could add a renderer for the link metadata type.

The underlying Tracer is responsible for timestamping.

Exceptions are recordExceptioned without any custom attributes. In the future, an Exception -> HashMap Text Attribute argument could be added, or arbitrary exception metadata added to finalizeEvent.

Constructors

TracerEventBackend

Fields

• tracer :: !Tracer

  The Tracer from hs-opentelemetry-api.

  See the hs-opentelemetry-sdk intialization docs for the typical way of getting a Tracer in your application.

• render :: !(RenderOTel selector)

  The domain-specific logic for translating Events rooted in a given selector.

Instances

(MonadIO m, ParametricFunctor m) => EventBackendIn m (TracerEventBackend selector)

Defined in Observe.Event.Backend.OpenTelemetry

Methods

newEvent :: TracerEventBackend selector -> EventParams (RootSelector (TracerEventBackend selector)) field (EventReference (BackendEvent (TracerEventBackend selector))) -> m (BackendEvent (TracerEventBackend selector) field)

newInstantEvent :: TracerEventBackend selector -> EventParams (RootSelector (TracerEventBackend selector)) field (EventReference (BackendEvent (TracerEventBackend selector))) -> m (EventReference (BackendEvent (TracerEventBackend selector)))

EventBackend (TracerEventBackend selector)

Defined in Observe.Event.Backend.OpenTelemetry

Associated Types

type BackendEvent (TracerEventBackend selector) :: Type -> Type

type RootSelector (TracerEventBackend selector) :: Type -> Type

type BackendEvent (TracerEventBackend selector)

Defined in Observe.Event.Backend.OpenTelemetry

type BackendEvent (TracerEventBackend selector)

type RootSelector (TracerEventBackend selector)

Defined in Observe.Event.Backend.OpenTelemetry

type RootSelector (TracerEventBackend selector) = selector

type RenderOTel selector = forall field. Selectors selector field -> OTelRendered field

The domain-specific logic for translating Events rooted in a given selector.

data OTelRendered field

The domain-specific logic for translating a specific Event with a given field type.

Constructors

OTelRendered

Fields

• eventName :: !Text

  The name of the event.

  See the "span name" section of the open-telemetry span documentation.

• eventKind :: !SpanKind

  The kind of span to create.

  See the SpanKind specification.

• renderField :: !(field -> HashMap Text Attribute)

  Render a field to a set of span attributes.

  Note especially the attribute naming guidelines.