Takaro - v0.4.11
    Preparing search index...

    Class Scope

    Holds additional event information. Scope.applyToEvent will be called by the client before an event will be sent.

    Implements

    • Scope
    Index

    Constructors

    constructor

    Properties

    _attachments _breadcrumbs _client? _contexts _eventProcessors _extra _fingerprint? _level? _notifyingListeners _propagationContext _requestSession? _scopeListeners _sdkProcessingMetadata _session? _span? _tags _transactionName? _user

    Methods

    _notifyScopeListeners addAttachment addBreadcrumb addEventProcessor captureEvent captureException captureMessage clear clearAttachments clearBreadcrumbs clone getAttachments getClient getLastBreadcrumb getPropagationContext getRequestSession getScopeData getSession getSpan getTransaction getUser setClient setContext setExtra setExtras setFingerprint setLevel setPropagationContext setRequestSession setSDKProcessingMetadata setSession setSpan setTag setTags setTransactionName setUser update clone

    Constructors

    • Returns Scope

    Properties

    Protected_attachments

    _attachments: Attachment[]

    Attachments

    Protected_breadcrumbs

    _breadcrumbs: Breadcrumb[]

    Array of breadcrumbs.

    Protected Optional_client

    _client?: Client<ClientOptions<BaseTransportOptions>>

    The client on this scope

    Protected_contexts

    _contexts: Contexts

    Contexts

    Protected_eventProcessors

    _eventProcessors: EventProcessor[]

    Callback list that will be called after applyToEvent.

    Protected_extra

    _extra: Extras

    Extra

    Protected Optional_fingerprint

    _fingerprint?: string[]

    Fingerprint

    Protected Optional_level

    _level?: Severity | SeverityLevel

    Severity

    Protected_notifyingListeners

    _notifyingListeners: boolean

    Flag if notifying is happening.

    Protected_propagationContext

    _propagationContext: PropagationContext

    Propagation Context for distributed tracing

    Protected Optional_requestSession

    _requestSession?: RequestSession

    Request Mode Session Status

    Protected_scopeListeners

    _scopeListeners: ((scope: Scope) => void)[]

    Callback for client to receive scope changes.

    Protected_sdkProcessingMetadata

    _sdkProcessingMetadata: { [key: string]: unknown }

    A place to stash data which is needed at some point in the SDK's event processing pipeline but which shouldn't get sent to Sentry

    Protected Optional_session

    _session?: Session

    Session

    Protected Optional_span

    _span?: Span

    Span

    Protected_tags

    _tags: { [key: string]: Primitive }

    Tags

    Protected Optional_transactionName

    _transactionName?: string

    Transaction Name

    Protected_user

    _user: User

    User

    Methods

    Protected_notifyScopeListeners

    • _notifyScopeListeners(): void

      This will be called on every set call.

      Returns void

    • Parameters

      • attachment: Attachment

      Returns this

    • Parameters

      • breadcrumb: Breadcrumb
      • OptionalmaxBreadcrumbs: number

      Returns this

    • Parameters

      • callback: EventProcessor

      Returns this

    • Captures a manually created event for this scope and sends it to Sentry.

      Parameters

      • event: Event
      • Optionalhint: EventHint

        Optional additional data to attach to the Sentry event.

      Returns string

      the id of the captured event.

    • Capture an exception for this scope.

      Parameters

      • exception: unknown

        The exception to capture.

      • Optionalhint: EventHint

        Optinal additional data to attach to the Sentry event.

      Returns string

      the id of the captured Sentry event.

    • Capture a message for this scope.

      Parameters

      • message: string

        The message to capture.

      • Optionallevel: SeverityLevel

        An optional severity level to report the message with.

      • Optionalhint: EventHint

        Optional additional data to attach to the Sentry event.

      Returns string

      the id of the captured message.

    • Returns this

    • Returns this

    • Returns this

    • Clone this scope instance.

      Returns Scope

    • Returns Attachment[]

      Use getScopeData() instead.

    • Get the client assigned to this scope.

      It is generally recommended to use the global function Sentry.getClient() instead, unless you know what you are doing.

      Returns Client<ClientOptions<BaseTransportOptions>> | undefined

    • Returns Breadcrumb | undefined

    • Returns PropagationContext

    • Returns RequestSession | undefined

    • Returns ScopeData

    • Returns Session | undefined

    • Returns the Span if there is one.

      Returns Span | undefined

      Use getActiveSpan() instead.

    • Returns the Transaction attached to the scope (if there is one).

      Returns Transaction | undefined

      You should not rely on the transaction, but just use startSpan() APIs instead.

    • Returns User | undefined

    • Update the client on the scope.

      Parameters

      • client: Client<ClientOptions<BaseTransportOptions>> | undefined

      Returns void

    • Parameters

      • key: string
      • context: Context | null

      Returns this

    • Parameters

      • key: string
      • extra: unknown

      Returns this

    • Parameters

      • extras: Extras

      Returns this

    • Parameters

      • fingerprint: string[]

      Returns this

    • Parameters

      • context: PropagationContext

      Returns this

    • Parameters

      • OptionalrequestSession: RequestSession

      Returns this

    • Add data which will be accessible during event processing but won't get sent to Sentry

      Parameters

      • newData: { [key: string]: unknown }

      Returns this

    • Parameters

      Returns this

    • Sets the Span on the scope.

      Parameters

      • Optionalspan: Span

        Span

      Returns this

      Instead of setting a span on a scope, use startSpan()/startSpanManual() instead.

    • Parameters

      • key: string
      • value: Primitive

      Returns this

    • Parameters

      • tags: { [key: string]: Primitive }

      Returns this

    • Sets the transaction name on the scope for future events.

      Parameters

      • Optionalname: string

      Returns this

    • Parameters

      Returns this

    • Parameters

      • OptionalcaptureContext: CaptureContext

      Returns this

    • Inherit values from the parent scope.

      Parameters

      Returns Scope

      Use scope.clone() and new Scope() instead.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods