Add snippets for prometheus clients compatibility documentation#8715
Closed
Add snippets for prometheus clients compatibility documentation#8715
Conversation
4 tasks
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
1 participant
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.
Over in opentelemetry.io, I'm writing a compatibility guide comparing how prometheus client concepts to opentelemetry API: open-telemetry/opentelemetry.io#9263
It includes working code snippets for a variety of key API usage patterns, in multiple languages.
opentelemetry.io has a pattern called "code excerpts" which allow code from git submodules to be referenced in docs. We use this liberally in opentelemetry java docs, and to a lesser extent with opentelemetry go docs. I recently updated opentelemetry.io to go examples which were relocated to opentelemetry-go-contrib here: open-telemetry/opentelemetry.io#9462.
This PR adds all the go code snippets for the compatibility page. Here's the PR to add the java-equivalent examples: open-telemetry/opentelemetry-java-examples#1032
cc @dashpole, @ArthurSens who have been helping review the PR from a go and prometheus perspective.