Add support for async dispatch requests

Keeps the transaction open until the response is committed.
getsentry · Dec 13, 2024 · 656ee6f · 656ee6f
1 parent e227906
commit 656ee6f
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 53 deletions.
diff --git a/...ry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentryTracingFilter.java b/...ry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentryTracingFilter.java
@@ -36,6 +36,7 @@ public class SentryTracingFilter extends OncePerRequestFilter {
   private static final String TRANSACTION_OP = "http.server";
 
   private static final String TRACE_ORIGIN = "auto.http.spring_jakarta.webmvc";
+  private static final String TRANSACTION_ATTR = AsyncSentryTracingFilter.class.getName() + ".transaction";
 
   private final @NotNull TransactionNameProvider transactionNameProvider;
   private final @NotNull IHub hub;
@@ -52,6 +53,11 @@ public SentryTracingFilter() {
     this(HubAdapter.getInstance());
   }
 
+  @Override
+  protected boolean shouldNotFilterAsyncDispatch() {
+    return false;
+  }
+
   /**
    * Creates filter that resolves transaction name using transaction name provider given by
    * parameter.
@@ -77,14 +83,8 @@ protected void doFilterInternal(
       final @NotNull FilterChain filterChain)
       throws ServletException, IOException {
     if (hub.isEnabled()) {
-      final @Nullable String sentryTraceHeader =
-          httpRequest.getHeader(SentryTraceHeader.SENTRY_TRACE_HEADER);
-      final @Nullable List<String> baggageHeader =
-          Collections.list(httpRequest.getHeaders(BaggageHeader.BAGGAGE_HEADER));
-      final @Nullable TransactionContext transactionContext =
-          hub.continueTrace(sentryTraceHeader, baggageHeader);
       if (hub.getOptions().isTracingEnabled() && shouldTraceRequest(httpRequest)) {
-        doFilterWithTransaction(httpRequest, httpResponse, filterChain, transactionContext);
+        doFilterWithTransaction(httpRequest, httpResponse, filterChain);
       } else {
         filterChain.doFilter(httpRequest, httpResponse);
       }
@@ -96,12 +96,24 @@ protected void doFilterInternal(
   private void doFilterWithTransaction(
       HttpServletRequest httpRequest,
       HttpServletResponse httpResponse,
-      FilterChain filterChain,
-      final @Nullable TransactionContext transactionContext)
+      FilterChain filterChain)
       throws IOException, ServletException {
-    // at this stage we are not able to get real transaction name
-    final ITransaction transaction = startTransaction(httpRequest, transactionContext);
-    transaction.getSpanContext().setOrigin(TRACE_ORIGIN);
+    final ITransaction transaction;
+    if (isAsyncDispatch(httpRequest)) {
+      transaction = (ITransaction) httpRequest.getAttribute(TRANSACTION_ATTR);
+    } else {
+      final @Nullable String sentryTraceHeader =
+          httpRequest.getHeader(SentryTraceHeader.SENTRY_TRACE_HEADER);
+      final @Nullable List<String> baggageHeader =
+          Collections.list(httpRequest.getHeaders(BaggageHeader.BAGGAGE_HEADER));
+      final @Nullable TransactionContext transactionContext =
+          hub.continueTrace(sentryTraceHeader, baggageHeader);
+
+      // at this stage we are not able to get real transaction name
+      transaction = startTransaction(httpRequest, transactionContext);
+      transaction.getSpanContext().setOrigin(TRACE_ORIGIN);
+      httpRequest.setAttribute(TRANSACTION_ATTR, transaction);
+    }
 
     try {
       filterChain.doFilter(httpRequest, httpResponse);
@@ -110,21 +122,23 @@ private void doFilterWithTransaction(
       transaction.setStatus(SpanStatus.INTERNAL_ERROR);
       throw e;
     } finally {
-      // after all filters run, templated path pattern is available in request attribute
-      final String transactionName = transactionNameProvider.provideTransactionName(httpRequest);
-      final TransactionNameSource transactionNameSource =
-          transactionNameProvider.provideTransactionSource();
-      // if transaction name is not resolved, the request has not been processed by a controller
-      // and we should not report it to Sentry
-      if (transactionName != null) {
-        transaction.setName(transactionName, transactionNameSource);
-        transaction.setOperation(TRANSACTION_OP);
-        // if exception has been thrown, transaction status is already set to INTERNAL_ERROR, and
-        // httpResponse.getStatus() returns 200.
-        if (transaction.getStatus() == null) {
-          transaction.setStatus(SpanStatus.fromHttpStatusCode(httpResponse.getStatus()));
+      if (!isAsyncStarted(httpRequest)) {
+        // after all filters run, templated path pattern is available in request attribute
+        final String transactionName = transactionNameProvider.provideTransactionName(httpRequest);
+        final TransactionNameSource transactionNameSource =
+            transactionNameProvider.provideTransactionSource();
+        // if transaction name is not resolved, the request has not been processed by a controller
+        // and we should not report it to Sentry
+        if (transactionName != null) {
+          transaction.setName(transactionName, transactionNameSource);
+          transaction.setOperation(TRANSACTION_OP);
+          // if exception has been thrown, transaction status is already set to INTERNAL_ERROR, and
+          // httpResponse.getStatus() returns 200.
+          if (transaction.getStatus() == null) {
+            transaction.setStatus(SpanStatus.fromHttpStatusCode(httpResponse.getStatus()));
+          }
+          transaction.finish();
         }
-        transaction.finish();
       }
     }
   }

diff --git a/sentry-spring/src/main/java/io/sentry/spring/tracing/SentryTracingFilter.java b/sentry-spring/src/main/java/io/sentry/spring/tracing/SentryTracingFilter.java
@@ -33,6 +33,7 @@ public class SentryTracingFilter extends OncePerRequestFilter {
   private static final String TRANSACTION_OP = "http.server";
 
   private static final String TRACE_ORIGIN = "auto.http.spring.webmvc";
+  private static final String TRANSACTION_ATTR = AsyncSentryTracingFilter.class.getName() + ".transaction";
 
   private final @NotNull TransactionNameProvider transactionNameProvider;
   private final @NotNull IHub hub;
@@ -67,6 +68,11 @@ public SentryTracingFilter(final @NotNull IHub hub) {
     this(hub, new SpringMvcTransactionNameProvider());
   }
 
+  @Override
+  protected boolean shouldNotFilterAsyncDispatch() {
+    return false;
+  }
+
   @Override
   protected void doFilterInternal(
       final @NotNull HttpServletRequest httpRequest,
@@ -75,15 +81,8 @@ protected void doFilterInternal(
       throws ServletException, IOException {
 
     if (hub.isEnabled()) {
-      final @Nullable String sentryTraceHeader =
-          httpRequest.getHeader(SentryTraceHeader.SENTRY_TRACE_HEADER);
-      final @Nullable List<String> baggageHeader =
-          Collections.list(httpRequest.getHeaders(BaggageHeader.BAGGAGE_HEADER));
-      final @Nullable TransactionContext transactionContext =
-          hub.continueTrace(sentryTraceHeader, baggageHeader);
-
       if (hub.getOptions().isTracingEnabled() && shouldTraceRequest(httpRequest)) {
-        doFilterWithTransaction(httpRequest, httpResponse, filterChain, transactionContext);
+        doFilterWithTransaction(httpRequest, httpResponse, filterChain);
       } else {
         filterChain.doFilter(httpRequest, httpResponse);
       }
@@ -95,12 +94,24 @@ protected void doFilterInternal(
   private void doFilterWithTransaction(
       HttpServletRequest httpRequest,
       HttpServletResponse httpResponse,
-      FilterChain filterChain,
-      final @Nullable TransactionContext transactionContext)
+      FilterChain filterChain)
       throws IOException, ServletException {
-    // at this stage we are not able to get real transaction name
-    final ITransaction transaction = startTransaction(httpRequest, transactionContext);
-    transaction.getSpanContext().setOrigin(TRACE_ORIGIN);
+    final ITransaction transaction;
+    if (isAsyncDispatch(httpRequest)) {
+      transaction = (ITransaction) httpRequest.getAttribute(TRANSACTION_ATTR);
+    } else {
+      final @Nullable String sentryTraceHeader =
+          httpRequest.getHeader(SentryTraceHeader.SENTRY_TRACE_HEADER);
+      final @Nullable List<String> baggageHeader =
+          Collections.list(httpRequest.getHeaders(BaggageHeader.BAGGAGE_HEADER));
+      final @Nullable TransactionContext transactionContext =
+          hub.continueTrace(sentryTraceHeader, baggageHeader);
+
+      // at this stage we are not able to get real transaction name
+      transaction = startTransaction(httpRequest, transactionContext);
+      transaction.getSpanContext().setOrigin(TRACE_ORIGIN);
+      httpRequest.setAttribute(TRANSACTION_ATTR, transaction);
+    }
 
     try {
       filterChain.doFilter(httpRequest, httpResponse);
@@ -109,21 +120,23 @@ private void doFilterWithTransaction(
       transaction.setStatus(SpanStatus.INTERNAL_ERROR);
       throw e;
     } finally {
-      // after all filters run, templated path pattern is available in request attribute
-      final String transactionName = transactionNameProvider.provideTransactionName(httpRequest);
-      final TransactionNameSource transactionNameSource =
-          transactionNameProvider.provideTransactionSource();
-      // if transaction name is not resolved, the request has not been processed by a controller
-      // and we should not report it to Sentry
-      if (transactionName != null) {
-        transaction.setName(transactionName, transactionNameSource);
-        transaction.setOperation(TRANSACTION_OP);
-        // if exception has been thrown, transaction status is already set to INTERNAL_ERROR, and
-        // httpResponse.getStatus() returns 200.
-        if (transaction.getStatus() == null) {
-          transaction.setStatus(SpanStatus.fromHttpStatusCode(httpResponse.getStatus()));
+      if (!isAsyncStarted(httpRequest)) {
+        // after all filters run, templated path pattern is available in request attribute
+        final String transactionName = transactionNameProvider.provideTransactionName(httpRequest);
+        final TransactionNameSource transactionNameSource =
+            transactionNameProvider.provideTransactionSource();
+        // if transaction name is not resolved, the request has not been processed by a controller
+        // and we should not report it to Sentry
+        if (transactionName != null) {
+          transaction.setName(transactionName, transactionNameSource);
+          transaction.setOperation(TRANSACTION_OP);
+          // if exception has been thrown, transaction status is already set to INTERNAL_ERROR, and
+          // httpResponse.getStatus() returns 200.
+          if (transaction.getStatus() == null) {
+            transaction.setStatus(SpanStatus.fromHttpStatusCode(httpResponse.getStatus()));
+          }
+          transaction.finish();
         }
-        transaction.finish();
       }
     }
   }