Skip to main content

JetstreamTrace

Defined in: src/otel/trace-kinds.ts:16

Enumeration of OpenTelemetry trace kinds this library can emit.

Each identifier is toggleable via otel.traces. Functional kinds (publish, consume, RPC client round-trip, dead letter) are enabled by default; infrastructure kinds (connection lifecycle, self-healing, provisioning, migration, shutdown) are opt-in.

Example​

JetstreamModule.forRoot({
    otel: {
      traces: [JetstreamTrace.Publish, JetstreamTrace.Consume, JetstreamTrace.ConnectionLifecycle],
    },
  })

Enumeration Members​

ConnectionLifecycle​

ConnectionLifecycle: "connection.lifecycle"

Defined in: src/otel/trace-kinds.ts:45

INTERNAL span spanning one NATS connection session. Emits events on connect, reconnect, disconnect. Default: OFF.

Consume​

Consume: "consume"

Defined in: src/otel/trace-kinds.ts:25

CONSUMER span around each message delivery to a handler. Retries produce separate spans with messaging.nats.message.delivery_count > 1. Default: ON.

DeadLetter​

DeadLetter: "dead_letter"

Defined in: src/otel/trace-kinds.ts:39

INTERNAL span emitted when a message exhausts maxDeliver and is dead-lettered. Captures the duration of the onDeadLetter callback. Default: ON.

Migration​

Migration: "migration"

Defined in: src/otel/trace-kinds.ts:57

INTERNAL span covering a destructive migration flow. Default: OFF.

Provisioning​

Provisioning: "provisioning"

Defined in: src/otel/trace-kinds.ts:54

INTERNAL span per stream or consumer provisioning / update at startup. Default: OFF.

Publish​

Publish: "publish"

Defined in: src/otel/trace-kinds.ts:18

PRODUCER span around each emit() / send() publish operation. Default: ON.

RpcClientSend​

RpcClientSend: "rpc.client.send"

Defined in: src/otel/trace-kinds.ts:32

CLIENT span covering a full RPC round-trip on the caller side (client.send() → reply received). Wraps the inner publish. Default: ON.

SelfHealing​

SelfHealing: "self_healing"

Defined in: src/otel/trace-kinds.ts:51

INTERNAL span per consumer recovery attempt following a transient failure (deleted consumer, missed heartbeat). Default: OFF.

Shutdown​

Shutdown: "shutdown"

Defined in: src/otel/trace-kinds.ts:60

INTERNAL span covering the graceful shutdown sequence. Default: OFF.