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.

Sign up for GitHub

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

add note about micrometer #4643

Closed
wants to merge 19 commits into from
Closed

add note about micrometer #4643

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
bb56c3c
add note about micrometer
zeitlinger Jun 10, 2024
96a670e
Results from /fix:format
opentelemetrybot Jun 10, 2024
0bacee0
add note about micrometer
zeitlinger Jun 11, 2024
b799aa6
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
4c0d1cf
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
960723e
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
6e2518d
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
288e244
add note about micrometer
zeitlinger Jun 11, 2024
ebf1152
Results from /fix:format
opentelemetrybot Jun 11, 2024
39e3ed4
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
16d71a3
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
56d1659
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
62ef7ee
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
e2937bc
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
8e501c2
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 11, 2024
ffda775
add note about micrometer
zeitlinger Jun 11, 2024
2a7bfd6
fix footnote
zeitlinger Jun 11, 2024
2e69e62
Results from /fix:format
opentelemetrybot Jun 11, 2024
1aeb2f5
Update content/en/docs/zero-code/java/spring-boot-starter/_index.md
zeitlinger Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions content/en/docs/zero-code/java/spring-boot-starter/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases:
- /docs/zero-code/java/spring-boot
---

## Java agent versus Spring Boot starter

You can use two options to instrument
[Spring Boot](https://spring.io/projects/spring-boot) applications with
OpenTelemetry.
Expand All @@ -23,3 +25,34 @@ OpenTelemetry.
- **Spring Boot configuration files** (`application.properties`,
`application.yml`) to configure the OpenTelemetry Spring Boot starter which
doesn't work with the OpenTelemetry Java agent

## Comparison to Micrometer

At a high level, this section compares OpenTelemetry Spring Boot starter and
Micrometer.
zeitlinger marked this conversation as resolved.
Show resolved Hide resolved

OpenTelemetry Spring Boot starter:

- Natively uses the OpenTelemetry API, OpenTelemetry SDK, and the OpenTelemetry
semantic conventions.
- Supported by the OpenTelemetry community (governed by the CNCF / Linux
Foundation).

Micrometer [^1][^2]:

- An independent standalone observability system.
- Offers optional bridges into parts of the OpenTelemetry ecosystem.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Offers optional bridges into parts of the OpenTelemetry ecosystem.
- Offers optional bridges into OpenTelemetry Tracing and Metrics.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you also don't get SDK features

- Supported by the Micrometer community (governed by Broadcom Inc).

As the authors of the OpenTelemetry Spring Boot starter, we recommend using the
OpenTelemetry Spring Boot starter. We have a great community behind it, and are
continuously making improvements. If you try it out and have any problems or
suggestions, open an
[issue](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues)
in our repository.
Comment on lines +46 to +51
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As the authors of the OpenTelemetry Spring Boot starter, we recommend using the
OpenTelemetry Spring Boot starter. We have a great community behind it, and are
continuously making improvements. If you try it out and have any problems or
suggestions, open an
[issue](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues)
in our repository.
Both solutions are open source and support different exporters, including OTLP and Prometheus,
and both are compatible for tracing use cases. This means, that they fit equally into an existing
observability architecture. It is up to the end user to decide, which solution satisfies their requirements better.

This is the sentence I would remove in the light of "neutrality". It's very obvious that we recommend the otel solution, so we don't have to say that explicitly.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds a bit like we would not be convinced that our solution is the better one.

We do try to become the standard API in the java world - can we say that in a friendly way?


[^1]:
[Micrometer metrics OTLP registry](https://docs.micrometer.io/micrometer/reference/implementations/otlp.html)

[^2]:
[Micrometer tracing OpenTelemetry bridge](https://docs.micrometer.io/tracing/reference/tracers.html)
3 changes: 2 additions & 1 deletion content/en/docs/zero-code/java/spring-boot-starter/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ cSpell:ignore: springboot
{{% alert title="Note" color="info" %}}

You can also use the [Java agent](../../agent) to instrument your Spring Boot
application. For the pros and cons, see [Java zero-code instrumentation](..).
application. For the pros and cons, see
[Java agent versus Spring Boot starter](../#java-agent-versus-spring-boot-starter).

{{% /alert %}}

Expand Down
12 changes: 12 additions & 0 deletions static/refcache.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1299,6 +1299,14 @@
"StatusCode": 206,
"LastSeen": "2024-02-17T16:19:07.140338072Z"
},
"https://docs.micrometer.io/micrometer/reference/implementations/otlp.html": {
"StatusCode": 206,
"LastSeen": "2024-06-11T08:17:08.270558365+02:00"
},
"https://docs.micrometer.io/tracing/reference/tracers.html": {
"StatusCode": 206,
"LastSeen": "2024-06-11T08:17:11.015227386+02:00"
},
"https://docs.microsoft.com/aspnet/core": {
"StatusCode": 200,
"LastSeen": "2024-01-18T08:53:25.01054-05:00"
Expand Down Expand Up @@ -3739,6 +3747,10 @@
"StatusCode": 200,
"LastSeen": "2024-01-18T19:55:35.674322-05:00"
},
"https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues": {
"StatusCode": 200,
"LastSeen": "2024-06-11T08:17:15.340773687+02:00"
},
"https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/7413": {
"StatusCode": 200,
"LastSeen": "2024-02-22T15:50:20.20139382Z"
Expand Down