java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.opentelemetry.proto.trace.v1.Span

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SpanOrBuilder, Serializable

public final class Span
extends com.google.protobuf.GeneratedMessageV3
implements SpanOrBuilder

 Span represents a single operation within a trace. Spans can be
 nested to form a trace tree. Spans may also be linked to other spans
 from the same or different trace and form graphs. 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 may be gaps or overlaps between spans in a trace.
 The next available field id is 17.

Protobuf type opentelemetry.proto.trace.v1.Span

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Span.Builder`	Span represents a single operation within a trace.
`static class`	`Span.Event`	Event is a time-stamped annotation of the span, consisting of user-supplied text description and key-value pairs.
`static interface`	`Span.EventOrBuilder`
`static class`	`Span.Link`	A pointer from the current span to another span in the same trace or in a different trace.
`static interface`	`Span.LinkOrBuilder`
`static class`	`Span.SpanKind`	SpanKind is the type of span.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ATTRIBUTES_FIELD_NUMBER`
`static int`	`DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER`
`static int`	`DROPPED_EVENTS_COUNT_FIELD_NUMBER`
`static int`	`DROPPED_LINKS_COUNT_FIELD_NUMBER`
`static int`	`END_TIME_UNIX_NANO_FIELD_NUMBER`
`static int`	`EVENTS_FIELD_NUMBER`
`static int`	`KIND_FIELD_NUMBER`
`static int`	`LINKS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`PARENT_SPAN_ID_FIELD_NUMBER`
`static int`	`SPAN_ID_FIELD_NUMBER`
`static int`	`START_TIME_UNIX_NANO_FIELD_NUMBER`
`static int`	`STATUS_FIELD_NUMBER`
`static int`	`TRACE_ID_FIELD_NUMBER`
`static int`	`TRACE_STATE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`KeyValue`	`getAttributes(int index)`	attributes is a collection of key/value pairs.
`int`	`getAttributesCount()`	attributes is a collection of key/value pairs.
`List<KeyValue>`	`getAttributesList()`	attributes is a collection of key/value pairs.
`KeyValueOrBuilder`	`getAttributesOrBuilder(int index)`	attributes is a collection of key/value pairs.
`List<? extends KeyValueOrBuilder>`	`getAttributesOrBuilderList()`	attributes is a collection of key/value pairs.
`static Span`	`getDefaultInstance()`
`Span`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`int`	`getDroppedAttributesCount()`	dropped_attributes_count is the number of attributes that were discarded.
`int`	`getDroppedEventsCount()`	dropped_events_count is the number of dropped events.
`int`	`getDroppedLinksCount()`	dropped_links_count is the number of dropped links after the maximum size was enforced.
`long`	`getEndTimeUnixNano()`	end_time_unix_nano is the end time of the span.
`Span.Event`	`getEvents(int index)`	events is a collection of Event items.
`int`	`getEventsCount()`	events is a collection of Event items.
`List<Span.Event>`	`getEventsList()`	events is a collection of Event items.
`Span.EventOrBuilder`	`getEventsOrBuilder(int index)`	events is a collection of Event items.
`List<? extends Span.EventOrBuilder>`	`getEventsOrBuilderList()`	events is a collection of Event items.
`Span.SpanKind`	`getKind()`	Distinguishes between spans generated in a particular context.
`int`	`getKindValue()`	Distinguishes between spans generated in a particular context.
`Span.Link`	`getLinks(int index)`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`int`	`getLinksCount()`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`List<Span.Link>`	`getLinksList()`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`Span.LinkOrBuilder`	`getLinksOrBuilder(int index)`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`List<? extends Span.LinkOrBuilder>`	`getLinksOrBuilderList()`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`String`	`getName()`	A description of the span's operation.
`com.google.protobuf.ByteString`	`getNameBytes()`	A description of the span's operation.
`com.google.protobuf.ByteString`	`getParentSpanId()`	The `span_id` of this span's parent span.
`com.google.protobuf.Parser<Span>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.ByteString`	`getSpanId()`	A unique identifier for a span within a trace, assigned when the span is created.
`long`	`getStartTimeUnixNano()`	start_time_unix_nano is the start time of the span.
`Status`	`getStatus()`	An optional final status for this span.
`StatusOrBuilder`	`getStatusOrBuilder()`	An optional final status for this span.
`com.google.protobuf.ByteString`	`getTraceId()`	A unique identifier for a trace.
`String`	`getTraceState()`	trace_state conveys information about request position in multiple distributed tracing graphs.
`com.google.protobuf.ByteString`	`getTraceStateBytes()`	trace_state conveys information about request position in multiple distributed tracing graphs.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasStatus()`	An optional final status for this span.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Span.Builder`	`newBuilder()`
`static Span.Builder`	`newBuilder(Span prototype)`
`Span.Builder`	`newBuilderForType()`
`protected Span.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Span`	`parseDelimitedFrom(InputStream input)`
`static Span`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Span`	`parseFrom(byte[] data)`
`static Span`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Span`	`parseFrom(com.google.protobuf.ByteString data)`
`static Span`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Span`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Span`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Span`	`parseFrom(InputStream input)`
`static Span`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Span`	`parseFrom(ByteBuffer data)`
`static Span`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Span>`	`parser()`
`Span.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail
- TRACE_ID_FIELD_NUMBER
```
public static final int TRACE_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SPAN_ID_FIELD_NUMBER
```
public static final int SPAN_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRACE_STATE_FIELD_NUMBER
```
public static final int TRACE_STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARENT_SPAN_ID_FIELD_NUMBER
```
public static final int PARENT_SPAN_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KIND_FIELD_NUMBER
```
public static final int KIND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- START_TIME_UNIX_NANO_FIELD_NUMBER
```
public static final int START_TIME_UNIX_NANO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- END_TIME_UNIX_NANO_FIELD_NUMBER
```
public static final int END_TIME_UNIX_NANO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ATTRIBUTES_FIELD_NUMBER
```
public static final int ATTRIBUTES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER
```
public static final int DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EVENTS_FIELD_NUMBER
```
public static final int EVENTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DROPPED_EVENTS_COUNT_FIELD_NUMBER
```
public static final int DROPPED_EVENTS_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LINKS_FIELD_NUMBER
```
public static final int LINKS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DROPPED_LINKS_COUNT_FIELD_NUMBER
```
public static final int DROPPED_LINKS_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATUS_FIELD_NUMBER
```
public static final int STATUS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTraceId

