JMS (Java Message Service)
OpenTelemetry Java agent instrumentation
This instrumentation enables messaging spans for Jakarta JMS (Java Message Service) message producers and consumers.
- Name:
jms-3.0 - Scope:
io.opentelemetry.jms-3.0 - Target versions:
jakarta.jms:jakarta.jms-api:[3.0.0,) - Library: https://jakarta.ee/specifications/messaging/3.0/
Telemetry
When otel.instrumentation.common.messaging.experimental.receive-telemetry.enabled=true
Spans
| Span kind | Attributes |
|---|---|
| CONSUMER | messaging.destination.name (STRING), messaging.message.id (STRING), messaging.operation (STRING), messaging.system (STRING) |
| PRODUCER | messaging.destination.name (STRING), messaging.destination.temporary (BOOLEAN), messaging.message.id (STRING), messaging.operation (STRING), messaging.system (STRING) |
When otel.semconv-stability.preview=messaging
Metrics
| Metric | Instrument | Type | Unit | Description |
|---|---|---|---|---|
messaging.client.consumed.messages | counter | LONG_SUM | {message} | Number of messages that were delivered to the application. |
messaging.client.operation.duration | histogram | HISTOGRAM | s | Duration of messaging operation initiated by a producer or consumer client. |
messaging.client.sent.messages | counter | LONG_SUM | {message} | Number of messages producer attempted to send to the broker. |
messaging.process.duration | histogram | HISTOGRAM | s | Duration of processing operation. |
| Metric | Attributes |
|---|---|
messaging.client.consumed.messages | messaging.destination.name (STRING), messaging.operation.name (STRING), messaging.system (STRING) |
messaging.client.operation.duration | messaging.destination.name (STRING), messaging.operation.name (STRING), messaging.operation.type (STRING), messaging.system (STRING) |
messaging.client.sent.messages | messaging.destination.name (STRING), messaging.operation.name (STRING), messaging.system (STRING) |
messaging.process.duration | messaging.destination.name (STRING), messaging.operation.name (STRING), messaging.system (STRING) |
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | messaging.destination.name (STRING), messaging.destination.subscription.name (STRING), messaging.message.id (STRING), messaging.operation.name (STRING), messaging.operation.type (STRING), messaging.system (STRING) |
| CONSUMER | messaging.destination.name (STRING), messaging.destination.subscription.name (STRING), messaging.message.id (STRING), messaging.operation.name (STRING), messaging.operation.type (STRING), messaging.system (STRING) |
| PRODUCER | messaging.destination.name (STRING), messaging.destination.temporary (BOOLEAN), messaging.message.id (STRING), messaging.operation.name (STRING), messaging.operation.type (STRING), messaging.system (STRING) |
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
otel.instrumentation.messaging.experimental.capture-headers | list | Deprecated: use otel.instrumentation.common.messaging.headers.included instead. Ignored without a warning under v3-preview; may be removed in a later minor release and will be removed no later than 3.0. A comma-separated list of header names to capture as span attributes. It does not support glob patterns: an entry containing * or ? is ignored with a warning, and every other entry is matched as a literal header name. | |
otel.instrumentation.messaging.experimental.headers.excluded | list | Deprecated: use otel.instrumentation.common.messaging.headers.excluded instead. Ignored without a warning under v3-preview; may be removed in a later minor release and will be removed no later than 3.0. | |
otel.instrumentation.messaging.experimental.headers.included | list | Deprecated: use otel.instrumentation.common.messaging.headers.included instead. Ignored without a warning under v3-preview; may be removed in a later minor release and will be removed no later than 3.0. | |
otel.instrumentation.messaging.experimental.receive-telemetry.enabled | boolean | false | Deprecated: use otel.instrumentation.common.messaging.experimental.receive-telemetry.enabled instead. It may be removed in the next minor release. |
otel.instrumentation.common.messaging.headers.excluded | list | A comma-separated list of case-sensitive message header name glob patterns to exclude from span attributes. ? matches one character and * matches zero or more characters. Excluded patterns take precedence over included patterns. An absent or empty selector captures no headers; an exclude-only selector captures every header not excluded, which may expose sensitive information. | |
otel.instrumentation.common.messaging.headers.included | list | A comma-separated list of case-sensitive message header name glob patterns to capture as span attributes. ? matches one character and * matches zero or more characters. Excluded patterns take precedence over included patterns. An absent or empty selector captures no headers; an exclude-only selector captures every header not excluded. | |
otel.instrumentation.common.messaging.experimental.receive-telemetry.enabled | boolean | false | Enables experimental receive telemetry, which will cause consumers to start a new trace, with only a span link connecting it to the producer trace. |
Data
- JSON (latest): /data/javaagent/instrumentations/jms-3.0/latest.json
- JSON (pinned): /data/javaagent/instrumentations/jms-3.0/jms-3.0-bcbd024e3479.json
- Explore: /java-agent/instrumentation/jms-3.0