Class Trace

Definition of a trace object.

Inheritance

object

Trace

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 Trace

Properties

ErrorSpanCount

Declaration

[JsonProperty(PropertyName = "errorSpanCount")]
public int? ErrorSpanCount { get; set; }

Property Value

Type	Description
int?	The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

IsFault

Declaration

[JsonProperty(PropertyName = "isFault")]
public bool? IsFault { get; set; }

Property Value

Type	Description
bool?	Boolean flag that indicates whether the trace has an error.

Key

Declaration

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

Property Value

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

Remarks

Required

RootSpanDurationInMs

Declaration

[JsonProperty(PropertyName = "rootSpanDurationInMs")]
public int? RootSpanDurationInMs { get; set; }

Property Value

Type	Description
int?	Time taken for the root span operation to complete in milliseconds.

RootSpanOperationName

Declaration

[JsonProperty(PropertyName = "rootSpanOperationName")]
public string RootSpanOperationName { get; set; }

Property Value

Type	Description
string	Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.

RootSpanServiceName

Declaration

[JsonProperty(PropertyName = "rootSpanServiceName")]
public string RootSpanServiceName { get; set; }

Property Value

Type	Description
string	Service associated with the trace.

ServiceSummaries

Declaration

[JsonProperty(PropertyName = "serviceSummaries")]
public List<TraceServiceSummary> ServiceSummaries { get; set; }

Property Value

Type	Description
List<TraceServiceSummary>	A summary of the spans by service.

SourceName

Declaration

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

Property Value

Type	Description
Trace.SourceNameEnum?	Source of trace (traces, syn_traces).

SpanCount

Declaration

[JsonProperty(PropertyName = "spanCount")]
public int? SpanCount { get; set; }

Property Value

Type	Description
int?	The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

SpanSummary

Declaration

[JsonProperty(PropertyName = "spanSummary")]
public TraceSpanSummary SpanSummary { get; set; }

Property Value

Type	Description
TraceSpanSummary

Spans

Declaration

[Required(ErrorMessage = "Spans is required.")]
[JsonProperty(PropertyName = "spans")]
public List<Span> Spans { get; set; }

Property Value

Type	Description
List<Span>	An array of spans in the trace.

Remarks

Required

TimeEarliestSpanStarted

Declaration

[JsonProperty(PropertyName = "timeEarliestSpanStarted")]
public DateTime? TimeEarliestSpanStarted { get; set; }

Property Value

Type	Description
DateTime?	Start time of the earliest span in the span collection.

TimeLatestSpanEnded

Declaration

[JsonProperty(PropertyName = "timeLatestSpanEnded")]
public DateTime? TimeLatestSpanEnded { get; set; }

Property Value

Type	Description
DateTime?	End time of the span that most recently ended in the span collection.

TimeRootSpanEnded

Declaration

[JsonProperty(PropertyName = "timeRootSpanEnded")]
public DateTime? TimeRootSpanEnded { get; set; }

Property Value

Type	Description
DateTime?	End time of the root span for the span collection.

TimeRootSpanStarted

Declaration

[JsonProperty(PropertyName = "timeRootSpanStarted")]
public DateTime? TimeRootSpanStarted { get; set; }

Property Value

Type	Description
DateTime?	Start time of the root span for the span collection.

TraceDurationInMs

Declaration

[JsonProperty(PropertyName = "traceDurationInMs")]
public int? TraceDurationInMs { get; set; }

Property Value

Type	Description
int?	Time between the start of the earliest span and the end of the most recent span in milliseconds.

TraceErrorCode

Declaration

[JsonProperty(PropertyName = "traceErrorCode")]
public string TraceErrorCode { get; set; }

Property Value

Type	Description
string	Error code of the trace.

TraceErrorType

Declaration

[JsonProperty(PropertyName = "traceErrorType")]
public string TraceErrorType { get; set; }

Property Value

Type	Description
string	Error type of the trace.

TraceStatus

Declaration

[JsonProperty(PropertyName = "traceStatus")]
public string TraceStatus { get; set; }

Property Value

Type	Description
string	The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

Type

Description

string

The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.