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

how to get a meter/tracer in Java agent or spring stater #5713

Open
zeitlinger opened this issue Dec 2, 2024 · 8 comments · May be fixed by #5789
Open

how to get a meter/tracer in Java agent or spring stater #5713

zeitlinger opened this issue Dec 2, 2024 · 8 comments · May be fixed by #5789
Assignees
Labels
bug Something isn't working

Comments

@zeitlinger
Copy link
Member

What needs to be changed?

We need a landing page that explains to do manual instrumentation in Java agent or spring stater.

Use cases:

Possible solutions:

@zeitlinger zeitlinger added the bug Something isn't working label Dec 2, 2024
@zeitlinger zeitlinger self-assigned this Dec 2, 2024
@zeitlinger
Copy link
Member Author

@svrnm any overarching guidance?

@svrnm
Copy link
Member

svrnm commented Dec 2, 2024

Embed docs like it was done a while ago: 2024.08/content/en/docs/languages/java/instrumentation.md#acquiring-a-meter-in-java-agent

I think it would be good to re-introduce something like that. I would also suggest that some other pages point to it, the zero code pages for sure, but also https://opentelemetry.io/docs/languages/java/instrumentation/, I would not name it "Record Telemetry with the API" like the existing page, but more something like "Add custom telemetry" or "Combine automatic and manual telemetry" or something like that to make it clear that this is about doing both at the same time

@zeitlinger
Copy link
Member Author

@jack-berg wdyt?

@jeanbisutti
Copy link
Member

Perhaps it may be worth highlighting how to retrieve an OpenTelemetry instance when using the Java agent or Spring starter in addition to point to additional resources.

@zeitlinger
Copy link
Member Author

Perhaps it may be worth highlighting how to retrieve an OpenTelemetry instance when using the Java agent or Spring starter in addition to point to additional resources.

yes, that is the content of the proposed page

@jeanbisutti
Copy link
Member

I agree it's already explained in the meter part:

An OpenTelemetry instance is useful in several programmatic instrumentation cases.

Perhaps how to retrieve an OpenTelemetry instance with the agent and Spring starter cases is a general and important concept that should be highlighted in the agent and Spring starter documentations.

@jack-berg
Copy link
Member

Perhaps it may be worth highlighting how to retrieve an OpenTelemetry instance when using the Java agent or Spring starter in addition to point to additional resources.

That's the key bit. After a user knows how to get the autoconfigured OpenTelemetry instance, then we can refer to the existing API docs.

My inclination is to have a section in each of the Agent / Spring Boot starter with a heading something like "Extending with custom manual instrumenation". This seems like the most discoverable place for users, since it would be co-located with all the other Agent / Srping Boot starter specific content.

@zeitlinger
Copy link
Member Author

I agree it's already explained in the meter part:

these are links to removed content

@zeitlinger zeitlinger linked a pull request Dec 13, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

4 participants