Class SentryStackFrame

A frame of a stacktrace

Inheritance

Object

SentryStackFrame

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 SentryStackFrame

Properties

AbsolutePath

The absolute path to filename

Declaration

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

Property Value

Type	Description
String

ColumnNumber

The column number of the call

Declaration

[DataMember(Name = "colno", EmitDefaultValue = false)]
public int? ColumnNumber { get; set; }

Property Value

Type	Description
Nullable<Int32>

ContextLine

Source code in filename at line number

Declaration

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

Property Value

Type	Description
String

FileName

The relative file path to the call

Declaration

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

Property Value

Type	Description
String

FramesOmitted

Which frames were omitted, if any.

Declaration

public IList<int> FramesOmitted { get; }

Property Value

Type	Description
IList<Int32>

Remarks

If the list of frames is large, you can explicitly tell the system that you’ve omitted a range of frames. The frames_omitted must be a single tuple two values: start and end.

Examples

If you only removed the 8th frame, the value would be (8, 9), meaning it started at the 8th frame, and went until the 9th (the number of frames omitted is end-start). The values should be based on a one-index.

Function

The name of the function being called

Declaration

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

Property Value

Type	Description
String

ImageAddress

Optionally an address of the debug image to reference. If this is set and a known image is defined by debug_meta then symbolication can take place.

Declaration

[DataMember(Name = "image_addr", EmitDefaultValue = false)]
public long ImageAddress { get; set; }

Property Value

Type	Description
Int64

InApp

Signifies whether this frame is related to the execution of the relevant code in this stacktrace.

Declaration

[DataMember(Name = "in_app", EmitDefaultValue = false)]
public bool? InApp { get; set; }

Property Value

Type	Description
Nullable<Boolean>

Examples

For example, the frames that might power the framework’s web server of your app are probably not relevant, however calls to the framework’s library once you start handling code likely are.

InstructionOffset

The instruction offset

Declaration

[DataMember(Name = "instruction_offset", EmitDefaultValue = false)]
public long? InstructionOffset { get; set; }

Property Value

Type	Description
Nullable<Int64>

Remarks

The official docs refer to it as 'The difference between instruction address and symbol address in bytes.' In .NET this means the IL Offset within the assembly

LineNumber

The line number of the call

Declaration

[DataMember(Name = "lineno", EmitDefaultValue = false)]
public int? LineNumber { get; set; }

Property Value

Type	Description
Nullable<Int32>

Module

Platform-specific module path

Declaration

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

Property Value

Type	Description
String

Package

The assembly where the code resides

Declaration

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

Property Value

Type	Description
String

Platform

This can override the platform for a single frame. Otherwise the platform of the event is assumed.

Declaration

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

Property Value

Type	Description
String

PostContext

A list of source code lines after context_line (in order) – usually [lineno + 1:lineno + 5]

Declaration

public IList<string> PostContext { get; }

Property Value

Type	Description
IList<String>

PreContext

A list of source code lines before context_line (in order) – usually [lineno - 5:lineno]

Declaration

public IList<string> PreContext { get; }

Property Value

Type	Description
IList<String>

SymbolAddress

An optional address that points to a symbol. We actually use the instruction address for symbolication but this can be used to calculate an instruction offset automatically.

Declaration

[DataMember(Name = "symbol_addr", EmitDefaultValue = false)]
public long? SymbolAddress { get; set; }

Property Value

Type	Description
Nullable<Int64>

Vars

A mapping of variables which were available within this frame (usually context-locals).

Declaration

public IDictionary<string, string> Vars { get; }

Property Value

Type	Description
IDictionary<String, String>