-
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
Extending with custom manual instrumentation #5789
base: main
Are you sure you want to change the base?
Extending with custom manual instrumentation #5789
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.
thanks
content/en/docs/zero-code/java/spring-boot-starter/annotations.md
Outdated
Show resolved
Hide resolved
@svrnm can you check? |
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.
One more thing, I am not sure if api
is the right name for that, since we do not even mention "api" in the title, description, so either we do that, e.g. "Adding custom instrumentations with the API" or we rename the file to something like "extending-instrumentation.md" as well. wdyt?
it's API to separate it from annotations - which also extend |
@svrnm please check again |
@svrnm can you check? |
I did, but I'd like to get some feedback from @open-telemetry/java-approvers or @open-telemetry/java-instrumentation-approvers as well |
@jack-berg can you check? |
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.
I think the sections for the Java agent and Spring Boot starter are great additions.
I only have question about how to structure the addition to the general API page.
content/en/docs/zero-code/java/spring-boot-starter/annotations.md
Outdated
Show resolved
Hide resolved
|
||
### GlobalOpenTelemetry | ||
#### GlobalOpenTelemetry |
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.
I'm not sure about the organization of the additions in this file
Maybe could just add two small notes right above here, something like "If you are using the Java agent, see X for information about how to obtain an OpenTelemetry instance" (and similar note for Spring Boot starter)
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.
I agree - I think an alert could be good. Something like
{{% alert title="Spring Boot Starter" %}}
The Spring Boot starter is a special case where [...].
{{% /alert %}}
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.
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.
@svrnm do you have a recommendation?
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Trask Stalnaker <[email protected]>
1e96fae
to
217dc46
Compare
Fixes #5713