public com.google.protobuf.ByteString getTraceId()

 A unique identifier for a trace. All spans from the same trace share
 the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes
 is considered invalid.
 This field is semantically required. Receiver should generate new
 random trace_id if empty or invalid trace_id was received.
 This field is required.

bytes trace_id = 1;

Specified by:: getTraceId in interface SpanOrBuilder
Returns:: The traceId.

getSpanId

public com.google.protobuf.ByteString getSpanId()

 A unique identifier for a span within a trace, assigned when the span
 is created. The ID is an 8-byte array. An ID with all zeroes is considered
 invalid.
 This field is semantically required. Receiver should generate new
 random span_id if empty or invalid span_id was received.
 This field is required.

bytes span_id = 2;

Specified by:: getSpanId in interface SpanOrBuilder
Returns:: The spanId.

getTraceState

public String getTraceState()

 trace_state conveys information about request position in multiple distributed tracing graphs.
 It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header
 See also https://github.com/w3c/distributed-tracing for more details about this field.

string trace_state = 3;

Specified by:: getTraceState in interface SpanOrBuilder
Returns:: The traceState.

getTraceStateBytes

public com.google.protobuf.ByteString getTraceStateBytes()

 trace_state conveys information about request position in multiple distributed tracing graphs.
 It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header
 See also https://github.com/w3c/distributed-tracing for more details about this field.

string trace_state = 3;

Specified by:: getTraceStateBytes in interface SpanOrBuilder
Returns:: The bytes for traceState.

getParentSpanId

public com.google.protobuf.ByteString getParentSpanId()

 The `span_id` of this span's parent span. If this is a root span, then this
 field must be empty. The ID is an 8-byte array.

bytes parent_span_id = 4;

Specified by:: getParentSpanId in interface SpanOrBuilder
Returns:: The parentSpanId.

getName

public String getName()

 A description of the span's operation.
 For example, the 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 at the same call point in an application.
 This makes it easier to correlate spans in different traces.
 This field is semantically required to be set to non-empty string.
 Empty value is equivalent to an unknown span name.
 This field is required.

string name = 5;

Specified by:: getName in interface SpanOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 A description of the span's operation.
 For example, the 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 at the same call point in an application.
 This makes it easier to correlate spans in different traces.
 This field is semantically required to be set to non-empty string.
 Empty value is equivalent to an unknown span name.
 This field is required.

string name = 5;

Specified by:: getNameBytes in interface SpanOrBuilder
Returns:: The bytes for name.

getKindValue

public int getKindValue()

 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 queueing latency associated with the span.

.opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

Specified by:: getKindValue in interface SpanOrBuilder
Returns:: The enum numeric value on the wire for kind.

getKind

public Span.SpanKind getKind()

 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 queueing latency associated with the span.

.opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

Specified by:: getKind in interface SpanOrBuilder
Returns:: The kind.

getStartTimeUnixNano

public long getStartTimeUnixNano()

 start_time_unix_nano is 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.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
 This field is semantically required and it is expected that end_time >= start_time.

fixed64 start_time_unix_nano = 7;

Specified by:: getStartTimeUnixNano in interface SpanOrBuilder
Returns:: The startTimeUnixNano.

getEndTimeUnixNano

public long getEndTimeUnixNano()

 end_time_unix_nano is 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.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
 This field is semantically required and it is expected that end_time >= start_time.

fixed64 end_time_unix_nano = 8;

Specified by:: getEndTimeUnixNano in interface SpanOrBuilder
Returns:: The endTimeUnixNano.