Package io.sentry

Class SentryClient

java.lang.Object
io.sentry.SentryClient
All Implemented Interfaces:
ISentryClient, IMetricsClient
public final class SentryClient extends Object implements ISentryClient, IMetricsClient

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Description copied from interface: ISentryClient
      Whether the client is enabled or not
      Specified by:
      isEnabled in interface ISentryClient
      Returns:
      true if its enabled or false otherwise.

    • captureEvent

      @NotNull public @NotNull SentryId captureEvent(@NotNull @NotNull SentryEvent event, @Nullable @Nullable IScope scope, @Nullable @Nullable Hint hint)
      Description copied from interface: ISentryClient
      Capture the event
      Specified by:
      captureEvent in interface ISentryClient
      Parameters:
      event - the event
      scope - An optional scope to be applied to the event.
      hint - SDK specific but provides high level information about the origin of the event.
      Returns:
      The Id (SentryId object) of the event.

    • captureUserFeedback

      public void captureUserFeedback(@NotNull @NotNull UserFeedback userFeedback)
      Description copied from interface: ISentryClient
      Captures a manually created user feedback and sends it to Sentry.
      Specified by:
      captureUserFeedback in interface ISentryClient
      Parameters:
      userFeedback - The user feedback to send to Sentry.

    • captureSession

      @Internal public void captureSession(@NotNull @NotNull Session session, @Nullable @Nullable Hint hint)
      Description copied from interface: ISentryClient
      Captures a session. This method transform a session to an envelope and forwards to captureEnvelope
      Specified by:
      captureSession in interface ISentryClient
      Parameters:
      session - the Session
      hint - SDK specific but provides high level information about the origin of the event

    • captureEnvelope

      @Internal @NotNull public @NotNull SentryId captureEnvelope(@NotNull @NotNull SentryEnvelope envelope, @Nullable @Nullable Hint hint)
      Description copied from interface: ISentryClient
      Captures an envelope.
      Specified by:
      captureEnvelope in interface ISentryClient
      Parameters:
      envelope - the SentryEnvelope to send.
      hint - SDK specific but provides high level information about the origin of the event
      Returns:
      The Id (SentryId object) of the event

    • captureTransaction

      @NotNull public @NotNull SentryId captureTransaction(@NotNull @NotNull SentryTransaction transaction, @Nullable @Nullable TraceContext traceContext, @Nullable @Nullable IScope scope, @Nullable @Nullable Hint hint, @Nullable @Nullable ProfilingTraceData profilingTraceData)
      Description copied from interface: ISentryClient
      Captures a transaction.
      Specified by:
      captureTransaction in interface ISentryClient
      Parameters:
      transaction - the ITransaction to send
      traceContext - the trace context
      scope - An optional scope to be applied to the event.
      hint - SDK specific but provides high level information about the origin of the event
      profilingTraceData - An optional profiling trace data captured during the transaction
      Returns:
      The Id (SentryId object) of the event

    • captureCheckIn

      @Experimental @NotNull public @NotNull SentryId captureCheckIn(@NotNull @NotNull CheckIn checkIn, @Nullable @Nullable IScope scope, @Nullable @Nullable Hint hint)
      Specified by:
      captureCheckIn in interface ISentryClient

    • close

      public void close()
      Description copied from interface: ISentryClient
      Flushes out the queue for up to timeout seconds and disable the client.
      Specified by:
      close in interface ISentryClient

    • close

      public void close(boolean isRestarting)
      Description copied from interface: ISentryClient
      Flushes out the queue for up to timeout seconds and disable the client.
      Specified by:
      close in interface ISentryClient
      Parameters:
      isRestarting - if true, avoids locking the main thread when finishing the queue.

    • flush

      public void flush(long timeoutMillis)
      Description copied from interface: ISentryClient
      Flushes events queued up, but keeps the client enabled. Not implemented yet.
      Specified by:
      flush in interface ISentryClient
      Parameters:
      timeoutMillis - time in milliseconds

    • getRateLimiter

      @Nullable public @Nullable RateLimiter getRateLimiter()
      Specified by:
      getRateLimiter in interface ISentryClient

    • isHealthy

      public boolean isHealthy()
      Specified by:
      isHealthy in interface ISentryClient

    • getMetricsAggregator

      @NotNull public @NotNull IMetricsAggregator getMetricsAggregator()
      Specified by:
      getMetricsAggregator in interface ISentryClient

    • captureMetrics

      @NotNull public @NotNull SentryId captureMetrics(@NotNull @NotNull EncodedMetrics metrics)
      Description copied from interface: IMetricsClient
      Captures one or more metrics to be sent to Sentry.
      Specified by:
      captureMetrics in interface IMetricsClient