Trace¶

class oci.apm_traces.models.Trace(**kwargs)¶

Bases: object

Definition of a trace object.

Attributes

`SOURCE_NAME_SYN_TRACES`	A constant which can be used with the source_name property of a Trace.
`SOURCE_NAME_TRACES`	A constant which can be used with the source_name property of a Trace.
`error_span_count`	Gets the error_span_count of this Trace.
`is_fault`	Gets the is_fault of this Trace.
`key`	[Required] Gets the key of this Trace.
`root_span_duration_in_ms`	Gets the root_span_duration_in_ms of this Trace.
`root_span_operation_name`	Gets the root_span_operation_name of this Trace.
`root_span_service_name`	Gets the root_span_service_name of this Trace.
`service_summaries`	Gets the service_summaries of this Trace.
`source_name`	Gets the source_name of this Trace.
`span_count`	Gets the span_count of this Trace.
`span_summary`	Gets the span_summary of this Trace.
`spans`	[Required] Gets the spans of this Trace.
`time_earliest_span_started`	Gets the time_earliest_span_started of this Trace.
`time_latest_span_ended`	Gets the time_latest_span_ended of this Trace.
`time_root_span_ended`	Gets the time_root_span_ended of this Trace.
`time_root_span_started`	Gets the time_root_span_started of this Trace.
`trace_duration_in_ms`	Gets the trace_duration_in_ms of this Trace.
`trace_error_code`	Gets the trace_error_code of this Trace.
`trace_error_type`	Gets the trace_error_type of this Trace.
`trace_status`	Gets the trace_status of this Trace.

Methods

__init__(**kwargs) Initializes a new Trace object with values from keyword arguments.

SOURCE_NAME_SYN_TRACES = 'SYN_TRACES'¶: A constant which can be used with the source_name property of a Trace. This constant has a value of “SYN_TRACES”

SOURCE_NAME_TRACES = 'TRACES'¶: A constant which can be used with the source_name property of a Trace. This constant has a value of “TRACES”

__init__(**kwargs)¶

Initializes a new Trace 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 Trace.
root_span_operation_name (str) – The value to assign to the root_span_operation_name property of this Trace.
time_earliest_span_started (datetime) – The value to assign to the time_earliest_span_started property of this Trace.
time_latest_span_ended (datetime) – The value to assign to the time_latest_span_ended property of this Trace.
span_count (int) – The value to assign to the span_count property of this Trace.
error_span_count (int) – The value to assign to the error_span_count property of this Trace.
root_span_service_name (str) – The value to assign to the root_span_service_name property of this Trace.
time_root_span_started (datetime) – The value to assign to the time_root_span_started property of this Trace.
time_root_span_ended (datetime) – The value to assign to the time_root_span_ended property of this Trace.
root_span_duration_in_ms (int) – The value to assign to the root_span_duration_in_ms property of this Trace.
trace_duration_in_ms (int) – The value to assign to the trace_duration_in_ms property of this Trace.
is_fault (bool) – The value to assign to the is_fault property of this Trace.
trace_status (str) – The value to assign to the trace_status property of this Trace.
trace_error_type (str) – The value to assign to the trace_error_type property of this Trace.
trace_error_code (str) – The value to assign to the trace_error_code property of this Trace.
service_summaries (list[oci.apm_traces.models.TraceServiceSummary]) – The value to assign to the service_summaries property of this Trace.
source_name (str) – The value to assign to the source_name property of this Trace. Allowed values for this property are: “TRACES”, “SYN_TRACES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
span_summary (oci.apm_traces.models.TraceSpanSummary) – The value to assign to the span_summary property of this Trace.
spans (list[oci.apm_traces.models.Span]) – The value to assign to the spans property of this Trace.

error_span_count¶

Gets the error_span_count of this Trace. 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 Trace.
Return type:	int

is_fault¶

Gets the is_fault of this Trace. Boolean flag that indicates whether the trace has an error.

Returns:	The is_fault of this Trace.
Return type:	bool

key¶

[Required] Gets the key of this Trace. 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 Trace.
Return type:	str

root_span_duration_in_ms¶

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

Returns:	The root_span_duration_in_ms of this Trace.
Return type:	int

root_span_operation_name¶

Gets the root_span_operation_name of this Trace. 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 Trace.
Return type:	str

root_span_service_name¶

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

Returns:	The root_span_service_name of this Trace.
Return type:	str

service_summaries¶

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

Returns:	The service_summaries of this Trace.
Return type:	list[oci.apm_traces.models.TraceServiceSummary]

source_name¶

Gets the source_name of this Trace. Source of trace (traces, syn_traces).

Allowed values for this property are: “TRACES”, “SYN_TRACES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The source_name of this Trace.
Return type:	str

span_count¶

Gets the span_count of this Trace. 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 Trace.
Return type:	int

span_summary¶

Gets the span_summary of this Trace.

Returns:	The span_summary of this Trace.
Return type:	oci.apm_traces.models.TraceSpanSummary

spans¶

[Required] Gets the spans of this Trace. An array of spans in the trace.

Returns:	The spans of this Trace.
Return type:	list[oci.apm_traces.models.Span]

time_earliest_span_started¶

Gets the time_earliest_span_started of this Trace. Start time of the earliest span in the span collection.

Returns:	The time_earliest_span_started of this Trace.
Return type:	datetime

time_latest_span_ended¶

Gets the time_latest_span_ended of this Trace. End time of the span that most recently ended in the span collection.

Returns:	The time_latest_span_ended of this Trace.
Return type:	datetime

time_root_span_ended¶

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

Returns:	The time_root_span_ended of this Trace.
Return type:	datetime

time_root_span_started¶

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

Returns:	The time_root_span_started of this Trace.
Return type:	datetime

trace_duration_in_ms¶

Gets the trace_duration_in_ms of this Trace. 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 Trace.
Return type:	int

trace_error_code¶

Gets the trace_error_code of this Trace. Error code of the trace.

Returns:	The trace_error_code of this Trace.
Return type:	str

trace_error_type¶

Gets the trace_error_type of this Trace. Error type of the trace.

Returns:	The trace_error_type of this Trace.
Return type:	str

trace_status¶

Gets the trace_status of this Trace. 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 Trace.
Return type:	str