Generate JFR telemetry table #715
Merged
Conversation
This file contains 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
breedx-splk
approved these changes
Jan 30, 2023
There was a problem hiding this comment.
This is cool, I appreciate the automation. I'm curious if we can think of any interesting failure modes that might cause us to miss data and cause the README to be misleading. The only thing I can think of is that sometimes GHA lags and maybe the hard coded sleep value won't be enough. 🤷🏻
jfr-streaming/src/test/java/io/opentelemetry/contrib/jfr/metrics/GenerateDocs.java
Outdated
Show resolved
Hide resolved
trask
approved these changes
Feb 1, 2023
jfr-streaming/src/test/java/io/opentelemetry/contrib/jfr/metrics/GenerateDocs.java
Outdated
Show resolved
Hide resolved
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.
Adds a gradle task called
./gradlew generateDocswhich programatically generates the telemetry table injfr-streaming/README.md.This will ensure that the docs stay up to date following changes to the instrumentation.