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

4.x Several fixes to tracing config #8155

Merged

Conversation

tjquinno
Copy link
Member

@tjquinno tjquinno commented Dec 15, 2023

Description

Resolves #8148

Fixes included:

  1. Change path-configs to paths for config key within tracing to conform to the doc and to be more user-friendly.
  2. Add observe-style paths for built-in services to disabled-by-default tracing paths.
  3. Change the factory method and builder config method for PathTracingConfig to accept common Config as parameter instead of the impl Config type. This change is backward compatible with recompiling.

Documentation

Bug fix. No doc change.

…d observe-style paths for built-in services to disabled-by-default tracing paths; change factory method and builder config method to accept common Config as parameter
@tjquinno tjquinno self-assigned this Dec 15, 2023
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Dec 15, 2023
+ " .build()))")
List<PathTracingConfig> pathConfigs();
List<PathTracingConfig> paths();
Copy link
Member

Choose a reason for hiding this comment

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

This is a backward incompatible change in public API.
We can either consider it a bugfix (and alignment to docs), and change it, or we could have both methods (deprecate the pathConfigs and add a builder observer to correctly choose the right configured option)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I considered it a bug fix but I guess in my mind the real bug is the config key being path-configs instead of paths.

Another option: we could keep the old method name pathConfigs but set the config key explicitly to paths in the annotation.

Copy link
Member

Choose a reason for hiding this comment

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

I think we need to keep the API backward compatible, so please either add a new method and deprecate existing (preferred option), or change the configuration key for this method.

Copy link
Member Author

Choose a reason for hiding this comment

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

The most recent push sets the config key explicitly to "paths" and changes the method names back to what they were to avoid the backward-incompatible change to the APIs.

…n pathConfigs but set the config key to paths explicitly
@tjquinno tjquinno merged commit 32a0c1f into helidon-io:main Dec 18, 2023
12 checks passed
@tjquinno tjquinno deleted the 4.x-tracing-built-in-paths-disabled-fix branch December 18, 2023 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Helidon Tracing configuration Paths
2 participants