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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int KIND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_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 SPAN_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static TraceSpan getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static TraceSpan.Builder newBuilder()
public static TraceSpan.Builder newBuilder(TraceSpan prototype)
public static TraceSpan parseDelimitedFrom(InputStream input)
public static TraceSpan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TraceSpan parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static TraceSpan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TraceSpan parseFrom(ByteString data)
public static TraceSpan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TraceSpan parseFrom(CodedInputStream input)
public static TraceSpan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TraceSpan parseFrom(InputStream input)
public static TraceSpan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TraceSpan parseFrom(ByteBuffer data)
public static TraceSpan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<TraceSpan> parser()
Methods
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 |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public TraceSpan getDefaultInstanceForType()
public Timestamp getEndTime()
End time of the span in nanoseconds from the UNIX epoch.
.google.protobuf.Timestamp end_time = 5;
public TimestampOrBuilder getEndTimeOrBuilder()
End time of the span in nanoseconds from the UNIX epoch.
.google.protobuf.Timestamp end_time = 5;
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;
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 |
|---|
| Type | Description |
int | The enum numeric value on the wire for kind.
|
public Map<String,String> getLabels()
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 |
|---|
| Type | Description |
int | |
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;
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;
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 |
|---|
| Name | Description |
key | String
|
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 |
|---|
| Type | Description |
String | The name.
|
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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public long getParentSpanId()
Optional. ID of the parent span, if any.
fixed64 parent_span_id = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
long | The parentSpanId.
|
public Parser<TraceSpan> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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 |
|---|
| Type | Description |
long | The spanId.
|
public Timestamp getStartTime()
Start time of the span in nanoseconds from the UNIX epoch.
.google.protobuf.Timestamp start_time = 4;
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
Start time of the span in nanoseconds from the UNIX epoch.
.google.protobuf.Timestamp start_time = 4;
public final UnknownFieldSet getUnknownFields()
Overrides
public boolean hasEndTime()
End time of the span in nanoseconds from the UNIX epoch.
.google.protobuf.Timestamp end_time = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasStartTime()
Start time of the span in nanoseconds from the UNIX epoch.
.google.protobuf.Timestamp start_time = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public TraceSpan.Builder newBuilderForType()
protected TraceSpan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public TraceSpan.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
