Skip to content
v9.1.1
Français

createOpenTelemetryObserver

import { createOpenTelemetryObserver } from "@elie-laloum/outpost/opentelemetry";

Purpose and behavior

Section titled “Purpose and behavior”

Create OpenTelemetry instrumentation from your tracer and meter. Attach its sink to the hub you pass as observation for parented workflow, task, dispatch and operation spans, or pass the observer as telemetry to workflow.start() or dispatch(). Instrumentation errors go to onError; close() ends open spans without flushing or shutting down the SDK.

Complete example and detailed rules.

Parameters and properties

Section titled “Parameters and properties”
  • optionsRequired
    OpenTelemetryOptions
    Injected tracer, meter and isolated error callback for workflow and dispatch telemetry.
  • options.tracerRequired
    Tracer
    OpenTelemetry tracer used to create execution spans.
  • options.meterRequired
    Meter
    OpenTelemetry meter for Outpost execution counters, duration histograms and token counters (outpost.workflow., outpost.task., outpost.dispatch.*, outpost.agent.tokens).
  • options.onErrorOptional
    ((error: unknown) => void) | undefined
    Receives errors thrown by the tracer or meter while recording workflows and dispatches; they never change a run’s outcome. Errors thrown by onError are ignored.

Returns

Section titled “Returns”

OpenTelemetryObserver

Signature

Section titled “Signature”
export declare function createOpenTelemetryObserver(
  options: OpenTelemetryOptions,
): OpenTelemetryObserver;
Section titled “Related contracts”