io.opencensus.proto.trace.v1

Interface SpanOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Span, Span.Builder

public interface SpanOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Span.Attributes	getAttributes() A set of attributes on the span.
Span.AttributesOrBuilder	getAttributesOrBuilder() A set of attributes on the span.
com.google.protobuf.UInt32Value	getChildSpanCount() An optional number of child spans that were generated while this span was active.
com.google.protobuf.UInt32ValueOrBuilder	getChildSpanCountOrBuilder() An optional number of child spans that were generated while this span was active.
com.google.protobuf.Timestamp	getEndTime() The end time of the span.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() The end time of the span.
Span.SpanKind	getKind() Distinguishes between spans generated in a particular context.
int	getKindValue() Distinguishes between spans generated in a particular context.
Span.Links	getLinks() The included links.
Span.LinksOrBuilder	getLinksOrBuilder() The included links.
TruncatableString	getName() A description of the span's operation.
TruncatableStringOrBuilder	getNameOrBuilder() A description of the span's operation.
com.google.protobuf.ByteString	getParentSpanId() The `span_id` of this span's parent span.
Resource	getResource() An optional resource that is associated with this span.
ResourceOrBuilder	getResourceOrBuilder() An optional resource that is associated with this span.
com.google.protobuf.BoolValue	getSameProcessAsParentSpan() A highly recommended but not required flag that identifies when a trace crosses a process boundary.
com.google.protobuf.BoolValueOrBuilder	getSameProcessAsParentSpanOrBuilder() A highly recommended but not required flag that identifies when a trace crosses a process boundary.
com.google.protobuf.ByteString	getSpanId() A unique identifier for a span within a trace, assigned when the span is created.
StackTrace	getStackTrace() A stack trace captured at the start of the span.
StackTraceOrBuilder	getStackTraceOrBuilder() A stack trace captured at the start of the span.
com.google.protobuf.Timestamp	getStartTime() The start time of the span.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() The start time of the span.
Status	getStatus() An optional final status for this span.
StatusOrBuilder	getStatusOrBuilder() An optional final status for this span.
Span.TimeEvents	getTimeEvents() The included time events.
Span.TimeEventsOrBuilder	getTimeEventsOrBuilder() The included time events.
com.google.protobuf.ByteString	getTraceId() A unique identifier for a trace.
Span.Tracestate	getTracestate() The Tracestate on the span.
Span.TracestateOrBuilder	getTracestateOrBuilder() The Tracestate on the span.
boolean	hasAttributes() A set of attributes on the span.
boolean	hasChildSpanCount() An optional number of child spans that were generated while this span was active.
boolean	hasEndTime() The end time of the span.
boolean	hasLinks() The included links.
boolean	hasName() A description of the span's operation.
boolean	hasResource() An optional resource that is associated with this span.
boolean	hasSameProcessAsParentSpan() A highly recommended but not required flag that identifies when a trace crosses a process boundary.
boolean	hasStackTrace() A stack trace captured at the start of the span.
boolean	hasStartTime() The start time of the span.
boolean	hasStatus() An optional final status for this span.
boolean	hasTimeEvents() The included time events.
boolean	hasTracestate() The Tracestate on the span.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTraceId

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;

getSpanId

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;

hasTracestate

boolean hasTracestate()

 The Tracestate on the span.
 

.opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;

getTracestate

Span.Tracestate getTracestate()

 The Tracestate on the span.
 

.opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;

getTracestateOrBuilder

Span.TracestateOrBuilder getTracestateOrBuilder()

 The Tracestate on the span.
 

.opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;

getParentSpanId

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 = 3;

hasName

boolean hasName()

 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.
 When null or empty string received - receiver may use string "name"
 as a replacement. There might be smarted algorithms implemented by
 receiver to fix the empty span name.
 This field is required.
 

.opencensus.proto.trace.v1.TruncatableString name = 4;

getName

