Class BaseScope

The Scoped part of the protocol

Inheritance

Object

BaseScope

SentryEvent

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Sentry.Protocol

Assembly: Sentry.Protocol.dll

Syntax

[DataContract]
public class BaseScope

Remarks

Members are included in the event but often modified as part of a scope manipulation which could affect multiple outgoing events.

Constructors

BaseScope(IScopeOptions)

Creates a scope with the specified options

Declaration

public BaseScope(IScopeOptions options)

Parameters

Type	Name	Description
IScopeOptions	options

Properties

Breadcrumbs

A trail of events which happened prior to an issue.

Declaration

public IEnumerable<Breadcrumb> Breadcrumbs { get; }

Property Value

Type	Description
IEnumerable<Breadcrumb>

See Also

https://docs.sentry.io/learn/breadcrumbs/

Contexts

Gets the structured Sentry context

Declaration

public Contexts Contexts { get; set; }

Property Value

Type	Description
Contexts	The contexts.

Environment

The environment name, such as 'production' or 'staging'.

Declaration

[DataMember(Name = "environment", EmitDefaultValue = false)]
public string Environment { get; set; }

Property Value

Type	Description
String

Remarks

Requires Sentry 8.0 or higher

Extra

An arbitrary mapping of additional metadata to store with the event.

Declaration

public IReadOnlyDictionary<string, object> Extra { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, Object>

Fingerprint

A list of strings used to dictate the deduplication of this event.

Declaration

public IEnumerable<string> Fingerprint { get; }

Property Value

Type	Description
IEnumerable<String>

Remarks

A value of {{ default }} will be replaced with the built-in behavior, thus allowing you to extend it, or completely replace it. New in version Protocol: version '7'

Examples

{ "fingerprint": ["myrpc", "POST", "/foo.bar"] }

{ "fingerprint": ["{{ default }}", "http://example.com/my.url"] }

See Also

https://docs.sentry.io/learn/rollups/#custom-grouping

Level

Sentry level

Declaration

[DataMember(Name = "level", EmitDefaultValue = false)]
public SentryLevel? Level { get; set; }

Property Value

Type	Description
Nullable<SentryLevel>

Request

Gets or sets the HTTP.

Declaration

public Request Request { get; set; }

Property Value

Type	Description
Request	The HTTP.

ScopeOptions

An optional scope option

Declaration

public IScopeOptions ScopeOptions { get; }

Property Value

Type	Description
IScopeOptions	The options or null, if no options were defined.

Remarks

Options are not mandatory. it allows defining callback for deciding on adding breadcrumbs and the max breadcrumbs allowed

Sdk

SDK information

Declaration

[DataMember(Name = "sdk", EmitDefaultValue = false)]
public SdkVersion Sdk { get; }

Property Value

Type	Description
SdkVersion

Remarks

New in Sentry version: 8.4

Tags

Arbitrary key-value for this event

Declaration

public IReadOnlyDictionary<string, string> Tags { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, String>

Transaction

The name of the transaction in which there was an event.

Declaration

[DataMember(Name = "transaction", EmitDefaultValue = false)]
public string Transaction { get; set; }

Property Value

Type	Description
String

Remarks

A transaction should only be defined when it can be well defined On a Web framework, for example, a transaction is the route template rather than the actual request path. That is so GET /user/10 and /user/20 (which have route template /user/{id}) are identified as the same transaction.

User

Gets the user information

Declaration

public User User { get; set; }

Property Value

Type	Description
User	The user.