Skip to content

fix(java): fix RestTemplate auto-instrumentation guide #13236

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

Merged
lcian merged 3 commits into from
Apr 17, 2025
Merged

fix(java): fix RestTemplate auto-instrumentation guide #13236

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
891ae0d
fix(java): fix `RestTemplate` autoinstrumentation guide
lcian Apr 4, 2025
fe30625
Update automatic-instrumentation.mdx
lcian Apr 17, 2025
1753fa3
Update automatic-instrumentation.mdx
lcian Apr 17, 2025
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
45 changes: 33 additions & 12 deletions ...tforms/java/guides/spring/tracing/instrumentation/automatic-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;


@RestController
class HelloController {

Expand Down Expand Up @@ -51,65 +52,80 @@ Each sampled request executed by this controller method will be turned into a tr
Sentry Spring integration provides `SentrySpanClientHttpRequestInterceptor` that creates a span for each outgoing HTTP request executed with a `RestTemplate`. To use instrumented `RestTemplate` make sure to set interceptor on the `RestTemplate` bean:

```java {tabTitle:Java (Spring 5)}
import io.sentry.IHub;
import io.sentry.IScopes;
import io.sentry.spring.tracing.SentrySpanClientHttpRequestInterceptor;
import java.util.Collections;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriTemplateHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;

@Configuration
class AppConfig {

@Autowired
private ApplicationContext applicationContext;

@Bean
RestTemplate restTemplate(IHub hub) {
RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
SentrySpanClientHttpRequestInterceptor sentryRestTemplateInterceptor =
new SentrySpanClientHttpRequestInterceptor(hub);
new SentrySpanClientHttpRequestInterceptor(applicationContext.getBean(IScopes.class));
restTemplate.setInterceptors(Collections.singletonList(sentryRestTemplateInterceptor));
return restTemplate;
}
}
```

```java {tabTitle:Java (Spring 6)}
import io.sentry.IHub;
import io.sentry.IScopes;
import io.sentry.spring.jakarta.tracing.SentrySpanClientHttpRequestInterceptor;
import java.util.Collections;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriTemplateHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;

@Configuration
class AppConfig {

@Autowired
private ApplicationContext applicationContext;

@Bean
RestTemplate restTemplate(IHub hub) {
RestTemplate restTemplate() {
RestTemplate restTemplate = new RestTemplate();
SentrySpanClientHttpRequestInterceptor sentryRestTemplateInterceptor =
new SentrySpanClientHttpRequestInterceptor(hub);
new SentrySpanClientHttpRequestInterceptor(applicationContext.getBean(IScopes.class));
restTemplate.setInterceptors(Collections.singletonList(sentryRestTemplateInterceptor));
return restTemplate;
}
}
```

```kotlin {tabTitle:Kotlin (Spring 5)}
import io.sentry.IHub
import io.sentry.IScopes
import io.sentry.spring.tracing.SentrySpanClientHttpRequestInterceptor
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.web.client.RestTemplate
import org.springframework.web.util.UriTemplateHandler
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.context.ApplicationContext

@Configuration
class AppConfig {

@Autowired
private ApplicationContext applicationContext;

@Bean
fun restTemplate(hub: IHub): RestTemplate {
val sentryRestTemplateInterceptor = SentrySpanClientHttpRequestInterceptor(hub)
fun restTemplate(): RestTemplate {
val sentryRestTemplateInterceptor = SentrySpanClientHttpRequestInterceptor(applicationContext.getBean(IScopes.class))

return RestTemplate().apply {
interceptors = listOf(sentryRestTemplateInterceptor)
Expand All @@ -119,19 +135,24 @@ class AppConfig {
```

```kotlin {tabTitle:Kotlin (Spring 6)}
import io.sentry.IHub
import io.sentry.IScopes
import io.sentry.spring.jakarta.tracing.SentrySpanClientHttpRequestInterceptor
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.web.client.RestTemplate
import org.springframework.web.util.UriTemplateHandler
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.context.ApplicationContext

@Configuration
class AppConfig {

@Autowired
private ApplicationContext applicationContext;

@Bean
fun restTemplate(hub: IHub): RestTemplate {
val sentryRestTemplateInterceptor = SentrySpanClientHttpRequestInterceptor(hub)
fun restTemplate(): RestTemplate {
val sentryRestTemplateInterceptor = SentrySpanClientHttpRequestInterceptor(applicationContext.getBean(IScopes.class))

return RestTemplate().apply {
interceptors = listOf(sentryRestTemplateInterceptor)
Expand Down