@Generated(value="OracleSDKGenerator",
comments="API Version: 20200630")
public final class TraceSpanSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary of the information pertaining to the spans in the trace window that is being queried.
Note: Objects should always be created or deserialized using the TraceSpanSummary.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the TraceSpanSummary.Builder, which maintain a
set of all explicitly set fields called TraceSpanSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
TraceSpanSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
TraceSpanSummary(String key,
String rootSpanOperationName,
Date timeEarliestSpanStarted,
Date timeLatestSpanEnded,
Integer spanCount,
Integer errorSpanCount,
String rootSpanServiceName,
Date timeRootSpanStarted,
Date timeRootSpanEnded,
Integer rootSpanDurationInMs,
Integer traceDurationInMs,
Boolean isFault,
String traceStatus,
String traceErrorType,
String traceErrorCode,
List<TraceServiceSummary> serviceSummaries)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static TraceSpanSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Integer |
getErrorSpanCount()
The number of spans with errors that have been processed by the system for the trace.
|
Boolean |
getIsFault()
Boolean flag that indicates whether the trace has an error.
|
String |
getKey()
Unique identifier (traceId) for the trace that represents the span set.
|
Integer |
getRootSpanDurationInMs()
Time taken for the root span operation to complete in milliseconds.
|
String |
getRootSpanOperationName()
Root span name associated with the trace.
|
String |
getRootSpanServiceName()
Service associated with the trace.
|
List<TraceServiceSummary> |
getServiceSummaries()
A summary of the spans by service.
|
Integer |
getSpanCount()
The number of spans that have been processed by the system for the trace.
|
Date |
getTimeEarliestSpanStarted()
Start time of the earliest span in the span collection.
|
Date |
getTimeLatestSpanEnded()
End time of the span that most recently ended in the span collection.
|
Date |
getTimeRootSpanEnded()
End time of the root span for the span collection.
|
Date |
getTimeRootSpanStarted()
Start time of the root span for the span collection.
|
Integer |
getTraceDurationInMs()
Time between the start of the earliest span and the end of the most recent span in
milliseconds.
|
String |
getTraceErrorCode()
Error code of the trace.
|
String |
getTraceErrorType()
Error type of the trace.
|
String |
getTraceStatus()
The status of the trace.
|
int |
hashCode() |
TraceSpanSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","rootSpanOperationName","timeEarliestSpanStarted","timeLatestSpanEnded","spanCount","errorSpanCount","rootSpanServiceName","timeRootSpanStarted","timeRootSpanEnded","rootSpanDurationInMs","traceDurationInMs","isFault","traceStatus","traceErrorType","traceErrorCode","serviceSummaries"}) public TraceSpanSummary(String key, String rootSpanOperationName, Date timeEarliestSpanStarted, Date timeLatestSpanEnded, Integer spanCount, Integer errorSpanCount, String rootSpanServiceName, Date timeRootSpanStarted, Date timeRootSpanEnded, Integer rootSpanDurationInMs, Integer traceDurationInMs, Boolean isFault, String traceStatus, String traceErrorType, String traceErrorCode, List<TraceServiceSummary> serviceSummaries)
public static TraceSpanSummary.Builder builder()
Create a new builder.
public TraceSpanSummary.Builder toBuilder()
public String getKey()
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.
public String getRootSpanOperationName()
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.
public Date getTimeEarliestSpanStarted()
Start time of the earliest span in the span collection.
public Date getTimeLatestSpanEnded()
End time of the span that most recently ended in the span collection.
public Integer getSpanCount()
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.
public Integer getErrorSpanCount()
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.
public String getRootSpanServiceName()
Service associated with the trace.
public Date getTimeRootSpanStarted()
Start time of the root span for the span collection.
public Date getTimeRootSpanEnded()
End time of the root span for the span collection.
public Integer getRootSpanDurationInMs()
Time taken for the root span operation to complete in milliseconds.
public Integer getTraceDurationInMs()
Time between the start of the earliest span and the end of the most recent span in milliseconds.
public Boolean getIsFault()
Boolean flag that indicates whether the trace has an error.
public String getTraceStatus()
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.
public String getTraceErrorType()
Error type of the trace.
public String getTraceErrorCode()
Error code of the trace.
public List<TraceServiceSummary> getServiceSummaries()
A summary of the spans by service.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.