Async Methods
Sentry's SDK for Java stores the scope and the context in a thread-local variable. To make sure that an async method has access to the correct Sentry context, a SentryTaskDecorator
must be set on the ThreadPoolTaskExecutor
.
To propagate Sentry scope to Spring MVC methods returning a Callable
or a StreamingResponseBody
, a ThreadPoolTaskExecutor
decorated with SentryTaskDecorator
must be set on the AsyncSupportConfigurer
through an implementation of WebMvcConfigurer
:
import org.springframework.context.annotation.Configuration;
import org.springframework.core.task.AsyncTaskExecutor;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.web.servlet.config.annotation.AsyncSupportConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import io.sentry.spring.SentryTaskDecorator;
@Configuration
class AsyncWebMvcConfiguration implements WebMvcConfigurer {
@Override
public void configureAsyncSupport(AsyncSupportConfigurer configurer) {
configurer.setTaskExecutor(asyncExecutor());
}
private AsyncTaskExecutor asyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setTaskDecorator(new SentryTaskDecorator());
executor.initialize();
return executor;
}
}
Alternatively, if there is a single bean of type TaskDecorator
in the context, instead of custom WebMvcConfigurer
, it is enough to create a SentryTaskDecorator
bean.
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import io.sentry.spring.SentryTaskDecorator;
@Configuration
class SentryConfig {
@Bean
public SentryTaskDecorator sentryTaskDecorator() {
return new SentryTaskDecorator();
}
}
To propagate Sentry scope to Spring @Async
annotated methods, a custom AsyncConfigurerSupport
must be configured to return a ThreadPoolTaskExecutor
decorated with SentryTaskDecorator
:
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.AsyncConfigurerSupport;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import io.sentry.spring.SentryTaskDecorator;
import java.util.concurrent.Executor;
@Configuration
class AsyncMethodConfiguration extends AsyncConfigurerSupport {
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setTaskDecorator(new SentryTaskDecorator());
executor.initialize();
return executor;
}
}
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
- Package:
- maven:io.sentry:sentry-spring-boot-starter
- Version:
- 7.8.0
- Repository:
- https://github.com/getsentry/sentry-java
- API Documentation:
- https://javadoc.io/doc/io.sentry