Extending with custom manual instrumentation #5789
Conversation
content/en/docs/zero-code/java/spring-boot-starter/annotations.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Severin Neumann <[email protected]>
|
@svrnm can you check? |
There was a problem hiding this comment.
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 |
| --- | ||
| title: Extending with custom manual instrumentation using the OpenTelemetry API | ||
| linkTitle: Extending instrumentation | ||
| description: Extending a Java agent with custom manual instrumentation. | ||
| weight: 21 | ||
| --- |
There was a problem hiding this comment.
the title is now longer then the description, here is a proposal
| --- | |
| title: Extending with custom manual instrumentation using the OpenTelemetry API | |
| linkTitle: Extending instrumentation | |
| description: Extending a Java agent with custom manual instrumentation. | |
| weight: 21 | |
| --- | |
| --- | |
| title: Extending instrumentations with the API | |
| linkTitle: Extend with the API | |
| description: Use the OpenTelemetry API in combination with the Java agent to extend the automatically generated telemetry with custom instrumentations | |
| weight: 21 | |
| --- |
@chalin @jack-berg can you take a look as well?
There was a problem hiding this comment.
I adjusted slightly:
Use the OpenTelemetry API in combination with the Java agent to extend the automatically generated telemetry with custom spans and metrics
Co-authored-by: Severin Neumann <[email protected]>
|
@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? |
| Use the `Tracer` to create a span as explained in the | ||
| [Span](/docs/languages/java/api/#span) section. | ||
|
|
||
| A full example can be found [example repository]. |
There was a problem hiding this comment.
| A full example can be found [example repository]. | |
| A full example can be found in the [example repository]. |
| Use the `Meter` to create a counter, gauge or histogram as explained in the | ||
| [Meter](/docs/languages/java/api/#meter) section. | ||
|
|
||
| A full example can be found [example repository]. |
There was a problem hiding this comment.
| A full example can be found [example repository]. | |
| A full example can be found in the [example repository]. |
| Beyond the use of annotations, the OpenTelemetry API allows you to obtain a | ||
| tracer that can be used for [custom instrumentation](../api) and execute code | ||
| within the scope of that span. |
There was a problem hiding this comment.
I didn't follow what "executing code within the scope of that span" meant, maybe reword or remove?
| Beyond the use of annotations, the OpenTelemetry API allows you to obtain a | |
| tracer that can be used for [custom instrumentation](../api) and execute code | |
| within the scope of that span. | |
| Beyond the use of annotations, the OpenTelemetry API allows you to obtain a | |
| tracer that can be used [custom instrumentation](../api). |
| tracer that can be used for [custom instrumentation](../api) and execute code | ||
| within the scope of that span. |
There was a problem hiding this comment.
same question (though I see it was pre-existing text...)
| tracer that can be used for [custom instrumentation](../api) and execute code | |
| within the scope of that span. | |
| tracer that can be used for [custom instrumentation](../api). |
| Use the `Tracer` to create a span as explained in the | ||
| [Span](/docs/languages/java/api/#span) section. | ||
|
|
||
| A full example can be found [example repository]. |
There was a problem hiding this comment.
| A full example can be found [example repository]. | |
| A full example can be found in the [example repository]. |
| Use the `Meter` to create a counter, gauge or histogram as explained in the | ||
| [Meter](/docs/languages/java/api/#meter) section. | ||
|
|
||
| A full example can be found [example repository]. |
There was a problem hiding this comment.
| A full example can be found [example repository]. | |
| A full example can be found in the [example repository]. |
|
|
||
| ### GlobalOpenTelemetry | ||
| #### GlobalOpenTelemetry |
There was a problem hiding this comment.
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.
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 %}}
Fixes #5713