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

Update OTel Spring starter doc with 2.6.0 features #4847

Merged
merged 16 commits into from
Jul 18, 2024
Merged

Update OTel Spring starter doc with 2.6.0 features #4847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
49bcfa6
Update OTel Spring starter doc with 2.6.0 features
jeanbisutti Jul 18, 2024
c13af45
Results from /fix:all
opentelemetrybot Jul 18, 2024
dfd0f87
Update out-of-the-box-instrumentation.md
jeanbisutti Jul 18, 2024
b6da997
Results from /fix:all
opentelemetrybot Jul 18, 2024
5873fdb
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
54cafe7
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
4d2735e
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
c61588e
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
2dcdfc4
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
8cb1bd9
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
344dada
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
651bb4f
Update content/en/docs/zero-code/java/spring-boot-starter/out-of-the-…
jeanbisutti Jul 18, 2024
039c2f6
Update out-of-the-box-instrumentation.md
jeanbisutti Jul 18, 2024
c8271a6
Results from /fix:all
opentelemetrybot Jul 18, 2024
2218b4d
Merge branch 'main' into otel-starter-doc-2.6.0
theletterf Jul 18, 2024
71fca18
Update out-of-the-box-instrumentation.md
theletterf Jul 18, 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
23 changes: 23 additions & 0 deletions ...nt/en/docs/zero-code/java/spring-boot-starter/out-of-the-box-instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ Out of the box instrumentation is available for several frameworks:
| Micrometer | `otel.instrumentation.micrometer.enabled` | false |
| R2DBC (reactive JDBC) | `otel.instrumentation.r2dbc.enabled` | true |

## Turn on instrumentations selectively

To use only specific instrumentations, turn off all the instrumentations first
by setting the `otel.instrumentation.common.default-enabled` property to
`false`. Then, turn on instrumentations one by one.

For example, if you want to only enable the JDBC instrumentation, set
`otel.instrumentation.jdbc.enabled` to `true`.

## Common instrumentation configuration

Common properties for all database instrumentations:
Expand Down Expand Up @@ -118,6 +127,13 @@ public MyService(RestClient.Builder restClientBuilder) {
}
```

As it's possible with the Java agent, you can configure the capture of the
following entities:

- [HTTP request and response headers](/docs/zero-code/java/agent/instrumentation/http/#capturing-http-request-and-response-headers)
- [Known HTTP methods](/docs/zero-code/java/agent/instrumentation/http/#configuring-known-http-methods)
- [Experimental HTTP telemetry](/docs/zero-code/java/agent/instrumentation/http/#enabling-experimental-http-telemetry)

## Spring Web MVC Autoconfiguration

This feature autoconfigures instrumentation for Spring WebMVC controllers by
Expand All @@ -129,6 +145,13 @@ request. To learn more about the OpenTelemetry Spring WebMVC instrumentation,
see the
[opentelemetry-spring-webmvc-5.3 instrumentation library](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/library).

As it's possible with the Java agent, you can configure the capture of the
following entities:

- [HTTP request and response headers](/docs/zero-code/java/agent/instrumentation/http/#capturing-http-request-and-response-headers)
- [Known HTTP methods](/docs/zero-code/java/agent/instrumentation/http/#configuring-known-http-methods)
- [Experimental HTTP telemetry](/docs/zero-code/java/agent/instrumentation/http/#enabling-experimental-http-telemetry)

## Spring WebFlux Autoconfiguration

Provides autoconfigurations for the OpenTelemetry WebClient ExchangeFilter
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 @@ -6579,6 +6579,18 @@
"StatusCode": 206,
"LastSeen": "2024-05-15T19:23:47.920456821+03:00"
},
"https://opentelemetry.io/docs/zero-code/java/agent/instrumentation/http/#capturing-http-request-and-response-headers": {
"StatusCode": 206,
"LastSeen": "2024-07-18T12:15:23.404682814Z"
},
"https://opentelemetry.io/docs/zero-code/java/agent/instrumentation/http/#configuring-known-http-methods": {
"StatusCode": 206,
"LastSeen": "2024-07-18T12:15:25.914328974Z"
},
"https://opentelemetry.io/docs/zero-code/java/agent/instrumentation/http/#enabling-experimental-http-telemetry": {
"StatusCode": 206,
"LastSeen": "2024-07-18T12:15:30.126385341Z"
},
"https://opentelemetry.io/ecosystem/integrations/": {
"StatusCode": 206,
"LastSeen": "2024-03-19T10:16:49.992495889Z"
Expand Down