public final class Span extends GeneratedMessageV3 implements SpanOrBuilder
A span represents a single operation within a trace. Spans can be
nested to form a trace tree. Often, a trace contains a root span
that describes the end-to-end latency, and one or more subspans for
its sub-operations.
A trace can also contain multiple root spans, or none at all.
Spans do not need to be contiguous. There might be
gaps or overlaps between spans in a trace.
Protobuf type google.devtools.cloudtrace.v2.Span
Static Fields
public static final int ATTRIBUTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CHILD_SPAN_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LINKS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARENT_SPAN_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SAME_PROCESS_AS_PARENT_SPAN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SPAN_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SPAN_KIND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STACK_TRACE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATUS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TIME_EVENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Span getDefaultInstance()
| Returns |
|---|
| Type | Description |
Span | |
public static final Descriptors.Descriptor getDescriptor()
public static Span.Builder newBuilder()
public static Span.Builder newBuilder(Span prototype)
| Parameter |
|---|
| Name | Description |
prototype | Span
|
public static Span parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Span | |
public static Span parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Span | |
public static Parser<Span> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Span.Attributes getAttributes()
A set of attributes on the span. You can have up to 32 attributes per
span.
.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;
public Span.AttributesOrBuilder getAttributesOrBuilder()
A set of attributes on the span. You can have up to 32 attributes per
span.
.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;
public Int32Value getChildSpanCount()
Optional. The number of child spans that were generated while this span
was active. If set, allows implementation to detect missing child spans.
.google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Int32Value | The childSpanCount.
|
public Int32ValueOrBuilder getChildSpanCountOrBuilder()
Optional. The number of child spans that were generated while this span
was active. If set, allows implementation to detect missing child spans.
.google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
public Span getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Span | |
public TruncatableString getDisplayName()
Required. A description of the span's operation (up to 128 bytes).
Cloud Trace displays the description in the
Cloud console.
For example, the display name can be a qualified method name or a file name
and a line number where the operation is called. A best practice is to use
the same display name within an application and at the same call point.
This makes it easier to correlate spans in different traces.
.google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
public TruncatableStringOrBuilder getDisplayNameOrBuilder()
Required. A description of the span's operation (up to 128 bytes).
Cloud Trace displays the description in the
Cloud console.
For example, the display name can be a qualified method name or a file name
and a line number where the operation is called. A best practice is to use
the same display name within an application and at the same call point.
This makes it easier to correlate spans in different traces.
.google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
public Timestamp getEndTime()
Required. The end time of the span. On the client side, this is the time
kept by the local machine where the span execution ends. On the server
side, this is the time when the server application handler stops running.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];
public TimestampOrBuilder getEndTimeOrBuilder()
Required. The end time of the span. On the client side, this is the time
kept by the local machine where the span execution ends. On the server
side, this is the time when the server application handler stops running.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];
public Span.Links getLinks()
Links associated with the span. You can have up to 128 links per Span.
.google.devtools.cloudtrace.v2.Span.Links links = 10;
public Span.LinksOrBuilder getLinksOrBuilder()
Links associated with the span. You can have up to 128 links per Span.
.google.devtools.cloudtrace.v2.Span.Links links = 10;
Required. The resource name of the span in the following format:
projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
[TRACE_ID] is a unique identifier for a trace within a project;
it is a 32-character hexadecimal encoding of a 16-byte array. It should
not be zero.
[SPAN_ID] is a unique identifier for a span within a trace; it
is a 16-character hexadecimal encoding of an 8-byte array. It should not
be zero.
.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The name.
|
public ByteString getNameBytes()
Required. The resource name of the span in the following format:
projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
[TRACE_ID] is a unique identifier for a trace within a project;
it is a 32-character hexadecimal encoding of a 16-byte array. It should
not be zero.
[SPAN_ID] is a unique identifier for a span within a trace; it
is a 16-character hexadecimal encoding of an 8-byte array. It should not
be zero.
.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public String getParentSpanId()
The [SPAN_ID] of this span's parent span. If this is a root span,
then this field must be empty.
string parent_span_id = 3;
| Returns |
|---|
| Type | Description |
String | The parentSpanId.
|
public ByteString getParentSpanIdBytes()
The [SPAN_ID] of this span's parent span. If this is a root span,
then this field must be empty.
string parent_span_id = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parentSpanId.
|
public Parser<Span> getParserForType()
Overrides
public BoolValue getSameProcessAsParentSpan()
Optional. Set this parameter to indicate whether this span is in
the same process as its parent. If you do not set this parameter,
Trace is unable to take advantage of this helpful information.
.google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
BoolValue | The sameProcessAsParentSpan.
|
public BoolValueOrBuilder getSameProcessAsParentSpanOrBuilder()
Optional. Set this parameter to indicate whether this span is in
the same process as its parent. If you do not set this parameter,
Trace is unable to take advantage of this helpful information.
.google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public String getSpanId()
Required. The [SPAN_ID] portion of the span's resource name.
string span_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The spanId.
|
public ByteString getSpanIdBytes()
Required. The [SPAN_ID] portion of the span's resource name.
string span_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for spanId.
|
public Span.SpanKind getSpanKind()
Optional. Distinguishes between spans generated in a particular context.
For example, two spans with the same name may be distinguished using
CLIENT (caller) and SERVER (callee) to identify an RPC call.
.google.devtools.cloudtrace.v2.Span.SpanKind span_kind = 14 [(.google.api.field_behavior) = OPTIONAL];
public int getSpanKindValue()
Optional. Distinguishes between spans generated in a particular context.
For example, two spans with the same name may be distinguished using
CLIENT (caller) and SERVER (callee) to identify an RPC call.
.google.devtools.cloudtrace.v2.Span.SpanKind span_kind = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for spanKind.
|
public StackTrace getStackTrace()
Stack trace captured at the start of the span.
.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;
public StackTraceOrBuilder getStackTraceOrBuilder()
Stack trace captured at the start of the span.
.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;
public Timestamp getStartTime()
Required. The start time of the span. On the client side, this is the time
kept by the local machine where the span execution starts. On the server
side, this is the time when the server's application handler starts
running.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
Required. The start time of the span. On the client side, this is the time
kept by the local machine where the span execution starts. On the server
side, this is the time when the server's application handler starts
running.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
public Status getStatus()
Optional. The final status for this span.
.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
com.google.rpc.Status | The status.
|
public StatusOrBuilder getStatusOrBuilder()
Optional. The final status for this span.
.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
public Span.TimeEvents getTimeEvents()
A set of time events. You can have up to 32 annotations and 128 message
events per span.
.google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;
public Span.TimeEventsOrBuilder getTimeEventsOrBuilder()
A set of time events. You can have up to 32 annotations and 128 message
events per span.
.google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;
public final UnknownFieldSet getUnknownFields()
Overrides
public boolean hasAttributes()
A set of attributes on the span. You can have up to 32 attributes per
span.
.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;
| Returns |
|---|
| Type | Description |
boolean | Whether the attributes field is set.
|
public boolean hasChildSpanCount()
Optional. The number of child spans that were generated while this span
was active. If set, allows implementation to detect missing child spans.
.google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the childSpanCount field is set.
|
public boolean hasDisplayName()
Required. A description of the span's operation (up to 128 bytes).
Cloud Trace displays the description in the
Cloud console.
For example, the display name can be a qualified method name or a file name
and a line number where the operation is called. A best practice is to use
the same display name within an application and at the same call point.
This makes it easier to correlate spans in different traces.
.google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the displayName field is set.
|
public boolean hasEndTime()
Required. The end time of the span. On the client side, this is the time
kept by the local machine where the span execution ends. On the server
side, this is the time when the server application handler stops running.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasLinks()
Links associated with the span. You can have up to 128 links per Span.
.google.devtools.cloudtrace.v2.Span.Links links = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the links field is set.
|
public boolean hasSameProcessAsParentSpan()
Optional. Set this parameter to indicate whether this span is in
the same process as its parent. If you do not set this parameter,
Trace is unable to take advantage of this helpful information.
.google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the sameProcessAsParentSpan field is set.
|
public boolean hasStackTrace()
Stack trace captured at the start of the span.
.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;
| Returns |
|---|
| Type | Description |
boolean | Whether the stackTrace field is set.
|
public boolean hasStartTime()
Required. The start time of the span. On the client side, this is the time
kept by the local machine where the span execution starts. On the server
side, this is the time when the server's application handler starts
running.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
public boolean hasStatus()
Optional. The final status for this span.
.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the status field is set.
|
public boolean hasTimeEvents()
A set of time events. You can have up to 32 annotations and 128 message
events per span.
.google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;
| Returns |
|---|
| Type | Description |
boolean | Whether the timeEvents field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Span.Builder newBuilderForType()
protected Span.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Span.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
