OpenTelemetry

OpenTelemetry metrics and tracing for Queuert job chains.

Queuert provides an OpenTelemetry adapter for metrics and tracing. Configure your OTEL SDK with desired exporters (Prometheus, OTLP, Jaeger, etc.) before using this adapter.

Install

Terminal

npm install @queuert/otel

Setup

Create the observability adapter with your OTEL meter and tracer:

src/observability.ts

export const observabilityAdapter = createOtelObservabilityAdapter({
  meter: metrics.getMeter("queuert"),
  tracer: trace.getTracer("queuert"),
});

Pass it as the observabilityAdapter option when creating your client:

src/index.ts

const client = createClient({
  stateAdapter,
  observabilityAdapter,
  jobTypes,
});

Configuration

createOtelObservabilityAdapter options

  • meter Meter optional
    Metrics disabled if omitted.
  • tracer Tracer optional
    Tracing disabled if omitted.

What it emits

  • Counters
    Worker lifecycle, job attempts, completions, errors.
  • Histograms
    Job duration, chain duration, attempt duration.
  • Gauges
    Idle workers per job type, jobs being processed.
  • Spans
    PRODUCER spans for job creation and CONSUMER spans for processing, with span kinds modeled on OpenTelemetry messaging conventions.

Examples

OpenTelemetry

  • observability/otel @queuert/otel
    GitHub
    @queuert/otel wiring for distributed tracing and metrics, viewed in otel-tui.
    Terminal 1: OTLP receiver$ pnpm --filter example-observability-otel tuiTerminal 2: example$ pnpm --filter example-observability-otel startsrc/observability.tssrc/index.ts
esc

Search guides, integrations and every exported symbol.

↑ ↓ to navigate↵ to open