Skip to content

JAXRS metadata updates #15184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2025
Merged

JAXRS metadata updates #15184

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1cc1a4
JAXRS metadata updates
jaydeluca Oct 30, 2025
ae4245c
update verbiage
jaydeluca Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 39 additions & 9 deletions docs/instrumentation-list.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5300,8 +5300,12 @@ libraries:
- name: jaxrs-1.0
display_name: JAX-RS 1.x
description: |
This instrumentation enables spans for JAX-RS methods, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information and enables controller spans for JAX-RS annotated methods (this instrumentation is disabled by default).
Copy link
Contributor

@laurit laurit Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JAX-RS 2.x uses a slightly different wording controller spans are disabled by default which I think is better

Copy link
Contributor

@laurit laurit Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I don't know this instrumentation is disabled by default is also totally correct, your choice which you wish to use.

Copy link
Member Author

@jaydeluca jaydeluca Oct 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is where i am getting the "disabled by default" from: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jaxrs/jaxrs-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrs/v1_0/JaxrsInstrumentationModule.java#L44

Some of these JAX ones just use the controllerTelemetryEnabled flag to disable the instrumenter, while others also use this flag in the defaultEnabled method.

With that being said, you are right that this doesn't follow the pattern used elsewhere, i think it makes sense to switch to controller spans are disabled by default, and just use the disabled_by_default attribute for the other piece

