Skip to content
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

Jump to bottom

docs: add other default disabled instrumentations #11908

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: add other default disabled instrumentations #11908

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c716500
docs: add other default disabled instrumentations
4o3F Jul 27, 2024
0c2b870
docs: add missing default disabled instrumentation
4o3F Aug 1, 2024
492ef21
docs: add explaination for instrument disabled by default
4o3F Oct 11, 2024
ae2623a
fix: fix markdownlint error
4o3F Oct 11, 2024
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
9 changes: 9 additions & 0 deletions docs/supported-libraries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,15 @@ For this reason, the following instrumentations are disabled by default:
- `jdbc-datasource` which creates spans whenever the `java.sql.DataSource#getConnection` method is called.
- `dropwizard-metrics` which might create a very low quality metrics data, because of lack of label/attribute support
in the Dropwizard metrics API.
- `jaxws-jws-api`
Copy link
Contributor

@laurit laurit Aug 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

jaxws-jws-api, mybatis, spring-ws and jaxrs are disabled because they create only internal spans that don't have any defined semantic conventions

- `mybatis`
- `spring-boot-actuator-autoconfigure`
Copy link
Contributor

Choose a reason for hiding this comment

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

This enables micrometer metric bridging, see #9762

- `spring-ws`
- `spring-batch`
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems there are other disabled instrumentations that you ignored. Such as micrometer.

opentelemetry-java-instrumentation/instrumentation/micrometer/micrometer-1.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/micrometer/v1_5/MicrometerInstrumentationModule.java

Line 26 in 70e4d05

public boolean defaultEnabled(ConfigProperties config) {

You can find all of them by searching public boolean defaultEnabled(ConfigProperties config) { and checking which one's default value is false.

Copy link
Author

Choose a reason for hiding this comment

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

Not sure whether I should include the internal instrumentations, but I've added all the others in 0c2b870

- `spring-security-config-webflux`
- `spring-security-config-servlet`
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these two don't really fit here. Although these instrumentations are disabled by default they are enabled when any of otel.instrumentation.common.enduser.id.enabled, otel.instrumentation.common.enduser.role.enabled or otel.instrumentation.common.enduser.scope.enabled is set.

- `jaxrs`
- `micrometer`
Copy link
Contributor

Choose a reason for hiding this comment

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

See #9762


To enable them, add the `otel.instrumentation.<name>.enabled` system property:
`-Dotel.instrumentation.jdbc-datasource.enabled=true`
Loading