Class Span

Definition of a span object.

Inheritance

object

Span

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApmtracesService.Models

Assembly: OCI.DotNetSDK.Apmtraces.dll

Syntax

public class Span

Properties

DurationInMs

Declaration

[Required(ErrorMessage = "DurationInMs is required.")]
[JsonProperty(PropertyName = "durationInMs")]
public long? DurationInMs { get; set; }

Property Value

Type	Description
long?	Total span duration in milliseconds.

Remarks

Required

IsError

Declaration

[Required(ErrorMessage = "IsError is required.")]
[JsonProperty(PropertyName = "isError")]
public bool? IsError { get; set; }

Property Value

Type	Description
bool?	Indicates if the span has an error.

Remarks

Required

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.

Remarks

Required

Kind

Declaration

[JsonProperty(PropertyName = "kind")]
public string Kind { get; set; }

Property Value

Type	Description
string	Kind associated with the span.

Logs

Declaration

[JsonProperty(PropertyName = "logs")]
public List<SpanLogCollection> Logs { get; set; }

Property Value

Type	Description
List<SpanLogCollection>	List of logs associated with the span.

OperationName

Declaration

[Required(ErrorMessage = "OperationName is required.")]
[JsonProperty(PropertyName = "operationName")]
public string OperationName { get; set; }

Property Value

Type	Description
string	Span name associated with the trace. This is usually the method or URI of the request.

Remarks

Required

ParentSpanKey

Declaration

[JsonProperty(PropertyName = "parentSpanKey")]
public string ParentSpanKey { get; set; }

Property Value

Type	Description
string	Unique parent identifier for the span if one exists. For root spans this will be null.

ServiceName

Declaration

[JsonProperty(PropertyName = "serviceName")]
public string ServiceName { get; set; }

Property Value

Type	Description
string	Service name associated with the span.

SourceName

Declaration

[JsonProperty(PropertyName = "sourceName")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Span.SourceNameEnum? SourceName { get; set; }

Property Value

Type	Description
Span.SourceNameEnum?	Source of span (spans, syn_spans).

Type	Description
List<Tag>	List of tags associated with the span.

TagsMetadata

Declaration

[JsonProperty(PropertyName = "tagsMetadata")]
public Dictionary<string, TagMetadata> TagsMetadata { get; set; }

Property Value

Type	Description
Dictionary<string, TagMetadata>	Metadata about the tags in the span.

TimeEnded

Declaration

[Required(ErrorMessage = "TimeEnded is required.")]
[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }

Property Value

Type	Description
DateTime?	Span end time. Timestamp when the span was completed.

Remarks

Required

TimeStarted

Declaration

[Required(ErrorMessage = "TimeStarted is required.")]
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }

Property Value

Type	Description
DateTime?	Span start time. Timestamp when the span was started.

Remarks

Required

TraceKey

Declaration

[Required(ErrorMessage = "TraceKey is required.")]
[JsonProperty(PropertyName = "traceKey")]
public string TraceKey { get; set; }

Property Value

Type	Description
string	Unique identifier for the trace.

Remarks

Required