docs: improve gruf instrumentation documentation#2207
Open
allexistence wants to merge 1 commit intoopen-telemetry:mainfrom
Open
docs: improve gruf instrumentation documentation#2207allexistence wants to merge 1 commit intoopen-telemetry:mainfrom
allexistence wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
Signed-off-by: rishabh <rishank69@gmail.com>
allexistence
requested review from
a team,
ahayworth,
arielvalentin,
dazuma,
ericmustin,
fbogsany,
hannahramadan,
kaylareopelle,
mwear,
plantfansam,
robbkidd,
robertlaurin,
simi and
xuan-cao-swi
as code owners
Contributor
arielvalentin
left a comment
arielvalentin
left a comment
There was a problem hiding this comment.
Thanks for your contribution. This is a great start.
I'd recommend also explicitly documenting any instrumentation specific configuration options as well as any extensions to semantic conventions that are unique to this instrumentation.
Would you be able to review the source for config options and semantic attributes and document them?
| end | ||
| ``` | ||
|
|
||
| ## Key Files |
Contributor
There was a problem hiding this comment.
We typically leave these out since the structure is pretty much identical for all of these instrumentations.
Do you find this helpful as an enduser?
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
2 participants
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.
Fixes #2201
What this PR does
Improves gruf instrumentation documentation by:
Notes
Doc only change