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.

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

docs: add other default disabled instrumentations #11908

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

Conversation

4o3F
Copy link

@4o3F 4o3F commented Jul 27, 2024

The current disabled instrumentations section lack multiple instrumentations that has been disabled by default, I've added them to the list, but still need detailed explain why they are disabled.

@4o3F 4o3F requested a review from a team July 27, 2024 11:13
Copy link

linux-foundation-easycla bot commented Jul 27, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@github-actions github-actions bot requested a review from theletterf July 27, 2024 11:13
@@ -225,6 +225,9 @@ 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.
- `mybatis`
- `spring-boot-actuator-autoconfigure`
- `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.

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

Comment on lines 233 to 234
- `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.

- `spring-security-config-webflux`
- `spring-security-config-servlet`
- `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

@@ -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`
- `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

@@ -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

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

@jaydeluca
Copy link
Member

@zeitlinger had also proposed the idea of adding this information to the doc site too, if you are interested

@4o3F 4o3F requested a review from a team as a code owner October 11, 2024 03:06
@4o3F
Copy link
Author

4o3F commented Oct 11, 2024

@zeitlinger had also proposed the idea of adding this information to the doc site too, if you are interested

I'll make changes to the site docs as soon as the final version is settled here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants