Class Scope

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

Hierarchy

Scope

Implements

Scope

Properties

`Protected` _attachments

_attachments: Attachment[]

Attachments

`Protected` _breadcrumbs

_breadcrumbs: Breadcrumb[]

Array of breadcrumbs.

`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) => void)[]

Callback for client to receive scope changes.

Type declaration

- (scope): void
- Parameters
  - scope: Scope
  Returns void

`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

Type declaration

[key: string]: unknown

`Protected` `Optional` _session

_session?: Session

Session

`Protected` `Optional` _span

_span?: Span

Span

`Protected` _tags

_tags: {
[key: string]: Primitive;
}

Type declaration

[key: string]: Primitive

`Protected` `Optional` _transactionName

_transactionName?: string

Transaction Name

`Protected` _user

_user: User

User

Methods

`Protected` _notifyEventProcessors

_notifyEventProcessors(processors, event, hint, index?): PromiseLike<null | Event>
This will be called after applyToEvent is finished.
Parameters
- processors: EventProcessor[]
- event: null | Event
- hint: EventHint
- index: number = 0
Returns PromiseLike<null | Event>
- Defined in core/src/scope.ts:553

`Protected` _notifyScopeListeners

_notifyScopeListeners(): void
This will be called on every set call.

Returns void
- Defined in core/src/scope.ts:587

addAttachment

addAttachment(attachment): Scope
Adds an attachment to the scope
Parameters
- attachment: Attachment
  
  Attachment options
Returns Scope
Implementation of Scope.addAttachment
- Defined in core/src/scope.ts:447

addBreadcrumb

addBreadcrumb(breadcrumb, maxBreadcrumbs?): Scope
Sets the breadcrumbs in the scope
Parameters
- breadcrumb: Breadcrumb
- Optional maxBreadcrumbs: number
  
  number of max breadcrumbs to merged into event.
Returns Scope
Implementation of Scope.addBreadcrumb
- Defined in core/src/scope.ts:410

addEventProcessor

addEventProcessor(callback): Scope
Add new event processor that will be called after applyToEvent.
Parameters
- callback: EventProcessor
Returns Scope
Implementation of Scope.addEventProcessor
- Defined in core/src/scope.ts:156

clear

clear(): Scope
Clears the current scope and resets its properties.

Returns Scope
Implementation of Scope.clear
- Defined in core/src/scope.ts:389

clearAttachments

clearAttachments(): Scope
Clears attachments from the scope

Returns Scope
Implementation of Scope.clearAttachments
- Defined in core/src/scope.ts:462

clearBreadcrumbs

clearBreadcrumbs(): Scope
Clears all currently set Breadcrumbs.

Returns Scope
Implementation of Scope.clearBreadcrumbs
- Defined in core/src/scope.ts:438

getAttachments

getAttachments(): Attachment[]
Returns an array of attachments on the scope

Returns Attachment[]
Implementation of Scope.getAttachments
- Defined in core/src/scope.ts:455

getLastBreadcrumb

getLastBreadcrumb(): undefined | Breadcrumb
Get the last breadcrumb.

Returns undefined | Breadcrumb
Implementation of Scope.getLastBreadcrumb
- Defined in core/src/scope.ts:431

getPropagationContext

getPropagationContext(): PropagationContext
Get propagation context from the scope, used for distributed tracing

Returns PropagationContext
Implementation of Scope.getPropagationContext
- Defined in core/src/scope.ts:546

getRequestSession

getRequestSession(): undefined | RequestSession
Returns the RequestSession if there is one

Returns undefined | RequestSession
Implementation of Scope.getRequestSession
- Defined in core/src/scope.ts:183

getSession

getSession(): undefined | Session
Returns the Session if there is one

Returns undefined | Session
Implementation of Scope.getSession
- Defined in core/src/scope.ts:324

getSpan

getSpan(): undefined | Span
Returns the Span if there is one

Returns undefined | Span
Implementation of Scope.getSpan
- Defined in core/src/scope.ts:294

getTransaction

getTransaction(): undefined | Transaction
Returns the Transaction attached to the scope (if there is one)

Returns undefined | Transaction
Implementation of Scope.getTransaction
- Defined in core/src/scope.ts:301

getUser

getUser(): undefined | User
Returns the User if there is one

Returns undefined | User
Implementation of Scope.getUser
- Defined in core/src/scope.ts:176

setContext

setContext(key, context): Scope
Sets context data with the given name.
Parameters
- key: string
  
  of the context
- context: null | Context
  
  an object containing context data. This data will be normalized. Pass null to unset the context.
Returns Scope
Implementation of Scope.setContext
- Defined in core/src/scope.ts:270

setExtra

setExtra(key, extra): Scope
Set key:value that will be sent as extra data with the event.
Parameters
- key: string
  
  String of extra
- extra: unknown
  
  Any kind of data. This data will be normalized.
Returns Scope
Implementation of Scope.setExtra
- Defined in core/src/scope.ts:231

setExtras

setExtras(extras): Scope
Set an object that will be merged sent as extra data with the event.
Parameters
- extras: Extras
  
  Extras object to merge into current context.
Returns Scope
Implementation of Scope.setExtras
- Defined in core/src/scope.ts:219

setFingerprint

setFingerprint(fingerprint): Scope
Sets the fingerprint on the scope to send with the events.
Parameters
- fingerprint: string[]
  
  string[] to group events in Sentry.
Returns Scope
Implementation of Scope.setFingerprint
- Defined in core/src/scope.ts:240

setLevel

setLevel(level): Scope
Sets the level on the scope for future events.
Parameters
- level: Severity | SeverityLevel
  
  string SeverityLevel
Returns Scope
Implementation of Scope.setLevel
- Defined in core/src/scope.ts:249

setPropagationContext

setPropagationContext(context): Scope
Add propagation context to the scope, used for distributed tracing
Parameters
- context: PropagationContext
Returns Scope
Implementation of Scope.setPropagationContext
- Defined in core/src/scope.ts:538

setRequestSession

setRequestSession(requestSession?): Scope
Sets the RequestSession on the scope
Parameters
- Optional requestSession: RequestSession
Returns Scope
Implementation of Scope.setRequestSession
- Defined in core/src/scope.ts:190

setSDKProcessingMetadata

setSDKProcessingMetadata(newData): Scope
Add data which will be accessible during event processing but won't get sent to Sentry
Parameters
- newData: {
  [key: string]: unknown;
  }
  - [key: string]: unknown
Returns Scope
Implementation of Scope.setSDKProcessingMetadata
- Defined in core/src/scope.ts:529

setSession

setSession(session?): Scope
Sets the Session on the scope
Parameters
- Optional session: Session
Returns Scope
Implementation of Scope.setSession
- Defined in core/src/scope.ts:311

setSpan

setSpan(span?): Scope
Sets the Span on the scope.
Parameters
- Optional span: Span
  
  Span
Returns Scope
Implementation of Scope.setSpan
- Defined in core/src/scope.ts:285

setTag

setTag(key, value): Scope
Set key:value that will be sent as tags data with the event.

Can also be used to unset a tag by passing undefined.
Parameters
- key: string
  
  String key of tag
- value: Primitive
  
  Value of tag
Returns Scope
Implementation of Scope.setTag
- Defined in core/src/scope.ts:210

setTags

setTags(tags): Scope
Set an object that will be merged sent as tags data with the event.
Parameters
- tags: {
  [key: string]: Primitive;
  }
  
  Tags context object to merge into current context.
  - [key: string]: Primitive
Returns Scope
Implementation of Scope.setTags
- Defined in core/src/scope.ts:198

setTransactionName

setTransactionName(name?): Scope
Sets the transaction name on the scope for future events.
Parameters
- Optional name: string
Returns Scope
Implementation of Scope.setTransactionName
- Defined in core/src/scope.ts:261

setUser

setUser(user): Scope
Updates user context information for future events.
Parameters
- user: null | User
  
  User context object to be set in the current context. Pass null to unset the user.
Returns Scope
Implementation of Scope.setUser
- Defined in core/src/scope.ts:164

update

update(captureContext?): Scope
Updates the scope with provided data. Can work in three variations:
- plain object containing updatable attributes
- Scope instance that'll extract the attributes from
- callback function that'll receive the current scope as an argument and allow for modifications
Parameters
- Optional captureContext: CaptureContext
  
  scope modifier to be used
Returns Scope
Implementation of Scope.update
- Defined in core/src/scope.ts:331

`Static` clone

clone(scope?): Scope
Inherit values from the parent scope.
Parameters
- Optional scope: Scope
  
  to clone.
Returns Scope
- Defined in core/src/scope.ts:123

Class Scope

Hierarchy

Implements

Index

Properties

Methods

Properties

Protected _attachments

Protected _breadcrumbs

Protected _contexts

Protected _eventProcessors

Protected _extra

Protected Optional _fingerprint

Protected Optional _level

Protected _notifyingListeners

Protected _propagationContext

Protected Optional _requestSession

Protected _scopeListeners

Type declaration

Parameters

scope: Scope

Returns void

Protected _sdkProcessingMetadata

Type declaration

[key: string]: unknown

Protected Optional _session

Protected Optional _span

Protected _tags

Type declaration

[key: string]: Primitive

Protected Optional _transactionName

Protected _user

Methods

Protected _notifyEventProcessors

Parameters

processors: EventProcessor[]

event: null | Event

hint: EventHint

index: number = 0

Returns PromiseLike<null | Event>

Protected _notifyScopeListeners

Returns void

addAttachment

Parameters

attachment: Attachment

Returns Scope

addBreadcrumb

Parameters

breadcrumb: Breadcrumb

Optional maxBreadcrumbs: number

Returns Scope

addEventProcessor

Parameters

callback: EventProcessor

Returns Scope

clear

Returns Scope

clearAttachments

Returns Scope

clearBreadcrumbs

Returns Scope

getAttachments

Returns Attachment[]

getLastBreadcrumb

Returns undefined | Breadcrumb

getPropagationContext

Returns PropagationContext

getRequestSession

Returns undefined | RequestSession

getSession

Returns undefined | Session

getSpan

Returns undefined | Span

getTransaction

Returns undefined | Transaction

getUser

Returns undefined | User

setContext

Parameters

key: string

`Protected` _attachments

`Protected` _breadcrumbs

`Protected` _contexts

`Protected` _eventProcessors

`Protected` _extra

`Protected` `Optional` _fingerprint

`Protected` `Optional` _level

`Protected` _notifyingListeners

`Protected` _propagationContext

`Protected` `Optional` _requestSession

`Protected` _scopeListeners

`Protected` _sdkProcessingMetadata

`Protected` `Optional` _session

`Protected` `Optional` _span

`Protected` _tags

`Protected` `Optional` _transactionName

`Protected` _user

`Protected` _notifyEventProcessors

`Protected` _notifyScopeListeners

`Optional` maxBreadcrumbs: number

`Optional` requestSession: RequestSession

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

`Optional` session: Session

`Optional` span: Span

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

`Optional` name: string

`Optional` captureContext: CaptureContext

`Static` clone

`Optional` scope: Scope