SentryClient.java

package io.sentry;

import io.sentry.clientreport.DiscardReason;
import io.sentry.exception.SentryEnvelopeException;
import io.sentry.hints.AbnormalExit;
import io.sentry.hints.ApplyScopeData;
import io.sentry.hints.Backfillable;
import io.sentry.hints.Cached;
import io.sentry.hints.DiskFlushNotification;
import io.sentry.hints.TransactionEnd;
import io.sentry.logger.ILoggerBatchProcessor;
import io.sentry.metrics.IMetricsBatchProcessor;
import io.sentry.protocol.Contexts;
import io.sentry.protocol.DebugMeta;
import io.sentry.protocol.FeatureFlags;
import io.sentry.protocol.Feedback;
import io.sentry.protocol.SentryId;
import io.sentry.protocol.SentryTransaction;
import io.sentry.transport.ITransport;
import io.sentry.transport.RateLimiter;
import io.sentry.util.*;
import java.io.Closeable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.TestOnly;

public final class SentryClient implements ISentryClient {
  static final String SENTRY_PROTOCOL_VERSION = "7";

  private boolean enabled;

  private final @NotNull SentryOptions options;
  private final @NotNull ITransport transport;
  private final @NotNull ILoggerBatchProcessor loggerBatchProcessor;
  private final @NotNull IMetricsBatchProcessor metricsBatchProcessor;

  @Override
  public boolean isEnabled() {
    return enabled;
  }

  public SentryClient(final @NotNull SentryOptions options) {
    this.options = Objects.requireNonNull(options, "SentryOptions is required.");
    this.enabled = true;

    ITransportFactory transportFactory = options.getTransportFactory();
    if (transportFactory instanceof NoOpTransportFactory) {
      transportFactory = new AsyncHttpTransportFactory();
      options.setTransportFactory(transportFactory);
    }

    final RequestDetailsResolver requestDetailsResolver = new RequestDetailsResolver(options);
    transport = transportFactory.create(options, requestDetailsResolver.resolve());
    loggerBatchProcessor = options.getLogs().getLoggerBatchProcessorFactory().create(options, this);
    metricsBatchProcessor =
        options.getMetrics().getMetricsBatchProcessorFactory().create(options, this);
  }

  private boolean shouldApplyScopeData(
      final @NotNull SentryBaseEvent event, final @NotNull Hint hint) {
    if (HintUtils.shouldApplyScopeData(hint)) {
      return true;
    } else {
      options
          .getLogger()
          .log(SentryLevel.DEBUG, "Event was cached so not applying scope: %s", event.getEventId());
      return false;
    }
  }

  private boolean shouldApplyScopeData(final @NotNull CheckIn event, final @NotNull Hint hint) {
    if (HintUtils.shouldApplyScopeData(hint)) {
      return true;
    } else {
      options
          .getLogger()
          .log(
              SentryLevel.DEBUG,
              "Check-in was cached so not applying scope: %s",
              event.getCheckInId());
      return false;
    }
  }

  @Override
  public @NotNull SentryId captureEvent(
      @NotNull SentryEvent event, final @Nullable IScope scope, @Nullable Hint hint) {
    Objects.requireNonNull(event, "SentryEvent is required.");

    // Drop silently to prevent recursion; a log here can re-enter through a logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return SentryId.EMPTY_ID;
    }

    if (hint == null) {
      hint = new Hint();
    }

    // Cached envelopes (e.g. native crashes from the outbox) already carry their attachments as
    // envelope items. Re-applying scope attachments here would duplicate them.
    if (shouldApplyScopeData(event, hint) && !HintUtils.hasType(hint, Cached.class)) {
      addScopeAttachmentsToHint(scope, hint);
    }

    options.getLogger().log(SentryLevel.DEBUG, "Capturing event: %s", event.getEventId());

