EventProcessor.java

package io.sentry;

import io.sentry.protocol.SentryTransaction;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * An Event Processor that may mutate or drop an event. Runs for SentryEvent or SentryTransaction
 */
public interface EventProcessor {

  /**
   * May mutate or drop a SentryEvent
   *
   * @param event the SentryEvent
   * @param hint the Hint
   * @return the event itself, a mutated SentryEvent or null
   */
  @Nullable
  default SentryEvent process(@NotNull SentryEvent event, @NotNull Hint hint) {
    return event;
  }

  /**
   * May mutate or drop a SentryTransaction
   *
   * @param transaction the SentryTransaction
   * @param hint the Hint
   * @return the event itself, a mutated SentryTransaction or null
   */
  @Nullable
  default SentryTransaction process(@NotNull SentryTransaction transaction, @NotNull Hint hint) {
    return transaction;
  }

  /**
   * May mutate or drop a SentryEvent
   *
   * @param event the SentryEvent
   * @param hint the Hint
   * @return the event itself, a mutated SentryEvent or null
   */
  @Nullable
  default SentryReplayEvent process(@NotNull SentryReplayEvent event, @NotNull Hint hint) {
    return event;
  }

  /**
   * May mutate or drop a SentryLogEvent
   *
   * @param event the SentryLogEvent
   * @return the event itself, a mutated SentryLogEvent or null
   */
  @Nullable
  default SentryLogEvent process(@NotNull SentryLogEvent event) {
    return event;
  }

  /**
   * May mutate or drop a SentryMetricsEvent
   *
   * @param event the SentryMetricsEvent
   * @return the event itself, a mutated SentryMetricsEvent or null
   */
  @Nullable
  default SentryMetricsEvent process(@NotNull SentryMetricsEvent event, @NotNull Hint hint) {
    return event;
  }

  /**
   * Controls when this EventProcessor is invoked.
   *
   * @return order higher number = later, lower number = earlier (negative values may also be
   *     passed), null = latest (note: multiple event processors using null may lead to random
   *     ordering)
   */
  default @Nullable Long getOrder() {
    return null;
  }
}