library_link: https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/package-summary.html
disabled_by_default: true
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-1.0
scope:
name: io.opentelemetry.jaxrs-1.0
Expand All @@ -5325,8 +5329,12 @@ libraries:
- name: jaxrs-2.0-annotations
display_name: JAX-RS 2.x
description: |
This instrumentation enables spans for JAX-RS annotated methods, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS annotated methods (controller spans are disabled by default).
library_link: https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/package-summary.html
disabled_by_default: true
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-annotations
scope:
name: io.opentelemetry.jaxrs-2.0-annotations
Expand Down Expand Up @@ -5354,8 +5362,11 @@ libraries:
- name: jaxrs-2.0-cxf-3.2
display_name: Apache CXF JAX-RS 2.x
description: |
This instrumentation enables spans for JAX-RS methods when using Apache CXF, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS methods when using Apache CXF (controller spans are disabled by default).
library_link: https://cxf.apache.org/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2
scope:
name: io.opentelemetry.jaxrs-2.0-cxf-3.2
Expand Down Expand Up @@ -5394,8 +5405,11 @@ libraries:
- name: jaxrs-2.0-jersey-2.0
display_name: Eclipse Jersey JAX-RS 2.x
description: |
This instrumentation enables spans for JAX-RS methods when using Jersey, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS methods when using Jersey (controller spans are disabled by default).
library_link: https://eclipse-ee4j.github.io/jersey/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-jersey-2.0
scope:
name: io.opentelemetry.jaxrs-2.0-jersey-2.0
Expand Down Expand Up @@ -5434,8 +5448,11 @@ libraries:
- name: jaxrs-2.0-resteasy-3.0
display_name: JBoss RESTEasy JAX-RS 2.x
description: |
This instrumentation enables spans for JAX-RS methods when using RESTEasy, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS methods when using RESTEasy (controller spans are disabled by default).
library_link: https://resteasy.dev/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-resteasy-3.0
scope:
name: io.opentelemetry.jaxrs-2.0-resteasy-3.0
Expand Down Expand Up @@ -5474,8 +5491,11 @@ libraries:
- name: jaxrs-2.0-resteasy-3.1
display_name: JBoss RESTEasy JAX-RS 2.x
description: |
This instrumentation enables spans for JAX-RS methods when using RESTEasy, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS methods when using RESTEasy (controller spans are disabled by default).
library_link: https://resteasy.dev/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-resteasy-3.1
scope:
name: io.opentelemetry.jaxrs-2.0-resteasy-3.1
Expand Down Expand Up @@ -5514,8 +5534,12 @@ libraries:
- name: jaxrs-3.0-annotations
display_name: JAX-RS 3.x
description: |
This instrumentation enables spans for JAX-RS annotated methods, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS annotated methods (controller spans are disabled by default).
library_link: https://jakarta.ee/specifications/restful-ws/3.0/
disabled_by_default: true
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-annotations
scope:
name: io.opentelemetry.jaxrs-3.0-annotations
Expand Down Expand Up @@ -5543,8 +5567,11 @@ libraries:
- name: jaxrs-3.0-jersey-3.0
display_name: Eclipse Jersey JAX-RS 3.x
description: |
This instrumentation enables spans for JAX-RS methods when using Jersey, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS methods when using Jersey (controller spans are disabled by default).
library_link: https://eclipse-ee4j.github.io/jersey/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-jersey-3.0
minimum_java_version: 11
scope:
Expand Down Expand Up @@ -5583,8 +5610,11 @@ libraries:
- name: jaxrs-3.0-resteasy-6.0
display_name: JBoss RESTEasy JAX-RS 3.x
description: |
This instrumentation enables spans for JAX-RS methods when using RESTEasy, and enriches existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller spans for JAX-RS methods when using RESTEasy (controller spans are disabled by default).
library_link: https://resteasy.dev/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
source_path: instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-resteasy-6.0
minimum_java_version: 11
scope:
Expand Down
8 changes: 6 additions & 2 deletions instrumentation/jaxrs/jaxrs-1.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
display_name: JAX-RS 1.x
description: >
This instrumentation enables spans for JAX-RS methods, and enriches existing HTTP server spans
with route information.
This instrumentation enriches HTTP server spans with route information and enables controller
spans for JAX-RS annotated methods (this instrumentation is disabled by default).
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
disabled_by_default: true
library_link: https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/package-summary.html
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
Expand Down
8 changes: 6 additions & 2 deletions instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-annotations/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
display_name: JAX-RS 2.x
description: >
This instrumentation enables spans for JAX-RS annotated methods, and enriches existing HTTP server
spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS annotated methods (controller spans are disabled by default).
library_link: https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/package-summary.html
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
disabled_by_default: true
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
7 changes: 5 additions & 2 deletions instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-cxf-3.2/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
display_name: Apache CXF JAX-RS 2.x
description: >
This instrumentation enables spans for JAX-RS methods when using Apache CXF, and enriches
existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS methods when using Apache CXF (controller spans are disabled by default).
library_link: https://cxf.apache.org/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
7 changes: 5 additions & 2 deletions instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-jersey-2.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
display_name: Eclipse Jersey JAX-RS 2.x
description: >
This instrumentation enables spans for JAX-RS methods when using Jersey, and enriches
existing HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS methods when using Jersey (controller spans are disabled by default).
library_link: https://eclipse-ee4j.github.io/jersey/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
7 changes: 5 additions & 2 deletions instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-resteasy-3.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
display_name: JBoss RESTEasy JAX-RS 2.x
description: >
This instrumentation enables spans for JAX-RS methods when using RESTEasy, and enriches existing
HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS methods when using RESTEasy (controller spans are disabled by default).
library_link: https://resteasy.dev/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
7 changes: 5 additions & 2 deletions instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-resteasy-3.1/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
display_name: JBoss RESTEasy JAX-RS 2.x
description: >
This instrumentation enables spans for JAX-RS methods when using RESTEasy, and enriches existing
HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS methods when using RESTEasy (controller spans are disabled by default).
library_link: https://resteasy.dev/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
8 changes: 6 additions & 2 deletions instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-annotations/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
display_name: JAX-RS 3.x
description: >
This instrumentation enables spans for JAX-RS annotated methods, and enriches existing HTTP server
spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS annotated methods (controller spans are disabled by default).
library_link: https://jakarta.ee/specifications/restful-ws/3.0/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
disabled_by_default: true
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
7 changes: 5 additions & 2 deletions instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-jersey-3.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
display_name: Eclipse Jersey JAX-RS 3.x
description: >
This instrumentation enables spans for JAX-RS methods when using Jersey, and enriches existing
HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS methods when using Jersey (controller spans are disabled by default).
library_link: https://eclipse-ee4j.github.io/jersey/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
7 changes: 5 additions & 2 deletions instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-resteasy-6.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
display_name: JBoss RESTEasy JAX-RS 3.x
description: >
This instrumentation enables spans for JAX-RS methods when using RESTEasy, and enriches existing
HTTP server spans with route information.
This instrumentation enriches HTTP server spans with route information, and enables controller
spans for JAX-RS methods when using RESTEasy (controller spans are disabled by default).
library_link: https://resteasy.dev/
features:
- HTTP_ROUTE
- CONTROLLER_SPANS
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller spans.
Expand Down
Loading