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

Document RestClient and WebClient for Spring Boot #9531

Merged
merged 1 commit into from
Apr 9, 2024
Merged

Document RestClient and WebClient for Spring Boot #9531

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
62 changes: 62 additions & 0 deletions ...va/guides/spring-boot/performance/instrumentation/automatic-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Sentry Spring Boot integration provides `SentrySpanRestTemplateCustomizer` that
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.web.client.RestTemplate;

@Configuration
class AppConfig {
Expand All @@ -68,10 +69,71 @@ class AppConfig {
import org.springframework.context.annotation.Configuration
import org.springframework.context.annotation.Bean
import org.springframework.boot.web.client.RestTemplateBuilder
import org.springframework.web.client.RestTemplate

@Configuration
class AppConfig {
@Bean
fun restTemplate(builder: RestTemplateBuilder) = builder.build()
}
```

### RestClient Instrumentation

Sentry Spring Boot integration provides `SentrySpanRestClientCustomizer` that creates a span for each outgoing HTTP request executed with a `RestClient`. To use instrumented `RestClient` make sure to create `RestClient` beans using `RestClient.Builder`:

```java {tabTitle:Java}
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestClient;

@Configuration
class AppConfig {
@Bean
RestClient restClient(RestClient.Builder builder) {
return builder.build();
}
}
```

```kotlin {tabTitle:Kotlin}
import org.springframework.context.annotation.Configuration
import org.springframework.context.annotation.Bean
import org.springframework.web.client.RestClient

@Configuration
class AppConfig {
@Bean
fun restClient(builder: RestClient.Builder) = builder.build()
}
```

### WebClient Instrumentation

Sentry Spring Boot integration provides `SentrySpanWebClientCustomizer` that creates a span for each outgoing HTTP request executed with a `WebClient`. To use instrumented `WebClient` make sure to create `WebClient` beans using `WebClient.Builder`:

```java {tabTitle:Java}
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Bean;
import org.springframework.web.reactive.function.client.WebClient;

@Configuration
class AppConfig {
@Bean
WebClient webClient(WebClient.Builder builder) {
return builder.build();
}
}
```

```kotlin {tabTitle:Kotlin}
import org.springframework.context.annotation.Configuration
import org.springframework.context.annotation.Bean
import org.springframework.web.reactive.function.client.WebClient

@Configuration
class AppConfig {
@Bean
fun webClient(builder: WebClient.Builder) = builder.build()
}
```
Loading