Class TraceSpan (2.21.0)

public final class TraceSpan extends GeneratedMessageV3 implements TraceSpanOrBuilder

A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.

Protobuf type google.devtools.cloudtrace.v1.TraceSpan

Implements

TraceSpanOrBuilder

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_SPAN_ID_FIELD_NUMBER

public static final int PARENT_SPAN_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SPAN_ID_FIELD_NUMBER

public static final int SPAN_ID_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TraceSpan getDefaultInstance()
Returns
TypeDescription
TraceSpan

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TraceSpan.Builder newBuilder()
Returns
TypeDescription
TraceSpan.Builder

newBuilder(TraceSpan prototype)

public static TraceSpan.Builder newBuilder(TraceSpan prototype)
Parameter
NameDescription
prototypeTraceSpan
Returns
TypeDescription
TraceSpan.Builder

parseDelimitedFrom(InputStream input)

public static TraceSpan parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TraceSpan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TraceSpan parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TraceSpan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TraceSpan parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TraceSpan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TraceSpan parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TraceSpan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TraceSpan parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TraceSpan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TraceSpan parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TraceSpan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TraceSpan
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TraceSpan> parser()
Returns
TypeDescription
Parser<TraceSpan>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

  • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
  • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

  • /agent

  • /component
  • /error/message
  • /error/name
  • /http/client_city
  • /http/client_country
  • /http/client_protocol
  • /http/client_region
  • /http/host
  • /http/method
  • /http/path
  • /http/redirected_url
  • /http/request/size
  • /http/response/size
  • /http/route
  • /http/status_code
  • /http/url
  • /http/user_agent
  • /pid
  • /stacktrace
  • /tid

map<string, string> labels = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TraceSpan getDefaultInstanceForType()
Returns
TypeDescription
TraceSpan

getEndTime()

public Timestamp getEndTime()

End time of the span in nanoseconds from the UNIX epoch.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

End time of the span in nanoseconds from the UNIX epoch.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getKind()

public TraceSpan.SpanKind getKind()

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using RPC_CLIENT and RPC_SERVER to identify queueing latency associated with the span.

.google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;

Returns
TypeDescription
TraceSpan.SpanKind

The kind.

getKindValue()

public int getKindValue()

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using RPC_CLIENT and RPC_SERVER to identify queueing latency associated with the span.

.google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for kind.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

  • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
  • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

  • /agent

  • /component
  • /error/message
  • /error/name
  • /http/client_city
  • /http/client_country
  • /http/client_protocol
  • /http/client_region
  • /http/host
  • /http/method
  • /http/path
  • /http/redirected_url
  • /http/request/size
  • /http/response/size
  • /http/route
  • /http/status_code
  • /http/url
  • /http/user_agent
  • /pid
  • /stacktrace
  • /tid

map<string, string> labels = 7;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

  • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
  • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

  • /agent

  • /component
  • /error/message
  • /error/name
  • /http/client_city
  • /http/client_country
  • /http/client_protocol
  • /http/client_region
  • /http/host
  • /http/method
  • /http/path
  • /http/redirected_url
  • /http/request/size
  • /http/response/size
  • /http/route
  • /http/status_code
  • /http/url
  • /http/user_agent
  • /pid
  • /stacktrace
  • /tid

map<string, string> labels = 7;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

  • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
  • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

  • /agent

  • /component
  • /error/message
  • /error/name
  • /http/client_city
  • /http/client_country
  • /http/client_protocol
  • /http/client_region
  • /http/host
  • /http/method
  • /http/path
  • /http/redirected_url
  • /http/request/size
  • /http/response/size
  • /http/route
  • /http/status_code
  • /http/url
  • /http/user_agent
  • /pid
  • /stacktrace
  • /tid

map<string, string> labels = 7;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

  • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
  • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

  • /agent

  • /component
  • /error/message
  • /error/name
  • /http/client_city
  • /http/client_country
  • /http/client_protocol
  • /http/client_region
  • /http/host
  • /http/method
  • /http/path
  • /http/redirected_url
  • /http/request/size
  • /http/response/size
  • /http/route
  • /http/status_code
  • /http/url
  • /http/user_agent
  • /pid
  • /stacktrace
  • /tid

map<string, string> labels = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.

string name = 3;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.

string name = 3;

Returns
TypeDescription
ByteString

The bytes for name.

getParentSpanId()

public long getParentSpanId()

Optional. ID of the parent span, if any.

fixed64 parent_span_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
long

The parentSpanId.

getParserForType()

public Parser<TraceSpan> getParserForType()
Returns
TypeDescription
Parser<TraceSpan>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpanId()

public long getSpanId()

Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284.

fixed64 span_id = 1;

Returns
TypeDescription
long

The spanId.

getStartTime()

public Timestamp getStartTime()

Start time of the span in nanoseconds from the UNIX epoch.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of the span in nanoseconds from the UNIX epoch.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

End time of the span in nanoseconds from the UNIX epoch.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Start time of the span in nanoseconds from the UNIX epoch.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TraceSpan.Builder newBuilderForType()
Returns
TypeDescription
TraceSpan.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TraceSpan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TraceSpan.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TraceSpan.Builder toBuilder()
Returns
TypeDescription
TraceSpan.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException