io.sentry.spring.jakarta.tracing.TransactionNameProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sentry-spring-jakarta Show documentation

SDK for sentry.io

There is a newer version: 8.0.0-rc.3

Show newest version

package io.sentry.spring.jakarta.tracing;

import io.sentry.protocol.TransactionNameSource;
import jakarta.servlet.http.HttpServletRequest;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Resolves transaction name from {@link HttpServletRequest}.
 *
 * With Spring MVC - use {@link SpringMvcTransactionNameProvider}.
 */
public interface TransactionNameProvider {
  /**
   * Resolves transaction name from {@link HttpServletRequest}.
   *
   * @param request - the http request
   * @return transaction name or {@code null} if not resolved
   */
  @Nullable
  String provideTransactionName(@NotNull HttpServletRequest request);

  /** Returns the source of the transaction name. Only to be used internally. */
  @NotNull
  @ApiStatus.Internal
  default TransactionNameSource provideTransactionSource() {
    return TransactionNameSource.CUSTOM;
  }
}