Skip to content
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

Merged
merged 6 commits into from
Feb 14, 2023

Conversation

smithclay
Copy link
Contributor

@smithclay smithclay commented Feb 9, 2023

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/

@smithclay smithclay requested review from a team as code owners February 9, 2023 00:30
@smithclay smithclay requested review from Aneurysm9 and removed request for a team February 9, 2023 00:30
Copy link
Member

@svrnm svrnm left a 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.

content/en/docs/collector/transforming-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/transforming-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/transforming-telemetry.md Outdated Show resolved Hide resolved
Copy link
Member

@mviitane mviitane left a 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.

content/en/docs/collector/transforming-telemetry.md Outdated Show resolved Hide resolved
@smithclay
Copy link
Contributor Author

smithclay commented Feb 13, 2023

Thanks for the feedback, all! Have addressed/resolved all comments.

Copy link
Contributor

@chalin chalin left a 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.

smithclay and others added 4 commits February 13, 2023 14:00
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Severin Neumann <severin.neumann@altmuehlnet.de>
@smithclay
Copy link
Contributor Author

  • rebased
  • ran npm run check:formatting -- --write

thanks, @chalin!

Copy link
Contributor

@chalin chalin left a 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.

content/en/docs/collector/transforming-telemetry.md Outdated Show resolved Hide resolved
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
@smithclay smithclay requested review from svrnm and removed request for Aneurysm9 February 13, 2023 22:47
Copy link
Contributor

@cartermp cartermp left a 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.

@svrnm svrnm merged commit 4141fb7 into open-telemetry:main Feb 14, 2023
@svrnm
Copy link
Member

svrnm commented Feb 14, 2023

Great content! Exactly the kind of content with examples we need for this area of collector docs.

💯

Awesome work @smithclay !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants