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

Improve OpenTelemetry documentation in Helidon SE #9594

Open
hyder opened this issue Dec 13, 2024 · 0 comments
Open

Improve OpenTelemetry documentation in Helidon SE #9594

hyder opened this issue Dec 13, 2024 · 0 comments

Comments

@hyder
Copy link

hyder commented Dec 13, 2024

Environment Details

  • Helidon Version: 4.1.5
  • Helidon SE
  • JDK version: 21
  • OS:
  • Docker version (if applicable):

Problem Description

Currently, the use of OpenTelemetry in Helidon SE is not well documented: https://helidon.io/docs/v4/se/tracing. It's also somewhat confusing with Zipkin, Jaeger and OpenTracing being mentioned.

To do:

  1. Make Tracing become a section with sub pages
  2. Remove references to OpenTracing as it's now an archived project
  3. Document using OpenTelemetry with use cases (e.g. client, server) and diagrams - maven dependencies
  4. Document how to load OpenTelemetry configuration in a Helidon SE application.
  5. OpenTelemetry configuration in config file.
  6. Move Jaeger/zipkin to separate pages under tracing section

Steps to reproduce

@github-project-automation github-project-automation bot moved this to Triage in Backlog Dec 13, 2024
@m0mus m0mus moved this from Triage to Normal priority in Backlog Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Normal priority
Development

No branches or pull requests

2 participants