TruncatableString 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.
 When null or empty string received - receiver may use string "name"
 as a replacement. There might be smarted algorithms implemented by
 receiver to fix the empty span name.
 This field is required.
 

.opencensus.proto.trace.v1.TruncatableString name = 4;

getNameOrBuilder

TruncatableStringOrBuilder getNameOrBuilder()

 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.
 When null or empty string received - receiver may use string "name"
 as a replacement. There might be smarted algorithms implemented by
 receiver to fix the empty span name.
 This field is required.
 

.opencensus.proto.trace.v1.TruncatableString name = 4;

getKindValue

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.
 

.opencensus.proto.trace.v1.Span.SpanKind kind = 14;

getKind

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.
 

.opencensus.proto.trace.v1.Span.SpanKind kind = 14;

hasStartTime

boolean hasStartTime()

 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.
 This field is semantically required. When not set on receive -
 receiver should set it to the value of end_time field if it was
 set. Or to the current time if neither was set. It is important to
 keep end_time > start_time for consistency.
 This field is required.
 

.google.protobuf.Timestamp start_time = 5;

getStartTime

com.google.protobuf.Timestamp getStartTime()

 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.
 This field is semantically required. When not set on receive -
 receiver should set it to the value of end_time field if it was
 set. Or to the current time if neither was set. It is important to
 keep end_time > start_time for consistency.
 This field is required.
 

.google.protobuf.Timestamp start_time = 5;

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 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.
 This field is semantically required. When not set on receive -
 receiver should set it to the value of end_time field if it was
 set. Or to the current time if neither was set. It is important to
 keep end_time > start_time for consistency.
 This field is required.
 

.google.protobuf.Timestamp start_time = 5;

hasEndTime

boolean hasEndTime()

 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.
 This field is semantically required. When not set on receive -
 receiver should set it to start_time value. It is important to
 keep end_time > start_time for consistency.
 This field is required.
 

.google.protobuf.Timestamp end_time = 6;

getEndTime

com.google.protobuf.Timestamp getEndTime()

 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.
 This field is semantically required. When not set on receive -
 receiver should set it to start_time value. It is important to
 keep end_time > start_time for consistency.
 This field is required.
 

.google.protobuf.Timestamp end_time = 6;

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 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.
 This field is semantically required. When not set on receive -
 receiver should set it to start_time value. It is important to
 keep end_time > start_time for consistency.
 This field is required.
 

.google.protobuf.Timestamp end_time = 6;

hasAttributes

boolean hasAttributes()

 A set of attributes on the span.
 

.opencensus.proto.trace.v1.Span.Attributes attributes = 7;

getAttributes

Span.Attributes getAttributes()

 A set of attributes on the span.
 

.opencensus.proto.trace.v1.Span.Attributes attributes = 7;

getAttributesOrBuilder

Span.AttributesOrBuilder getAttributesOrBuilder()

 A set of attributes on the span.
 

.opencensus.proto.trace.v1.Span.Attributes attributes = 7;

hasStackTrace

boolean hasStackTrace()

 A stack trace captured at the start of the span.
 

.opencensus.proto.trace.v1.StackTrace stack_trace = 8;

getStackTrace

StackTrace getStackTrace()

 A stack trace captured at the start of the span.
 

.opencensus.proto.trace.v1.StackTrace stack_trace = 8;

getStackTraceOrBuilder

StackTraceOrBuilder getStackTraceOrBuilder()

 A stack trace captured at the start of the span.
 

.opencensus.proto.trace.v1.StackTrace stack_trace = 8;

hasTimeEvents

boolean hasTimeEvents()

 The included time events.
 

.opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;

getTimeEvents

Span.TimeEvents getTimeEvents()

 The included time events.
 

.opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;

getTimeEventsOrBuilder

Span.TimeEventsOrBuilder getTimeEventsOrBuilder()

 The included time events.
 

.opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;

