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

Clarify how otel data is processed internally #3538

Open
StackScribe opened this issue May 24, 2024 · 0 comments
Open

Clarify how otel data is processed internally #3538

StackScribe opened this issue May 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers status: todo

Comments

@StackScribe
Copy link
Contributor

StackScribe commented May 24, 2024

Summary

https://cloud-native.slack.com/archives/C017GAX90GM/p1714418606691249 points out some apparent inconsistencies between "Getting started with Keptn Metrics" and the main documentation about how the otel collector is used by Jaeger. @agardnerIT explains it in his response. We need to improve the documentation to reflect this information.

Technical description

  • Add a very brief and high-level explanation to the "Getting started" guide, something like "The following example uses the Jaeger allInOne image, which uses its own collector. The Jaeger installation process bundles the configured OpenTelemetry collector. Other tools, including jaeger-ui without the allInOne image, use the OpenTelemetry collector directly. See for more information
  • Add more detailed information in the Otel guide page.

DoD

  • Brief explanatory note about how Jaeger allInOne already has the OpenTelemetry collector in the "Getting Started" guide with a link to a more detailed description
  • Detailed explanation in the Otel guide page about how the otel collector wrks in case you do not want to use Jaeger allInOne.
  • Ensure that all these docs are linked appropriately
@StackScribe StackScribe added bug Something isn't working documentation Improvements or additions to documentation status: needs-discussion labels May 24, 2024
@StackScribe StackScribe changed the title Clarify how otel data is processed by Jaeger Clarify how otel data is processed internally May 24, 2024
@RealAnna RealAnna added enhancement New feature or request good first issue Good for newcomers status: todo and removed bug Something isn't working status: needs-discussion labels May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers status: todo
Projects
None yet
Development

No branches or pull requests

2 participants