io.sentry.spring.jakarta.SentryExceptionResolver Maven / Gradle / Ivy
package io.sentry.spring.jakarta;
import static io.sentry.TypeCheckHint.SPRING_RESOLVER_REQUEST;
import static io.sentry.TypeCheckHint.SPRING_RESOLVER_RESPONSE;
import com.jakewharton.nopen.annotation.Open;
import io.sentry.Hint;
import io.sentry.IScopes;
import io.sentry.SentryEvent;
import io.sentry.SentryLevel;
import io.sentry.exception.ExceptionMechanismException;
import io.sentry.protocol.Mechanism;
import io.sentry.spring.jakarta.tracing.TransactionNameProvider;
import io.sentry.util.Objects;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.springframework.core.Ordered;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
/**
* {@link HandlerExceptionResolver} implementation that will record any exception that a Spring
* {@link org.springframework.web.servlet.mvc.Controller} throws to Sentry. It then returns null,
* which will let the other (default or custom) exception resolvers handle the actual error.
*/
@Open
public class SentryExceptionResolver implements HandlerExceptionResolver, Ordered {
public static final String MECHANISM_TYPE = "Spring6ExceptionResolver";
private final @NotNull IScopes scopes;
private final @NotNull TransactionNameProvider transactionNameProvider;
private final int order;
public SentryExceptionResolver(
final @NotNull IScopes scopes,
final @NotNull TransactionNameProvider transactionNameProvider,
final int order) {
this.scopes = Objects.requireNonNull(scopes, "scopes are required");
this.transactionNameProvider =
Objects.requireNonNull(transactionNameProvider, "transactionNameProvider is required");
this.order = order;
}
@Override
public @Nullable ModelAndView resolveException(
final @NotNull HttpServletRequest request,
final @NotNull HttpServletResponse response,
final @Nullable Object handler,
final @NotNull Exception ex) {
final SentryEvent event = createEvent(request, ex);
final Hint hint = createHint(request, response);
scopes.captureEvent(event, hint);
// null = run other HandlerExceptionResolvers to actually handle the exception
return null;
}
@Override
public int getOrder() {
return order;
}
@NotNull
protected SentryEvent createEvent(
final @NotNull HttpServletRequest request, final @NotNull Exception ex) {
final Mechanism mechanism = new Mechanism();
mechanism.setHandled(false);
mechanism.setType(MECHANISM_TYPE);
final Throwable throwable =
new ExceptionMechanismException(mechanism, ex, Thread.currentThread());
final SentryEvent event = new SentryEvent(throwable);
event.setLevel(SentryLevel.FATAL);
event.setTransaction(transactionNameProvider.provideTransactionName(request));
return event;
}
@Nullable
protected Hint createHint(
final @NotNull HttpServletRequest request, final @NotNull HttpServletResponse response) {
final Hint hint = new Hint();
hint.set(SPRING_RESOLVER_REQUEST, request);
hint.set(SPRING_RESOLVER_RESPONSE, response);
return hint;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy