TraceSpanSummary

class oci.apm_traces.models.TraceSpanSummary(**kwargs)

Bases: object

Summary of the information pertaining to the spans in the trace window that is being queried.

Methods:

__init__(**kwargs)

Initializes a new TraceSpanSummary object with values from keyword arguments.

Attributes:

error_span_count

[Required] Gets the error_span_count of this TraceSpanSummary.

is_fault

[Required] Gets the is_fault of this TraceSpanSummary.

key

[Required] Gets the key of this TraceSpanSummary.

root_span_duration_in_ms

Gets the root_span_duration_in_ms of this TraceSpanSummary.

root_span_operation_name

Gets the root_span_operation_name of this TraceSpanSummary.

root_span_service_name

Gets the root_span_service_name of this TraceSpanSummary.

service_summaries

Gets the service_summaries of this TraceSpanSummary.

span_count

[Required] Gets the span_count of this TraceSpanSummary.

time_earliest_span_started

[Required] Gets the time_earliest_span_started of this TraceSpanSummary.

time_latest_span_ended

[Required] Gets the time_latest_span_ended of this TraceSpanSummary.

time_root_span_ended

Gets the time_root_span_ended of this TraceSpanSummary.

time_root_span_started

Gets the time_root_span_started of this TraceSpanSummary.

trace_duration_in_ms

[Required] Gets the trace_duration_in_ms of this TraceSpanSummary.

trace_error_code

[Required] Gets the trace_error_code of this TraceSpanSummary.

trace_error_type

[Required] Gets the trace_error_type of this TraceSpanSummary.

trace_status

[Required] Gets the trace_status of this TraceSpanSummary.

__init__(**kwargs)

Initializes a new TraceSpanSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • key (str) – The value to assign to the key property of this TraceSpanSummary.

  • root_span_operation_name (str) – The value to assign to the root_span_operation_name property of this TraceSpanSummary.

  • time_earliest_span_started (datetime) – The value to assign to the time_earliest_span_started property of this TraceSpanSummary.

  • time_latest_span_ended (datetime) – The value to assign to the time_latest_span_ended property of this TraceSpanSummary.

  • span_count (int) – The value to assign to the span_count property of this TraceSpanSummary.

  • error_span_count (int) – The value to assign to the error_span_count property of this TraceSpanSummary.

  • root_span_service_name (str) – The value to assign to the root_span_service_name property of this TraceSpanSummary.

  • time_root_span_started (datetime) – The value to assign to the time_root_span_started property of this TraceSpanSummary.

  • time_root_span_ended (datetime) – The value to assign to the time_root_span_ended property of this TraceSpanSummary.

  • root_span_duration_in_ms (int) – The value to assign to the root_span_duration_in_ms property of this TraceSpanSummary.

  • trace_duration_in_ms (int) – The value to assign to the trace_duration_in_ms property of this TraceSpanSummary.

  • is_fault (bool) – The value to assign to the is_fault property of this TraceSpanSummary.

  • trace_status (str) – The value to assign to the trace_status property of this TraceSpanSummary.

  • trace_error_type (str) – The value to assign to the trace_error_type property of this TraceSpanSummary.

  • trace_error_code (str) – The value to assign to the trace_error_code property of this TraceSpanSummary.

  • service_summaries (list[oci.apm_traces.models.TraceServiceSummary]) – The value to assign to the service_summaries property of this TraceSpanSummary.

property error_span_count

[Required] Gets the error_span_count of this TraceSpanSummary. 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.

Returns

The error_span_count of this TraceSpanSummary.

Return type

int

property is_fault

[Required] Gets the is_fault of this TraceSpanSummary. Boolean flag that indicates whether the trace has an error.

Returns

The is_fault of this TraceSpanSummary.

Return type

bool

property key

[Required] Gets the key of this TraceSpanSummary. 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.

Returns

The key of this TraceSpanSummary.

Return type

str

property root_span_duration_in_ms

Gets the root_span_duration_in_ms of this TraceSpanSummary. Time taken for the root span operation to complete in milliseconds.

Returns

The root_span_duration_in_ms of this TraceSpanSummary.

Return type

int

property root_span_operation_name

Gets the root_span_operation_name of this TraceSpanSummary. 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.

Returns

The root_span_operation_name of this TraceSpanSummary.

Return type

str

property root_span_service_name

Gets the root_span_service_name of this TraceSpanSummary. Service associated with the trace.

Returns

The root_span_service_name of this TraceSpanSummary.

Return type

str

property service_summaries

Gets the service_summaries of this TraceSpanSummary. A summary of the spans by service.

Returns

The service_summaries of this TraceSpanSummary.

Return type

list[oci.apm_traces.models.TraceServiceSummary]

property span_count

[Required] Gets the span_count of this TraceSpanSummary. 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.

Returns

The span_count of this TraceSpanSummary.

Return type

int

property time_earliest_span_started

[Required] Gets the time_earliest_span_started of this TraceSpanSummary. Start time of the earliest span in the span collection.

Returns

The time_earliest_span_started of this TraceSpanSummary.

Return type

datetime

property time_latest_span_ended

[Required] Gets the time_latest_span_ended of this TraceSpanSummary. End time of the span that most recently ended in the span collection.

Returns

The time_latest_span_ended of this TraceSpanSummary.

Return type

datetime

property time_root_span_ended

Gets the time_root_span_ended of this TraceSpanSummary. End time of the root span for the span collection.

Returns

The time_root_span_ended of this TraceSpanSummary.

Return type

datetime

property time_root_span_started

Gets the time_root_span_started of this TraceSpanSummary. Start time of the root span for the span collection.

Returns

The time_root_span_started of this TraceSpanSummary.

Return type

datetime

property trace_duration_in_ms

[Required] Gets the trace_duration_in_ms of this TraceSpanSummary. Time between the start of the earliest span and the end of the most recent span in milliseconds.

Returns

The trace_duration_in_ms of this TraceSpanSummary.

Return type

int

property trace_error_code

[Required] Gets the trace_error_code of this TraceSpanSummary. Error code of the trace.

Returns

The trace_error_code of this TraceSpanSummary.

Return type

str

property trace_error_type

[Required] Gets the trace_error_type of this TraceSpanSummary. Error type of the trace.

Returns

The trace_error_type of this TraceSpanSummary.

Return type

str

property trace_status

[Required] Gets the trace_status of this TraceSpanSummary. 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.

Returns

The trace_status of this TraceSpanSummary.

Return type

str