hasLinks

boolean hasLinks()

 The included links.
 

.opencensus.proto.trace.v1.Span.Links links = 10;

getLinks

Span.Links getLinks()

 The included links.
 

.opencensus.proto.trace.v1.Span.Links links = 10;

getLinksOrBuilder

Span.LinksOrBuilder getLinksOrBuilder()

 The included links.
 

.opencensus.proto.trace.v1.Span.Links links = 10;

hasStatus

boolean hasStatus()

 An optional final status for this span. Semantically when Status
 wasn't set it is means span ended without errors and assume
 Status.Ok (code = 0).
 

.opencensus.proto.trace.v1.Status status = 11;

getStatus

Status getStatus()

 An optional final status for this span. Semantically when Status
 wasn't set it is means span ended without errors and assume
 Status.Ok (code = 0).
 

.opencensus.proto.trace.v1.Status status = 11;

getStatusOrBuilder

StatusOrBuilder getStatusOrBuilder()

 An optional final status for this span. Semantically when Status
 wasn't set it is means span ended without errors and assume
 Status.Ok (code = 0).
 

.opencensus.proto.trace.v1.Status status = 11;

hasResource

boolean hasResource()

 An optional resource that is associated with this span. If not set, this span 
 should be part of a batch that does include the resource information, unless resource 
 information is unknown.
 

.opencensus.proto.resource.v1.Resource resource = 16;

getResource

Resource getResource()

 An optional resource that is associated with this span. If not set, this span 
 should be part of a batch that does include the resource information, unless resource 
 information is unknown.
 

.opencensus.proto.resource.v1.Resource resource = 16;

getResourceOrBuilder

ResourceOrBuilder getResourceOrBuilder()

 An optional resource that is associated with this span. If not set, this span 
 should be part of a batch that does include the resource information, unless resource 
 information is unknown.
 

.opencensus.proto.resource.v1.Resource resource = 16;

hasSameProcessAsParentSpan

boolean hasSameProcessAsParentSpan()

 A highly recommended but not required flag that identifies when a
 trace crosses a process boundary. True when the parent_span belongs
 to the same process as the current span. This flag is most commonly
 used to indicate the need to adjust time as clocks in different
 processes may not be synchronized.
 

.google.protobuf.BoolValue same_process_as_parent_span = 12;

getSameProcessAsParentSpan

com.google.protobuf.BoolValue getSameProcessAsParentSpan()

 A highly recommended but not required flag that identifies when a
 trace crosses a process boundary. True when the parent_span belongs
 to the same process as the current span. This flag is most commonly
 used to indicate the need to adjust time as clocks in different
 processes may not be synchronized.
 

.google.protobuf.BoolValue same_process_as_parent_span = 12;

getSameProcessAsParentSpanOrBuilder

com.google.protobuf.BoolValueOrBuilder getSameProcessAsParentSpanOrBuilder()

 A highly recommended but not required flag that identifies when a
 trace crosses a process boundary. True when the parent_span belongs
 to the same process as the current span. This flag is most commonly
 used to indicate the need to adjust time as clocks in different
 processes may not be synchronized.
 

.google.protobuf.BoolValue same_process_as_parent_span = 12;

hasChildSpanCount

boolean hasChildSpanCount()

 An optional number of child spans that were generated while this span
 was active. If set, allows an implementation to detect missing child spans.
 

.google.protobuf.UInt32Value child_span_count = 13;

getChildSpanCount

com.google.protobuf.UInt32Value getChildSpanCount()

 An optional number of child spans that were generated while this span
 was active. If set, allows an implementation to detect missing child spans.
 

.google.protobuf.UInt32Value child_span_count = 13;

getChildSpanCountOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getChildSpanCountOrBuilder()

 An optional number of child spans that were generated while this span
 was active. If set, allows an implementation to detect missing child spans.
 

.google.protobuf.UInt32Value child_span_count = 13;