Review fixes for runtime-telemetry-java8:library#17667
Open
otelbot[bot] wants to merge 1 commit intomainfrom
Open
Review fixes for runtime-telemetry-java8:library#17667otelbot[bot] wants to merge 1 commit intomainfrom
otelbot[bot] wants to merge 1 commit intomainfrom
Conversation
Automated code review of instrumentation/runtime-telemetry/runtime-telemetry-java8/library.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Applied 2 safe documentation fixes in
runtime-telemetry-java8library sources to keep deprecated API guidance and method comments aligned with actual behavior.Applied Changes
General
File:
RuntimeMetrics.java:52Change: Updated
RuntimeMetrics.close()Javadoc fromJMX metricstoruntime metrics.Reason:
knowledge/general-rules.mdsays to fix incorrect comments; this wrapper can also stop delegated non-JMX runtime telemetry, so the old comment was too narrow.File:
RuntimeMetricsBuilder.java:52Change: Adjusted
captureGcCause()deprecation Javadoc to point callers atRuntimeTelemetryplusotel.instrumentation.runtime-telemetry.capture-gc-cause=truefor the legacy opt-in path.Reason:
knowledge/general-rules.mdsays to fix incorrect comments; the previous deprecation text pointed toRuntimeTelemetry#builder(OpenTelemetry)alone even though the equivalent public opt-in is exposed through configuration, not a public builder method.Download code review diagnostics