-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add "transforming telemetry" section to collector docs #2304
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition, thank you for bringing this forward!
A few remarks, please also make sure that you run prettier over your file so that the formatting is correct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page seems a great addition overall! Added just one minor comment.
6d96576
to
d5875a5
Compare
Thanks for the feedback, all! Have addressed/resolved all comments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Getting closer! You'll need to rebase, run npm run check:formatting -- --write
, and push changes. Thanks.
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Co-authored-by: Severin Neumann <severin.neumann@altmuehlnet.de>
d5875a5
to
63138d6
Compare
thanks, @chalin! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Weight change, otherwise LGTM.
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great content! Exactly the kind of content with examples we need for this area of collector docs.
💯 Awesome work @smithclay !! |
Have recently received feedback from several new collector users around usability of docs in the various processors in collector-contrib. Specifically, it's difficult to know where to start for some very simple (and common) use cases like adding an attribute to a span or filtering based on service name.
This PR proposes a new section under the collector docs called "Transforming telemetry" that documents some simple examples/use-cases and links to processors for more information.
Goal of the doc isn't to exhaustively document all configurations or duplicate what is already in the contrib repo, but to provide a friendly "new to collector processors" introduction to users with some simple examples before pointing to the contrib repo for more information.
Preview: https://deploy-preview-2304--opentelemetry.netlify.app/docs/collector/transforming-telemetry/