Skip to content

Conversation

@jaydeluca
Copy link
Member

Related to #13468

  • Adds the ability to document configuration options in the metatdata.yaml file.
  • Adds a few more descriptions to a various modules.
  • Prints out a small summary of stats related tracking the progress of adding information to metadata files.

Current stats output:

INFO: -----------------------------------
Analysis Summary:
Total Modules: 252
By classification:
	library: 226
	custom: 5
	internal: 21
metadata.yaml contents:
  descriptions: 12 (4.76%)
  configurations: 5 (1.98%)

@jaydeluca jaydeluca requested a review from a team as a code owner April 20, 2025 01:12
javaagent:
- com.datastax.oss:java-driver-core:[4.0,4.4)
configurations:
- name: otel.instrumentation.common.db-statement-sanitizer.enabled
Copy link
Contributor

Choose a reason for hiding this comment

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

@trask should we have a framework specific flags for this in all frameworks? I think it was added for a few.

Copy link
Member

Choose a reason for hiding this comment

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

yeah, I almost wish we didn't have the "common" variant, to make it harder for users to do the wrong thing (send sensitive data unexpectedly from some other db instrumentation)

Copy link
Member Author

Choose a reason for hiding this comment

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

would it be worth me opening an issue to replace the common config flags, or at the very least start with this one? I plan on working through module to module to document the various configs, so I can track the common ones I find and replace the usages with framework specific ones as I go, if that's a direction we want to move in.

Copy link
Member

Choose a reason for hiding this comment

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

ah, I only dislike this one common flag due to it broadly disabling sensitive data sanitization, the other common flags I like

I'm not sure I dislike it enough though to cause upgrade pain by removing it

- name: otel.instrumentation.common.db-statement-sanitizer.enabled
description: Enables or disables statement sanitization for database queries.
default: 'true'
- name: otel.instrumentation.common.peer-service-mapping
Copy link
Contributor

Choose a reason for hiding this comment

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

Not related to this PR but I guess the peer service handling is a bit inconsistent. I think we are using it only for some of the instrumentations.

Copy link
Member Author

Choose a reason for hiding this comment

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

do you think it's worth an effort to standardize the approach?

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 we should strive for consistent behavior across instrumentations, but it is one of the many nice to have things.

@laurit laurit merged commit 7d796ab into open-telemetry:main Apr 25, 2025
86 checks passed
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.

3 participants