Package 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 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;
        Returns:
        The traceId.

      • 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;
        Returns:
        The spanId.

      • hasTracestate

        boolean hasTracestate()
         The Tracestate on the span.
        .opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;
        Returns:
        Whether the tracestate field is set.

      • getTracestate

        Span.Tracestate getTracestate()
         The Tracestate on the span.
        .opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;
        Returns:
        The tracestate.

      • 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;
        Returns:
        The parentSpanId.

      • 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;
        Returns:
        Whether the name field is set.

      • 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;
        Returns:
        The name.

      • 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;
        Returns:
        The enum numeric value on the wire for kind.

      • 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;
        Returns:
        The kind.

      • 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;
        Returns:
        Whether the startTime field is set.

      • 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;
        Returns:
        The startTime.

      • 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;
        Returns:
        Whether the endTime field is set.

      • 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;
        Returns:
        The endTime.

      • 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;
        Returns:
        Whether the attributes field is set.

      • getAttributes

        Span.Attributes getAttributes()
         A set of attributes on the span.
        .opencensus.proto.trace.v1.Span.Attributes attributes = 7;
        Returns:
        The attributes.

      • 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;
        Returns:
        Whether the stackTrace field is set.

      • getStackTrace

        StackTrace getStackTrace()
         A stack trace captured at the start of the span.
        .opencensus.proto.trace.v1.StackTrace stack_trace = 8;
        Returns:
        The stackTrace.

      • 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;
        Returns:
        Whether the timeEvents field is set.

      • getTimeEvents

        Span.TimeEvents getTimeEvents()
         The included time events.
        .opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;
        Returns:
        The timeEvents.

      • 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;
        Returns:
        Whether the links field is set.

      • getLinks

        Span.Links getLinks()
         The included links.
        .opencensus.proto.trace.v1.Span.Links links = 10;
        Returns:
        The links.

      • 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;
        Returns:
        Whether the status field is set.

      • 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;
        Returns:
        The status.

      • 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;
        Returns:
        Whether the resource field is set.

      • 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;
        Returns:
        The resource.

      • 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;
        Returns:
        Whether the sameProcessAsParentSpan field is set.

      • 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;
        Returns:
        The sameProcessAsParentSpan.

      • 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;
        Returns:
        Whether the childSpanCount field is set.

      • 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;
        Returns:
        The childSpanCount.

      • 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;