    if (event != null) {
      final Throwable eventThrowable = event.getThrowable();
      if (eventThrowable != null
          && ExceptionUtils.isIgnored(options.getIgnoredExceptionsForType(), eventThrowable)) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Event was dropped as the exception %s is ignored",
                eventThrowable.getClass());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Error);
        return SentryId.EMPTY_ID;
      }

      if (ErrorUtils.isIgnored(options.getIgnoredErrors(), event)) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Event was dropped as it matched a string/pattern in ignoredErrors",
                event.getMessage());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Error);
        return SentryId.EMPTY_ID;
      }
    }

    if (shouldApplyScopeData(event, hint)) {
      // Event has already passed through here before it was cached
      // Going through again could be reading data that is no longer relevant
      // i.e proguard id, app version, threads
      event = applyScope(event, scope, hint);

      if (event == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Event was dropped by applyScope");
        return SentryId.EMPTY_ID;
      }
    }

    event = processEvent(event, hint, options.getEventProcessors());

    if (event != null) {
      event = executeBeforeSend(event, hint);

      if (event == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Event was dropped by beforeSend");
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.Error);
      }
    }

    if (event != null) {
      event = EventSizeLimitingUtils.limitEventSize(event, hint, options);
    }

    if (event == null) {
      return SentryId.EMPTY_ID;
    }

    @Nullable
    Session sessionBeforeUpdate =
        scope != null ? scope.withSession((@Nullable Session session) -> {}) : null;
    @Nullable Session session = null;

    if (event != null) {
      // https://develop.sentry.dev/sdk/sessions/#terminal-session-states
      if (sessionBeforeUpdate == null || !sessionBeforeUpdate.isTerminated()) {
        session = updateSessionData(event, hint, scope);
      }

      if (!sample()) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Event %s was dropped due to sampling decision.",
                event.getEventId());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.SAMPLE_RATE, DataCategory.Error);
        // setting event as null to not be sent as its been discarded by sample rate
        event = null;
      }
    }

    final boolean shouldSendSessionUpdate =
        shouldSendSessionUpdateForDroppedEvent(sessionBeforeUpdate, session);

    if (event == null && !shouldSendSessionUpdate) {
      options
          .getLogger()
          .log(
              SentryLevel.DEBUG,
              "Not sending session update for dropped event as it did not cause the session health to change.");
      return SentryId.EMPTY_ID;
    }

    SentryId sentryId = SentryId.EMPTY_ID;
    if (event != null && event.getEventId() != null) {
      sentryId = event.getEventId();
    }

    final boolean isBackfillable = HintUtils.hasType(hint, Backfillable.class);
    final boolean isCached =
        HintUtils.hasType(hint, Cached.class) && !HintUtils.hasType(hint, ApplyScopeData.class);
    // if event is backfillable or cached we don't wanna trigger capture replay, because it's
    // an event from the past. If it's cached, but with ApplyScopeData, it comes from the outbox
    // folder and we still want to capture replay (e.g. a native captureException error)
    if (event != null && !isBackfillable && !isCached && (event.isErrored() || event.isCrashed())) {
      boolean shouldCaptureReplay = true;
      final SentryReplayOptions.BeforeErrorSamplingCallback beforeErrorSampling =
          options.getSessionReplay().getBeforeErrorSampling();
      if (beforeErrorSampling != null) {
        try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
          shouldCaptureReplay = beforeErrorSampling.execute(event, hint);
        } catch (Throwable e) {
          options
              .getLogger()
              .log(
                  SentryLevel.ERROR,
                  "The beforeErrorSampling callback threw an exception. Proceeding with replay capture.",
                  e);
          shouldCaptureReplay = true;
        }
      }
      if (shouldCaptureReplay) {
        final @NotNull SentryId scopeReplayId =
            scope != null ? scope.getReplayId() : SentryId.EMPTY_ID;
        final @NotNull SentryId capturedReplayId =
            options.getReplayController().captureReplay(event.isCrashed());
        final @NotNull SentryId replayId =
            !capturedReplayId.equals(SentryId.EMPTY_ID) ? capturedReplayId : scopeReplayId;
        if (scope != null && !replayId.equals(SentryId.EMPTY_ID)) {
          final @Nullable ITransaction transaction = scope.getTransaction();
          if (transaction != null) {
            final @Nullable Baggage baggage = transaction.getSpanContext().getBaggage();
            if (baggage != null) {
              baggage.forceSetReplayId(replayId);
            }
          }
        }
      }
    }

    try {
      final @Nullable TraceContext traceContext = getTraceContext(scope, hint, event);
      final boolean shouldSendAttachments = event != null;
      List<Attachment> attachments = shouldSendAttachments ? getAttachments(hint) : null;
      final @Nullable SentryEnvelope envelope =
          buildEnvelope(event, attachments, session, traceContext, null);

      hint.clear();
      if (envelope != null) {
        sentryId = sendEnvelope(envelope, hint);
      }
    } catch (IOException | SentryEnvelopeException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing event %s failed.", sentryId);

      // if there was an error capturing the event, we return an emptyId
      HintUtils.setCaptureFailed(hint);
      sentryId = SentryId.EMPTY_ID;
    }

    // if we encountered a crash/abnormal exit finish tracing in order to persist and send
    // any running transaction / profiling data.
    if (scope != null) {
      finalizeTransaction(scope, hint);
    }

    return sentryId;
  }

  private void finalizeTransaction(final @NotNull IScope scope, final @NotNull Hint hint) {
    final @Nullable ITransaction transaction = scope.getTransaction();
    if (transaction != null) {
      if (HintUtils.hasType(hint, TransactionEnd.class)) {
        final Object sentrySdkHint = HintUtils.getSentrySdkHint(hint);
        if (sentrySdkHint instanceof DiskFlushNotification) {
          ((DiskFlushNotification) sentrySdkHint).setFlushable(transaction.getEventId());
          transaction.forceFinish(SpanStatus.ABORTED, false, hint);
        } else {
          transaction.forceFinish(SpanStatus.ABORTED, false, null);
        }
      }
    }
  }

  @Override
  public @NotNull SentryId captureReplayEvent(
      @NotNull SentryReplayEvent event, final @Nullable IScope scope, @Nullable Hint hint) {
    Objects.requireNonNull(event, "SessionReplay is required.");

    // Drop silently to prevent recursion; a log here can re-enter through a logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return SentryId.EMPTY_ID;
    }

    if (hint == null) {
      hint = new Hint();
    }

    if (shouldApplyScopeData(event, hint)) {
      applyScope(event, scope);
    }

    options.getLogger().log(SentryLevel.DEBUG, "Capturing session replay: %s", event.getEventId());

    SentryId sentryId = SentryId.EMPTY_ID;
    if (event.getEventId() != null) {
      sentryId = event.getEventId();
    }

    event = processReplayEvent(event, hint, options.getEventProcessors());

    if (event != null) {
      event = executeBeforeSendReplay(event, hint);

      if (event == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Event was dropped by beforeSendReplay");
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.Replay);
      }
    }

    if (event == null) {
      return SentryId.EMPTY_ID;
    }

    try {
      final @Nullable TraceContext traceContext = getTraceContext(scope, hint, event, null);
      final boolean cleanupReplayFolder = HintUtils.hasType(hint, Backfillable.class);
      final SentryEnvelope envelope =
          buildEnvelope(event, hint.getReplayRecording(), traceContext, cleanupReplayFolder);

      hint.clear();
      transport.send(envelope, hint);
    } catch (IOException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing event %s failed.", sentryId);

      // if there was an error capturing the event, we return an emptyId
      sentryId = SentryId.EMPTY_ID;
    }

    return sentryId;
  }

  private void addScopeAttachmentsToHint(@Nullable IScope scope, @NotNull Hint hint) {
    if (scope != null) {
      hint.addAttachments(scope.getAttachments());
    }
  }

  private boolean shouldSendSessionUpdateForDroppedEvent(
      @Nullable Session sessionBeforeUpdate, @Nullable Session sessionAfterUpdate) {
    if (sessionAfterUpdate == null) {
      return false;
    }

    if (sessionBeforeUpdate == null) {
      return true;
    }

    final boolean didSessionMoveToCrashedState =
        sessionAfterUpdate.getStatus() == Session.State.Crashed
            && sessionBeforeUpdate.getStatus() != Session.State.Crashed;
    if (didSessionMoveToCrashedState) {
      return true;
    }

    final boolean didSessionMoveToErroredState =
        sessionAfterUpdate.errorCount() > 0 && sessionBeforeUpdate.errorCount() <= 0;
    if (didSessionMoveToErroredState) {
      return true;
    }

    return false;
  }

  private @Nullable List<Attachment> getAttachments(final @NotNull Hint hint) {
    @NotNull final List<Attachment> attachments = hint.getAttachments();

    @Nullable final Attachment screenshot = hint.getScreenshot();
    if (screenshot != null) {
      attachments.add(screenshot);
    }

    @Nullable final Attachment viewHierarchy = hint.getViewHierarchy();
    if (viewHierarchy != null) {
      attachments.add(viewHierarchy);
    }

    @Nullable final Attachment threadDump = hint.getThreadDump();
    if (threadDump != null) {
      attachments.add(threadDump);
    }

    @Nullable final Attachment tombstone = hint.getTombstone();
    if (tombstone != null) {
      attachments.add(tombstone);
    }

    return attachments;
  }

  private @Nullable SentryEnvelope buildEnvelope(
      final @Nullable SentryBaseEvent event,
      final @Nullable List<Attachment> attachments,
      final @Nullable Session session,
      final @Nullable TraceContext traceContext,
      final @Nullable ProfilingTraceData profilingTraceData)
      throws IOException, SentryEnvelopeException {
    SentryId sentryId = null;

    final List<SentryEnvelopeItem> envelopeItems = new ArrayList<>();

    if (event != null) {
      final SentryEnvelopeItem eventItem =
          SentryEnvelopeItem.fromEvent(options.getSerializer(), event);
      envelopeItems.add(eventItem);
      sentryId = event.getEventId();
    }

    if (session != null) {
      final SentryEnvelopeItem sessionItem =
          SentryEnvelopeItem.fromSession(options.getSerializer(), session);
      envelopeItems.add(sessionItem);
    }

    if (profilingTraceData != null) {
      final SentryEnvelopeItem profilingTraceItem =
          SentryEnvelopeItem.fromProfilingTrace(
              profilingTraceData, options.getMaxTraceFileSize(), options.getSerializer());
      envelopeItems.add(profilingTraceItem);

      if (sentryId == null) {
        sentryId = new SentryId(profilingTraceData.getProfileId());
      }
    }

    if (attachments != null) {
      for (final Attachment attachment : attachments) {
        final SentryEnvelopeItem attachmentItem =
            SentryEnvelopeItem.fromAttachment(
                options.getSerializer(),
                options.getLogger(),
                attachment,
                options.getMaxAttachmentSize());
        envelopeItems.add(attachmentItem);
      }
    }

    if (!envelopeItems.isEmpty()) {
      final SentryEnvelopeHeader envelopeHeader =
          new SentryEnvelopeHeader(sentryId, options.getSdkVersion(), traceContext);

      return new SentryEnvelope(envelopeHeader, envelopeItems);
    }

    return null;
  }

  @Nullable
  private SentryEvent processEvent(
      @NotNull SentryEvent event,
      final @NotNull Hint hint,
      final @NotNull List<EventProcessor> eventProcessors) {
    for (final EventProcessor processor : eventProcessors) {
      try {
        // only wire backfillable events through the backfilling processors, skip from others, and
        // the other way around
        final boolean isBackfillingProcessor = processor instanceof BackfillingEventProcessor;
        final boolean isBackfillable = HintUtils.hasType(hint, Backfillable.class);
        if (isBackfillable && isBackfillingProcessor) {
          event = processor.process(event, hint);
        } else if (!isBackfillable && !isBackfillingProcessor) {
          event = processor.process(event, hint);
        }
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                e,
                "An exception occurred while processing event by processor: %s",
                processor.getClass().getName());
      }

      if (event == null) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Event was dropped by a processor: %s",
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Error);
        break;
      }
    }
    return event;
  }

  @Nullable
  private SentryLogEvent processLogEvent(
      @NotNull SentryLogEvent event, final @NotNull List<EventProcessor> eventProcessors) {
    for (final EventProcessor processor : eventProcessors) {
      final @NotNull SentryLogEvent eventBeforeProcessor = event;
      try {
        event = processor.process(event);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                e,
                "An exception occurred while processing log event by processor: %s",
                processor.getClass().getName());
      }

      if (event == null) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Log event was dropped by a processor: %s",
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.LogItem);
        final long logEventNumberOfBytes =
            JsonSerializationUtils.byteSizeOf(
                options.getSerializer(), options.getLogger(), eventBeforeProcessor);
        options
            .getClientReportRecorder()
            .recordLostEvent(
                DiscardReason.EVENT_PROCESSOR, DataCategory.LogByte, logEventNumberOfBytes);
        break;
      }
    }
    return event;
  }

  @Nullable
  private SentryMetricsEvent processMetricsEvent(
      @NotNull SentryMetricsEvent event,
      final @NotNull List<EventProcessor> eventProcessors,
      final @NotNull Hint hint) {
    for (final EventProcessor processor : eventProcessors) {
      final @NotNull SentryMetricsEvent eventBeforeProcessor = event;
      try {
        event = processor.process(event, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                e,
                "An exception occurred while processing metrics event by processor: %s",
                processor.getClass().getName());
      }

      if (event == null) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Metrics event was dropped by a processor: %s",
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.TraceMetric);
        final long metricsEventNumberOfBytes =
            JsonSerializationUtils.byteSizeOf(
                options.getSerializer(), options.getLogger(), eventBeforeProcessor);
        options
            .getClientReportRecorder()
            .recordLostEvent(
                DiscardReason.EVENT_PROCESSOR,
                DataCategory.TraceMetricByte,
                metricsEventNumberOfBytes);
        break;
      }
    }
    return event;
  }

  private @Nullable SentryTransaction processTransaction(
      @NotNull SentryTransaction transaction,
      final @NotNull Hint hint,
      final @NotNull List<EventProcessor> eventProcessors) {
    for (final EventProcessor processor : eventProcessors) {
      final int spanCountBeforeProcessor = transaction.getSpans().size();
      try {
        transaction = processor.process(transaction, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                e,
                "An exception occurred while processing transaction by processor: %s",
                processor.getClass().getName());
      }
      final int spanCountAfterProcessor = transaction == null ? 0 : transaction.getSpans().size();

      if (transaction == null) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Transaction was dropped by a processor: %s",
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Transaction);
        // If we drop a transaction, we are also dropping all its spans (+1 for the root span)
        options
            .getClientReportRecorder()
            .recordLostEvent(
                DiscardReason.EVENT_PROCESSOR, DataCategory.Span, spanCountBeforeProcessor + 1);
        break;
      } else if (spanCountAfterProcessor < spanCountBeforeProcessor) {
        // If the callback removed some spans, we report it
        final int droppedSpanCount = spanCountBeforeProcessor - spanCountAfterProcessor;
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "%d spans were dropped by a processor: %s",
                droppedSpanCount,
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Span, droppedSpanCount);
      }
    }
    return transaction;
  }

  @Nullable
  private SentryReplayEvent processReplayEvent(
      @NotNull SentryReplayEvent replayEvent,
      final @NotNull Hint hint,
      final @NotNull List<EventProcessor> eventProcessors) {
    for (final EventProcessor processor : eventProcessors) {
      try {
        replayEvent = processor.process(replayEvent, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                e,
                "An exception occurred while processing replay event by processor: %s",
                processor.getClass().getName());
      }

      if (replayEvent == null) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Replay event was dropped by a processor: %s",
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Replay);
        break;
      }
    }
    return replayEvent;
  }

  @Nullable
  private SentryEvent processFeedbackEvent(
      @NotNull SentryEvent feedbackEvent,
      final @NotNull Hint hint,
      final @NotNull List<EventProcessor> eventProcessors) {
    for (final EventProcessor processor : eventProcessors) {
      try {
        feedbackEvent = processor.process(feedbackEvent, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                e,
                "An exception occurred while processing feedback event by processor: %s",
                processor.getClass().getName());
      }

      if (feedbackEvent == null) {
        options
            .getLogger()
            .log(
                SentryLevel.DEBUG,
                "Feedback event was dropped by a processor: %s",
                processor.getClass().getName());
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Feedback);
        break;
      }
    }
    return feedbackEvent;
  }

  @Deprecated
  @Override
  public void captureUserFeedback(final @NotNull UserFeedback userFeedback) {
    Objects.requireNonNull(userFeedback, "SentryEvent is required.");

    if (SentryId.EMPTY_ID.equals(userFeedback.getEventId())) {
      options.getLogger().log(SentryLevel.WARNING, "Capturing userFeedback without a Sentry Id.");
      return;
    }
    options
        .getLogger()
        .log(SentryLevel.DEBUG, "Capturing userFeedback: %s", userFeedback.getEventId());

    try {
      final @NotNull SentryEnvelope envelope = buildEnvelope(userFeedback);
      sendEnvelope(envelope, null);
    } catch (IOException e) {
      options
          .getLogger()
          .log(
              SentryLevel.WARNING,
              e,
              "Capturing user feedback %s failed.",
              userFeedback.getEventId());
    }
  }

  @Deprecated
  private @NotNull SentryEnvelope buildEnvelope(final @NotNull UserFeedback userFeedback) {
    final List<SentryEnvelopeItem> envelopeItems = new ArrayList<>();

    final SentryEnvelopeItem userFeedbackItem =
        SentryEnvelopeItem.fromUserFeedback(options.getSerializer(), userFeedback);
    envelopeItems.add(userFeedbackItem);

    final SentryEnvelopeHeader envelopeHeader =
        new SentryEnvelopeHeader(userFeedback.getEventId(), options.getSdkVersion());

    return new SentryEnvelope(envelopeHeader, envelopeItems);
  }

  private @NotNull SentryEnvelope buildEnvelope(
      final @NotNull CheckIn checkIn, final @Nullable TraceContext traceContext) {
    final List<SentryEnvelopeItem> envelopeItems = new ArrayList<>();

    final SentryEnvelopeItem checkInItem =
        SentryEnvelopeItem.fromCheckIn(options.getSerializer(), checkIn);
    envelopeItems.add(checkInItem);

    final SentryEnvelopeHeader envelopeHeader =
        new SentryEnvelopeHeader(checkIn.getCheckInId(), options.getSdkVersion(), traceContext);

    return new SentryEnvelope(envelopeHeader, envelopeItems);
  }

  private @NotNull SentryEnvelope buildEnvelope(final @NotNull SentryLogEvents logEvents) {
    final List<SentryEnvelopeItem> envelopeItems = new ArrayList<>();

    final SentryEnvelopeItem logItem =
        SentryEnvelopeItem.fromLogs(options.getSerializer(), logEvents);
    envelopeItems.add(logItem);

    final SentryEnvelopeHeader envelopeHeader =
        new SentryEnvelopeHeader(null, options.getSdkVersion(), null);

    return new SentryEnvelope(envelopeHeader, envelopeItems);
  }

  private @NotNull SentryEnvelope buildEnvelope(final @NotNull SentryMetricsEvents metricsEvents) {
    final List<SentryEnvelopeItem> envelopeItems = new ArrayList<>();

    final SentryEnvelopeItem metricsItem =
        SentryEnvelopeItem.fromMetrics(options.getSerializer(), metricsEvents);
    envelopeItems.add(metricsItem);

    final SentryEnvelopeHeader envelopeHeader =
        new SentryEnvelopeHeader(null, options.getSdkVersion(), null);

    return new SentryEnvelope(envelopeHeader, envelopeItems);
  }

  private @NotNull SentryEnvelope buildEnvelope(
      final @NotNull SentryReplayEvent event,
      final @Nullable ReplayRecording replayRecording,
      final @Nullable TraceContext traceContext,
      final boolean cleanupReplayFolder) {
    final List<SentryEnvelopeItem> envelopeItems = new ArrayList<>();

    final SentryEnvelopeItem replayItem =
        SentryEnvelopeItem.fromReplay(
            options.getSerializer(),
            options.getLogger(),
            event,
            replayRecording,
            cleanupReplayFolder);
    envelopeItems.add(replayItem);
    final SentryId sentryId = event.getEventId();

    // SdkVersion from ReplayOptions defaults to SdkVersion from SentryOptions and can be
    // overwritten by the hybrid SDKs
    final SentryEnvelopeHeader envelopeHeader =
        new SentryEnvelopeHeader(
            sentryId, options.getSessionReplay().getSdkVersion(), traceContext);

    return new SentryEnvelope(envelopeHeader, envelopeItems);
  }

  /**
   * Updates the session data based on the event, hint and scope data
   *
   * @param event the SentryEvent
   * @param hint the hint or null
   * @param scope the Scope or null
   */
  @TestOnly
  @Nullable
  Session updateSessionData(
      final @NotNull SentryEvent event, final @NotNull Hint hint, final @Nullable IScope scope) {
    Session clonedSession = null;

    if (HintUtils.shouldApplyScopeData(hint)) {
      if (scope != null) {
        clonedSession =
            scope.withSession(
                session -> {
                  if (session != null) {
                    Session.State status = null;
                    if (event.isCrashed()) {
                      status = Session.State.Crashed;
                    }

                    boolean crashedOrErrored = false;
                    if (Session.State.Crashed == status || event.isErrored()) {
                      crashedOrErrored = true;
                    }

                    String userAgent = null;
                    if (event.getRequest() != null && event.getRequest().getHeaders() != null) {
                      if (event.getRequest().getHeaders().containsKey("user-agent")) {
                        userAgent = event.getRequest().getHeaders().get("user-agent");
                      }
                    }

                    final Object sentrySdkHint = HintUtils.getSentrySdkHint(hint);
                    @Nullable String abnormalMechanism = null;
                    if (sentrySdkHint instanceof AbnormalExit) {
                      abnormalMechanism = ((AbnormalExit) sentrySdkHint).mechanism();
                      status = Session.State.Abnormal;
                    }

                    if (session.update(status, userAgent, crashedOrErrored, abnormalMechanism)) {
                      // if session terminated we can end it.
                      if (session.isTerminated()) {
                        session.end();
                      }
                    }
                  } else {
                    options
                        .getLogger()
                        .log(SentryLevel.INFO, "Session is null on scope.withSession");
                  }
                });
      } else {
        options.getLogger().log(SentryLevel.INFO, "Scope is null on client.captureEvent");
      }
    }
    return clonedSession;
  }

  @ApiStatus.Internal
  @Override
  public void captureSession(final @NotNull Session session, final @Nullable Hint hint) {
    Objects.requireNonNull(session, "Session is required.");

    if (session.getRelease() == null || session.getRelease().isEmpty()) {
      options
          .getLogger()
          .log(SentryLevel.WARNING, "Sessions can't be captured without setting a release.");
      return;
    }

    SentryEnvelope envelope;
    try {
      envelope = SentryEnvelope.from(options.getSerializer(), session, options.getSdkVersion());
    } catch (IOException e) {
      options.getLogger().log(SentryLevel.ERROR, "Failed to capture session.", e);
      return;
    }

    captureEnvelope(envelope, hint);
  }

  @ApiStatus.Internal
  @Override
  public @NotNull SentryId captureEnvelope(
      final @NotNull SentryEnvelope envelope, @Nullable Hint hint) {
    Objects.requireNonNull(envelope, "SentryEnvelope is required.");

    if (hint == null) {
      hint = new Hint();
    }

    try {
      hint.clear();
      return sendEnvelope(envelope, hint);
    } catch (IOException e) {
      options.getLogger().log(SentryLevel.ERROR, "Failed to capture envelope.", e);
    }
    return SentryId.EMPTY_ID;
  }

  private @NotNull SentryId sendEnvelope(
      @NotNull final SentryEnvelope envelope, @Nullable final Hint hint) throws IOException {
    // captureEnvelope and captureCheckIn have no entry-level guard, so a callback that captures
    // one of those would recurse back into beforeEnvelopeCallback. In normal flow the guard is
    // already inactive by the time we get here (the before* callback has exited), so an active
    // guard means a callback triggered this send. Drop silently: a log here can re-enter through a
    // logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return SentryId.EMPTY_ID;
    }

    final @Nullable SentryOptions.BeforeEnvelopeCallback beforeEnvelopeCallback =
        options.getBeforeEnvelopeCallback();
    if (beforeEnvelopeCallback != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        beforeEnvelopeCallback.execute(envelope, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(SentryLevel.ERROR, "The BeforeEnvelope callback threw an exception.", e);
      }
    }

    SentryIntegrationPackageStorage.getInstance().checkForMixedVersions(options.getLogger());

    if (hint == null) {
      transport.send(envelope);
    } else {
      transport.send(envelope, hint);
    }
    final @Nullable SentryId id = envelope.getHeader().getEventId();
    return id != null ? id : SentryId.EMPTY_ID;
  }

  @Override
  public @NotNull SentryId captureTransaction(
      @NotNull SentryTransaction transaction,
      @Nullable TraceContext traceContext,
      final @Nullable IScope scope,
      @Nullable Hint hint,
      final @Nullable ProfilingTraceData profilingTraceData) {
    Objects.requireNonNull(transaction, "Transaction is required.");

    // Drop silently to prevent recursion; a log here can re-enter through a logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return SentryId.EMPTY_ID;
    }

    if (hint == null) {
      hint = new Hint();
    }

    if (shouldApplyScopeData(transaction, hint)) {
      addScopeAttachmentsToHint(scope, hint);
    }

    options
        .getLogger()
        .log(SentryLevel.DEBUG, "Capturing transaction: %s", transaction.getEventId());

    if (TracingUtils.isIgnored(options.getIgnoredTransactions(), transaction.getTransaction())) {
      options
          .getLogger()
          .log(
              SentryLevel.DEBUG,
              "Transaction was dropped as transaction name %s is ignored",
              transaction.getTransaction());
      options
          .getClientReportRecorder()
          .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Transaction);
      options
          .getClientReportRecorder()
          .recordLostEvent(
              DiscardReason.EVENT_PROCESSOR, DataCategory.Span, transaction.getSpans().size() + 1);
      return SentryId.EMPTY_ID;
    }

    SentryId sentryId = SentryId.EMPTY_ID;
    if (transaction.getEventId() != null) {
      sentryId = transaction.getEventId();
    }

    if (shouldApplyScopeData(transaction, hint)) {
      transaction = applyScope(transaction, scope, HintUtils.hasType(hint, Cached.class));

      if (transaction != null && scope != null) {
        transaction = processTransaction(transaction, hint, scope.getEventProcessors());
      }

      if (transaction == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Transaction was dropped by applyScope");
      }
    }

    if (transaction != null) {
      transaction = processTransaction(transaction, hint, options.getEventProcessors());
    }

    if (transaction == null) {
      options.getLogger().log(SentryLevel.DEBUG, "Transaction was dropped by Event processors.");
      return SentryId.EMPTY_ID;
    }

    final int spanCountBeforeCallback = transaction.getSpans().size();
    transaction = executeBeforeSendTransaction(transaction, hint);
    final int spanCountAfterCallback = transaction == null ? 0 : transaction.getSpans().size();

    if (transaction == null) {
      options
          .getLogger()
          .log(SentryLevel.DEBUG, "Transaction was dropped by beforeSendTransaction.");
      options
          .getClientReportRecorder()
          .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.Transaction);
      // If we drop a transaction, we are also dropping all its spans (+1 for the root span)
      options
          .getClientReportRecorder()
          .recordLostEvent(
              DiscardReason.BEFORE_SEND, DataCategory.Span, spanCountBeforeCallback + 1);
      return SentryId.EMPTY_ID;
    } else if (spanCountAfterCallback < spanCountBeforeCallback) {
      // If the callback removed some spans, we report it
      final int droppedSpanCount = spanCountBeforeCallback - spanCountAfterCallback;
      options
          .getLogger()
          .log(
              SentryLevel.DEBUG,
              "%d spans were dropped by beforeSendTransaction.",
              droppedSpanCount);
      options
          .getClientReportRecorder()
          .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.Span, droppedSpanCount);
    }

    try {
      final SentryEnvelope envelope =
          buildEnvelope(
              transaction,
              filterForTransaction(getAttachments(hint)),
              null,
              traceContext,
              profilingTraceData);

      hint.clear();
      if (envelope != null) {
        sentryId = sendEnvelope(envelope, hint);
      }
    } catch (IOException | SentryEnvelopeException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing transaction %s failed.", sentryId);
      // if there was an error capturing the event, we return an emptyId
      sentryId = SentryId.EMPTY_ID;
    }

    if (!sentryId.equals(SentryId.EMPTY_ID)) {
      final @Nullable SpanContext trace = transaction.getContexts().getTrace();
      if (trace != null) {
        options.getReplayController().registerTraceId(trace.getTraceId());
      }
      final @Nullable String segmentName = transaction.getTransaction();
      if (segmentName != null && !segmentName.isEmpty()) {
        options.getReplayController().registerSegmentName(segmentName);
      }
    }

    return sentryId;
  }

  @ApiStatus.Internal
  @Override
  public @NotNull SentryId captureProfileChunk(
      @NotNull ProfileChunk profileChunk, final @Nullable IScope scope) {
    Objects.requireNonNull(profileChunk, "profileChunk is required.");

    options
        .getLogger()
        .log(SentryLevel.DEBUG, "Capturing profile chunk: %s", profileChunk.getChunkId());

    @NotNull SentryId sentryId = profileChunk.getChunkId();
    final DebugMeta debugMeta = DebugMeta.buildDebugMeta(profileChunk.getDebugMeta(), options);
    if (debugMeta != null) {
      profileChunk.setDebugMeta(debugMeta);
    }

    // BeforeSend and EventProcessors are not supported at the moment for Profile Chunks

    try {
      final SentryEnvelopeItem envelopeItem;
      if (ProfileChunk.CONTENT_TYPE_PERFETTO.equals(profileChunk.getContentType())) {
        envelopeItem =
            SentryEnvelopeItem.fromPerfettoProfileChunk(profileChunk, options.getSerializer());
      } else {
        envelopeItem =
            SentryEnvelopeItem.fromProfileChunk(
                profileChunk, options.getSerializer(), options.getProfilerConverter());
      }
      final @NotNull SentryEnvelope envelope =
          new SentryEnvelope(
              new SentryEnvelopeHeader(sentryId, options.getSdkVersion(), null),
              Collections.singletonList(envelopeItem));
      sentryId = sendEnvelope(envelope, null);
    } catch (IOException | SentryEnvelopeException e) {
      options
          .getLogger()
          .log(SentryLevel.WARNING, e, "Capturing profile chunk %s failed.", sentryId);
      // if there was an error capturing the event, we return an emptyId
      sentryId = SentryId.EMPTY_ID;
    }

    return sentryId;
  }

  @Override
  public @NotNull SentryId captureCheckIn(
      @NotNull CheckIn checkIn, final @Nullable IScope scope, @Nullable Hint hint) {
    if (hint == null) {
      hint = new Hint();
    }

    if (checkIn.getEnvironment() == null) {
      checkIn.setEnvironment(options.getEnvironment());
    }

    if (checkIn.getRelease() == null) {
      checkIn.setRelease(options.getRelease());
    }

    if (shouldApplyScopeData(checkIn, hint)) {
      checkIn = applyScope(checkIn, scope);
    }

    if (CheckInUtils.isIgnored(options.getIgnoredCheckIns(), checkIn.getMonitorSlug())) {
      options
          .getLogger()
          .log(
              SentryLevel.DEBUG,
              "Check-in was dropped as slug %s is ignored",
              checkIn.getMonitorSlug());
      options
          .getClientReportRecorder()
          .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Monitor);
      return SentryId.EMPTY_ID;
    }

    options.getLogger().log(SentryLevel.DEBUG, "Capturing check-in: %s", checkIn.getCheckInId());

    SentryId sentryId = checkIn.getCheckInId();

    try {
      final @Nullable TraceContext traceContext = getTraceContext(scope, hint, null);
      final @NotNull SentryEnvelope envelope = buildEnvelope(checkIn, traceContext);

      hint.clear();
      sentryId = sendEnvelope(envelope, hint);
    } catch (IOException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing check-in %s failed.", sentryId);
      // if there was an error capturing the event, we return an emptyId
      sentryId = SentryId.EMPTY_ID;
    }

    return sentryId;
  }

  /**
   * Captures the feedback.
   *
   * @param feedback The feedback to send.
   * @param hint An optional hint to be applied to the event.
   * @param scope An optional scope to be applied to the event.
   * @return The Id (SentryId object) of the event
   */
  @Override
  public @NotNull SentryId captureFeedback(
      final @NotNull Feedback feedback, @Nullable Hint hint, final @NotNull IScope scope) {
    // Drop silently to prevent recursion; a log here can re-enter through a logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return SentryId.EMPTY_ID;
    }

    SentryEvent event = new SentryEvent();
    event.getContexts().setFeedback(feedback);

    if (hint == null) {
      hint = new Hint();
    }

    if (feedback.getUrl() == null) {
      feedback.setUrl(scope.getScreen());
    }

    options.getLogger().log(SentryLevel.DEBUG, "Capturing feedback: %s", event.getEventId());

    if (shouldApplyScopeData(event, hint)) {
      // Event has already passed through here before it was cached
      // Going through again could be reading data that is no longer relevant
      // i.e proguard id, app version, threads
      event = applyFeedbackScope(event, scope, hint);

      if (event == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Feedback was dropped by applyScope");
        return SentryId.EMPTY_ID;
      }
    }

    event = processFeedbackEvent(event, hint, options.getEventProcessors());

    if (event != null) {
      event = executeBeforeSendFeedback(event, hint);

      if (event == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Event was dropped by beforeSend");
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.Feedback);
      }
    }

    if (event == null) {
      return SentryId.EMPTY_ID;
    }

    SentryId sentryId = SentryId.EMPTY_ID;
    if (event.getEventId() != null) {
      sentryId = event.getEventId();
    }

    // If feedback already has a replayId, we don't want to overwrite it.
    if (feedback.getReplayId() == null) {
      final @NotNull SentryId scopeReplayId = scope.getReplayId();
      final @NotNull SentryId capturedReplayId = options.getReplayController().captureReplay(false);
      final @NotNull SentryId replayId =
          !capturedReplayId.equals(SentryId.EMPTY_ID) ? capturedReplayId : scopeReplayId;
      if (!replayId.equals(SentryId.EMPTY_ID)) {
        feedback.setReplayId(replayId);
      }
    }

    try {
      final @Nullable TraceContext traceContext = getTraceContext(scope, hint, event);
      final List<Attachment> attachments = getAttachments(hint);
      final @Nullable SentryEnvelope envelope =
          buildEnvelope(event, attachments, null, traceContext, null);

      hint.clear();
      if (envelope != null) {
        sentryId = sendEnvelope(envelope, hint);
      }
    } catch (IOException | SentryEnvelopeException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing feedback %s failed.", sentryId);

      // if there was an error capturing the event, we return an emptyId
      sentryId = SentryId.EMPTY_ID;
    }

    return sentryId;
  }

  private @Nullable TraceContext getTraceContext(
      final @Nullable IScope scope, final @NotNull Hint hint, final @Nullable SentryEvent event) {
    return getTraceContext(scope, hint, event, event != null ? event.getTransaction() : null);
  }

  private @Nullable TraceContext getTraceContext(
      final @Nullable IScope scope,
      final @NotNull Hint hint,
      final @Nullable SentryBaseEvent event,
      final @Nullable String txn) {
    @Nullable TraceContext traceContext = null;
    final boolean isBackfillable = HintUtils.hasType(hint, Backfillable.class);
    if (isBackfillable) {
      // for backfillable hint we synthesize Baggage from event values
      if (event != null) {
        final Baggage baggage = Baggage.fromEvent(event, txn, options);
        traceContext = baggage.toTraceContext();
      }
    } else if (scope != null) {
      final @Nullable ITransaction transaction = scope.getTransaction();
      if (transaction != null) {
        traceContext = transaction.traceContext();
      } else {
        final @NotNull PropagationContext propagationContext =
            TracingUtils.maybeUpdateBaggage(scope, options);
        traceContext = propagationContext.traceContext();
      }
    }
    return traceContext;
  }

  @ApiStatus.Experimental
  @Override
  public void captureLog(@Nullable SentryLogEvent logEvent, @Nullable IScope scope) {
    // Drop silently to prevent recursion; a log here can re-enter through a logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return;
    }

    if (logEvent != null && scope != null) {
      logEvent = processLogEvent(logEvent, scope.getEventProcessors());
      if (logEvent == null) {
        return;
      }
    }

    if (logEvent != null) {
      logEvent = processLogEvent(logEvent, options.getEventProcessors());
      if (logEvent == null) {
        return;
      }
    }

    if (logEvent != null) {
      final @NotNull SentryLogEvent tmpLogEvent = logEvent;
      logEvent = executeBeforeSendLog(logEvent);

      if (logEvent == null) {
        options.getLogger().log(SentryLevel.DEBUG, "Log Event was dropped by beforeSendLog");
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.LogItem);
        final @NotNull long logEventNumberOfBytes =
            JsonSerializationUtils.byteSizeOf(
                options.getSerializer(), options.getLogger(), tmpLogEvent);
        options
            .getClientReportRecorder()
            .recordLostEvent(
                DiscardReason.BEFORE_SEND, DataCategory.LogByte, logEventNumberOfBytes);
        return;
      }

      loggerBatchProcessor.add(logEvent);
    }
  }

  @ApiStatus.Internal
  @Override
  public void captureBatchedLogEvents(final @NotNull SentryLogEvents logEvents) {
    try {
      final @NotNull SentryEnvelope envelope = buildEnvelope(logEvents);
      sendEnvelope(envelope, null);
    } catch (IOException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing logs failed.");
    }
  }

  @ApiStatus.Experimental
  @Override
  public void captureMetric(
      @Nullable SentryMetricsEvent metricsEvent,
      final @Nullable IScope scope,
      @Nullable Hint hint) {
    // Drop silently to prevent recursion; a log here can re-enter through a logging integration.
    if (SentryCallbackReentrancyGuard.isActive()) {
      return;
    }

    if (hint == null) {
      hint = new Hint();
    }

    if (metricsEvent != null && scope != null) {
      metricsEvent = processMetricsEvent(metricsEvent, scope.getEventProcessors(), hint);
      if (metricsEvent == null) {
        return;
      }
    }

    if (metricsEvent != null) {
      metricsEvent = processMetricsEvent(metricsEvent, options.getEventProcessors(), hint);
      if (metricsEvent == null) {
        return;
      }
    }

    if (metricsEvent != null) {
      final @NotNull SentryMetricsEvent tmpMetricsEvent = metricsEvent;
      metricsEvent = executeBeforeSendMetric(metricsEvent, hint);

      if (metricsEvent == null) {
        options
            .getLogger()
            .log(SentryLevel.DEBUG, "Metrics Event was dropped by beforeSendMetrics");
        options
            .getClientReportRecorder()
            .recordLostEvent(DiscardReason.BEFORE_SEND, DataCategory.TraceMetric);
        final long metricsEventNumberOfBytes =
            JsonSerializationUtils.byteSizeOf(
                options.getSerializer(), options.getLogger(), tmpMetricsEvent);
        options
            .getClientReportRecorder()
            .recordLostEvent(
                DiscardReason.BEFORE_SEND, DataCategory.TraceMetricByte, metricsEventNumberOfBytes);
        return;
      }

      metricsBatchProcessor.add(metricsEvent);
    }
  }

  @ApiStatus.Internal
  @Override
  public void captureBatchedMetricsEvents(final @NotNull SentryMetricsEvents metricsEvents) {
    try {
      final @NotNull SentryEnvelope envelope = buildEnvelope(metricsEvents);
      sendEnvelope(envelope, null);
    } catch (IOException e) {
      options.getLogger().log(SentryLevel.WARNING, e, "Capturing metrics failed.");
    }
  }

  private @Nullable List<Attachment> filterForTransaction(@Nullable List<Attachment> attachments) {
    if (attachments == null) {
      return null;
    }

    List<Attachment> attachmentsToSend = new ArrayList<>();
    for (Attachment attachment : attachments) {
      if (attachment.isAddToTransactions()) {
        attachmentsToSend.add(attachment);
      }
    }

    return attachmentsToSend;
  }

  private @Nullable SentryEvent applyScope(
      @NotNull SentryEvent event, final @Nullable IScope scope, final @NotNull Hint hint) {
    if (scope != null) {
      applyScope(event, scope, HintUtils.hasType(hint, Cached.class));

      if (event.getTransaction() == null) {
        event.setTransaction(scope.getTransactionName());
      }
      if (event.getFingerprints() == null) {
        event.setFingerprints(scope.getFingerprint());
      }
      // Level from scope exceptionally take precedence over the event
      if (scope.getLevel() != null) {
        event.setLevel(scope.getLevel());
      }
      // Set trace data from active span to connect events with transactions
      final ISpan span = scope.getSpan();
      if (event.getContexts().getTrace() == null) {
        if (span == null) {
          event
              .getContexts()
              .setTrace(TransactionContext.fromPropagationContext(scope.getPropagationContext()));
        } else {
          event.getContexts().setTrace(span.getSpanContext());
        }
      }

      if (event.getContexts().getFeatureFlags() == null) {
        final @Nullable FeatureFlags featureFlags = scope.getFeatureFlags();
        if (featureFlags != null) {
          event.getContexts().setFeatureFlags(featureFlags);
        }
      }

      event = processEvent(event, hint, scope.getEventProcessors());
    }
    return event;
  }

  private @Nullable SentryEvent applyFeedbackScope(
      @NotNull SentryEvent event, final @NotNull IScope scope, final @NotNull Hint hint) {

    if (event.getUser() == null) {
      event.setUser(scope.getUser());
    }
    if (event.getTags() == null) {
      event.setTags(scope.getTags());
    } else {
      for (Map.Entry<String, String> item : scope.getTags().entrySet()) {
        if (!event.getTags().containsKey(item.getKey())) {
          event.getTags().put(item.getKey(), item.getValue());
        }
      }
    }
    final Contexts contexts = event.getContexts();
    for (Map.Entry<String, Object> entry : new Contexts(scope.getContexts()).entrySet()) {
      if (!contexts.containsKey(entry.getKey())) {
        contexts.put(entry.getKey(), entry.getValue());
      }
    }
    // Set trace data from active span to connect events with transactions
    final ISpan span = scope.getSpan();
    if (event.getContexts().getTrace() == null) {
      if (span == null) {
        event
            .getContexts()
            .setTrace(TransactionContext.fromPropagationContext(scope.getPropagationContext()));
      } else {
        event.getContexts().setTrace(span.getSpanContext());
      }
    }

    event = processFeedbackEvent(event, hint, scope.getEventProcessors());
    return event;
  }

  private @NotNull CheckIn applyScope(@NotNull CheckIn checkIn, final @Nullable IScope scope) {
    if (scope != null) {
      // Set trace data from active span to connect events with transactions
      final ISpan span = scope.getSpan();
      if (checkIn.getContexts().getTrace() == null) {
        if (span == null) {
          checkIn
              .getContexts()
              .setTrace(TransactionContext.fromPropagationContext(scope.getPropagationContext()));
        } else {
          checkIn.getContexts().setTrace(span.getSpanContext());
        }
      }
    }
    return checkIn;
  }

  private @NotNull SentryReplayEvent applyScope(
      final @NotNull SentryReplayEvent replayEvent, final @Nullable IScope scope) {
    // no breadcrumbs and extras for replay events
    if (scope != null) {
      if (replayEvent.getRequest() == null) {
        replayEvent.setRequest(scope.getRequest());
      }
      if (replayEvent.getUser() == null) {
        replayEvent.setUser(scope.getUser());
      }
      if (replayEvent.getTags() == null) {
        replayEvent.setTags(scope.getTags());
      } else {
        for (Map.Entry<String, String> item : scope.getTags().entrySet()) {
          if (!replayEvent.getTags().containsKey(item.getKey())) {
            replayEvent.getTags().put(item.getKey(), item.getValue());
          }
        }
      }
      final Contexts contexts = replayEvent.getContexts();
      for (Map.Entry<String, Object> entry : new Contexts(scope.getContexts()).entrySet()) {
        if (!contexts.containsKey(entry.getKey())) {
          contexts.put(entry.getKey(), entry.getValue());
        }
      }

      // Set trace data from active span to connect replays with transactions
      final ISpan span = scope.getSpan();
      if (replayEvent.getContexts().getTrace() == null) {
        if (span == null) {
          replayEvent
              .getContexts()
              .setTrace(TransactionContext.fromPropagationContext(scope.getPropagationContext()));
        } else {
          replayEvent.getContexts().setTrace(span.getSpanContext());
        }
      }
    }
    return replayEvent;
  }

  private <T extends SentryBaseEvent> @NotNull T applyScope(
      final @NotNull T sentryBaseEvent, final @Nullable IScope scope, final boolean isCached) {
    if (scope != null) {
      if (sentryBaseEvent.getRequest() == null) {
        sentryBaseEvent.setRequest(scope.getRequest());
      }
      if (sentryBaseEvent.getUser() == null) {
        sentryBaseEvent.setUser(scope.getUser());
      }
      if (sentryBaseEvent.getTags() == null) {
        sentryBaseEvent.setTags(scope.getTags());
      } else {
        for (Map.Entry<String, String> item : scope.getTags().entrySet()) {
          if (!sentryBaseEvent.getTags().containsKey(item.getKey())) {
            sentryBaseEvent.getTags().put(item.getKey(), item.getValue());
          }
        }
      }
      final List<Breadcrumb> eventBreadcrumbs = sentryBaseEvent.getBreadcrumbs();
      if (eventBreadcrumbs == null || eventBreadcrumbs.isEmpty()) {
        // A cached event comes from the outbox; its breadcrumbs (even if empty) belong to a
        // past session, so the current scope's breadcrumbs are unrelated and must not be applied.
        if (!isCached) {
          sentryBaseEvent.setBreadcrumbs(new ArrayList<>(scope.getBreadcrumbs()));
        }
      } else if (!isCached) {
        // A Cached event comes from the outbox and already carries its own breadcrumbs (e.g. native
        // events written by sentry-native). Appending the scope's breadcrumbs would duplicate them.
        sortBreadcrumbsByDate(sentryBaseEvent, scope.getBreadcrumbs());
      }
      if (sentryBaseEvent.getExtras() == null) {
        sentryBaseEvent.setExtras(scope.getExtras());
      } else {
        for (Map.Entry<String, Object> item : scope.getExtras().entrySet()) {
          if (!sentryBaseEvent.getExtras().containsKey(item.getKey())) {
            sentryBaseEvent.getExtras().put(item.getKey(), item.getValue());
          }
        }
      }
      final Contexts contexts = sentryBaseEvent.getContexts();
      for (Map.Entry<String, Object> entry : new Contexts(scope.getContexts()).entrySet()) {
        if (!contexts.containsKey(entry.getKey())) {
          contexts.put(entry.getKey(), entry.getValue());
        }
      }
    }
    return sentryBaseEvent;
  }

  private void sortBreadcrumbsByDate(
      final @NotNull SentryBaseEvent event, final @NotNull Collection<Breadcrumb> breadcrumbs) {
    final List<Breadcrumb> sortedBreadcrumbs = event.getBreadcrumbs();

    if (sortedBreadcrumbs != null && !breadcrumbs.isEmpty()) {
      sortedBreadcrumbs.addAll(breadcrumbs);
      Collections.sort(sortedBreadcrumbs);
    }
  }

  private @Nullable SentryEvent executeBeforeSend(
      @NotNull SentryEvent event, final @NotNull Hint hint) {
    final SentryOptions.BeforeSendCallback beforeSend = options.getBeforeSend();
    if (beforeSend != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        event = beforeSend.execute(event, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                "The BeforeSend callback threw an exception. It will be added as breadcrumb and continue.",
                e);

        // drop event in case of an error in beforeSend due to PII concerns
        event = null;
      }
    }
    return event;
  }

  private @Nullable SentryTransaction executeBeforeSendTransaction(
      @NotNull SentryTransaction transaction, final @NotNull Hint hint) {
    final SentryOptions.BeforeSendTransactionCallback beforeSendTransaction =
        options.getBeforeSendTransaction();
    if (beforeSendTransaction != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        transaction = beforeSendTransaction.execute(transaction, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                "The BeforeSendTransaction callback threw an exception. It will be added as breadcrumb and continue.",
                e);

        // drop transaction in case of an error in beforeSend due to PII concerns
        transaction = null;
      }
    }
    return transaction;
  }

  private @Nullable SentryEvent executeBeforeSendFeedback(
      @NotNull SentryEvent event, final @NotNull Hint hint) {
    final SentryOptions.BeforeSendCallback beforeSendFeedback = options.getBeforeSendFeedback();
    if (beforeSendFeedback != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        event = beforeSendFeedback.execute(event, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(SentryLevel.ERROR, "The BeforeSendFeedback callback threw an exception.", e);

        // drop feedback in case of an error in beforeSend due to PII concerns
        event = null;
      }
    }
    return event;
  }

  private @Nullable SentryReplayEvent executeBeforeSendReplay(
      @NotNull SentryReplayEvent event, final @NotNull Hint hint) {
    final SentryOptions.BeforeSendReplayCallback beforeSendReplay = options.getBeforeSendReplay();
    if (beforeSendReplay != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        event = beforeSendReplay.execute(event, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                "The BeforeSendReplay callback threw an exception. It will be added as breadcrumb and continue.",
                e);

        // drop event in case of an error in beforeSend due to PII concerns
        event = null;
      }
    }
    return event;
  }

  private @Nullable SentryLogEvent executeBeforeSendLog(@NotNull SentryLogEvent event) {
    final SentryOptions.Logs.BeforeSendLogCallback beforeSendLog =
        options.getLogs().getBeforeSend();
    if (beforeSendLog != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        event = beforeSendLog.execute(event);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                "The BeforeSendLog callback threw an exception. Dropping log event.",
                e);

        // drop event in case of an error in beforeSendLog due to PII concerns
        event = null;
      }
    }
    return event;
  }

  private @Nullable SentryMetricsEvent executeBeforeSendMetric(
      @NotNull SentryMetricsEvent event, final @NotNull Hint hint) {
    final SentryOptions.Metrics.BeforeSendMetricCallback beforeSendMetric =
        options.getMetrics().getBeforeSend();
    if (beforeSendMetric != null) {
      try (final @NotNull ISentryLifecycleToken ignored = SentryCallbackReentrancyGuard.enter()) {
        event = beforeSendMetric.execute(event, hint);
      } catch (Throwable e) {
        options
            .getLogger()
            .log(
                SentryLevel.ERROR,
                "The BeforeSendMetric callback threw an exception. Dropping metrics event.",
                e);

        // drop event in case of an error in beforeSendMetric due to PII concerns
        event = null;
      }
    }
    return event;
  }

  @Override
  public void close() {
    close(false);
  }

  @Override
  public void close(final boolean isRestarting) {
    options.getLogger().log(SentryLevel.INFO, "Closing SentryClient.");
    try {
      flush(isRestarting ? 0 : options.getShutdownTimeoutMillis());
      loggerBatchProcessor.close(isRestarting);
      metricsBatchProcessor.close(isRestarting);
      transport.close(isRestarting);
    } catch (IOException e) {
      options
          .getLogger()
          .log(SentryLevel.WARNING, "Failed to close the connection to the Sentry Server.", e);
    }
    for (EventProcessor eventProcessor : options.getEventProcessors()) {
      if (eventProcessor instanceof Closeable) {
        try {
          ((Closeable) eventProcessor).close();
        } catch (IOException e) {
          options
              .getLogger()
              .log(
                  SentryLevel.WARNING,
                  "Failed to close the event processor {}.",
                  eventProcessor,
                  e);
        }
      }
    }
    enabled = false;
  }

  @Override
  public void flush(final long timeoutMillis) {
    loggerBatchProcessor.flush(timeoutMillis);
    metricsBatchProcessor.flush(timeoutMillis);
    transport.flush(timeoutMillis);
  }

  @Override
  public @Nullable RateLimiter getRateLimiter() {
    return transport.getRateLimiter();
  }

  @Override
  public boolean isHealthy() {
    return transport.isHealthy();
  }

  private boolean sample() {
    final @Nullable Random random = options.getSampleRate() == null ? null : SentryRandom.current();
    // https://docs.sentry.io/development/sdk-dev/features/#event-sampling
    if (options.getSampleRate() != null && random != null) {
      final double sampling = options.getSampleRate();
      return !(sampling < random.nextDouble()); // bad luck
    }
    return true;
  }
}