Class Scope

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

Implements

Implemented by

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

constructor

  • new Scope(): Scope

  • Returns Scope

Properties

Protected_attachments

_attachments: Attachment[]

Attachments

Protected_breadcrumbs

_breadcrumbs: Breadcrumb[]

Array of breadcrumbs.

Protected Optional_client

_client?: Client

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

addAttachment

  • addAttachment(attachment: Attachment): this

  • Parameters

    • attachment: Attachment

    Returns this

    Inherit Doc

addBreadcrumb

  • addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this

  • Parameters

    • breadcrumb: Breadcrumb
    • OptionalmaxBreadcrumbs: number

    Returns this

    Inherit Doc

addEventProcessor

  • addEventProcessor(callback: EventProcessor): this

  • Parameters

    • callback: EventProcessor

    Returns this

    Inherit Doc

captureEvent

  • captureEvent(event: Event, hint?: EventHint): string

  • 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.

captureException

  • captureException(exception: unknown, hint?: EventHint): string

  • 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.

captureMessage

  • captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string

  • 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.

clear

  • clear(): this

  • Returns this

    Inherit Doc

clearAttachments

  • clearAttachments(): this

  • Returns this

    Inherit Doc

clearBreadcrumbs

  • clearBreadcrumbs(): this

  • Returns this

    Inherit Doc

clone

  • clone(): Scope

  • Clone this scope instance.

    Returns Scope

getAttachments

  • getAttachments(): Attachment[]

  • Returns Attachment[]

    Inherit Doc

    Deprecated

    Use getScopeData() instead.

getClient

  • getClient(): undefined | Client

  • 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 undefined | Client

getLastBreadcrumb

  • getLastBreadcrumb(): undefined | Breadcrumb

  • Returns undefined | Breadcrumb

    Inherit Doc

getPropagationContext

  • getPropagationContext(): PropagationContext

  • Returns PropagationContext

    Inherit Doc

getRequestSession

  • getRequestSession(): undefined | RequestSession

  • Returns undefined | RequestSession

    Inherit Doc

getScopeData

  • getScopeData(): ScopeData

  • Returns ScopeData

    Inherit Doc

getSession

  • getSession(): undefined | Session

  • Returns undefined | Session

    Inherit Doc

getSpan

  • getSpan(): undefined | Span

  • Returns the Span if there is one.

    Returns undefined | Span

    Deprecated

    Use getActiveSpan() instead.

getTransaction

  • getTransaction(): undefined | Transaction

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

    Returns undefined | Transaction

    Deprecated

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

getUser

  • getUser(): undefined | User

  • Returns undefined | User

    Inherit Doc

setClient

  • setClient(client: undefined | Client): void

  • Update the client on the scope.

    Parameters

    • client: undefined | Client

    Returns void

setContext

  • setContext(key: string, context: null | Context): this

  • Parameters

    • key: string
    • context: null | Context

    Returns this

    Inherit Doc

setExtra

  • setExtra(key: string, extra: unknown): this

  • Parameters

    • key: string
    • extra: unknown

    Returns this

    Inherit Doc

setExtras

  • setExtras(extras: Extras): this

  • Parameters

    • extras: Extras

    Returns this

    Inherit Doc

setFingerprint

  • setFingerprint(fingerprint: string[]): this

  • Parameters

    • fingerprint: string[]

    Returns this

    Inherit Doc

setLevel

  • setLevel(level: Severity | SeverityLevel): this

  • Parameters

    Returns this

    Inherit Doc

setPropagationContext

  • setPropagationContext(context: PropagationContext): this

  • Parameters

    • context: PropagationContext

    Returns this

    Inherit Doc

setRequestSession

  • setRequestSession(requestSession?: RequestSession): this

  • Parameters

    • OptionalrequestSession: RequestSession

    Returns this

    Inherit Doc

setSDKProcessingMetadata

  • setSDKProcessingMetadata(newData: { [key: string]: unknown }): this

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

    Parameters

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

    Returns this

setSession

  • setSession(session?: Session): this

  • Parameters

    Returns this

    Inherit Doc

setSpan

  • setSpan(span?: Span): this

  • Sets the Span on the scope.

    Parameters

    • Optionalspan: Span

      Span

    Returns this

    Deprecated

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

setTag

  • setTag(key: string, value: Primitive): this

  • Parameters

    • key: string
    • value: Primitive

    Returns this

    Inherit Doc

setTags

  • setTags(tags: { [key: string]: Primitive }): this

  • Parameters

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

    Returns this

    Inherit Doc

setTransactionName

  • setTransactionName(name?: string): this

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

    Parameters

    • Optionalname: string

    Returns this

setUser

  • setUser(user: null | User): this

  • Parameters

    Returns this

    Inherit Doc

update

  • update(captureContext?: CaptureContext): this

  • Parameters

    • OptionalcaptureContext: CaptureContext

    Returns this

    Inherit Doc

Staticclone

  • clone(scope?: Scope): Scope

  • Inherit values from the parent scope.

    Parameters

    Returns Scope

    Deprecated

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods