Skip to content
Queuert

Observability

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

  1. Install the package:

    Terminal window
    npm install @queuert/otel

  2. Create the observability adapter with your OTEL meter and tracer:

    import { createOtelObservabilityAdapter } from "@queuert/otel";
    import { metrics, trace } from "@opentelemetry/api";
    

    const observabilityAdapter = await createOtelObservabilityAdapter({
      meter: metrics.getMeter("my-app"), // Optional — metrics disabled if omitted
      tracer: trace.getTracer("my-app"), // Optional — tracing disabled if omitted
    });

  3. Pass the adapter when creating your client:

    const client = await createClient({
      stateAdapter,
      jobTypeRegistry,
      observabilityAdapter,
      log: createConsoleLog(),
    });

The adapter emits:

  • Counters: worker lifecycle, job attempts, completions, errors
  • Histograms: job duration, chain duration, attempt duration
  • Gauges: idle workers per job type, jobs being processed

Adapter architecture

Section titled “Adapter architecture”

The ObservabilityAdapter interface provides pluggable observability with two mechanisms:

  • Metrics — Counters, histograms, and gauges for quantitative monitoring. All methods accept primitive data types (strings, numbers, booleans) rather than domain objects, decoupling observability from internal types and ensuring stability across versions.
  • Tracing — Distributed spans for end-to-end visibility into job chain execution. Uses a handle-based lifecycle: startJobSpan and startAttemptSpan return handles for managing span lifecycle. Spans follow OpenTelemetry messaging conventions with PRODUCER spans for job creation and CONSUMER spans for processing.

When no adapter is provided, a noop implementation is used automatically, making observability fully opt-in.

Transactional guarantees

Section titled “Transactional guarantees”

See observability-otel for a complete example.

See Also

Section titled “See Also”