Type Members

1.  final case class AttributeValue(value: Value = io.opencensus.proto.trace.v1.trace.AttributeValue.Value.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AttributeValue] with Product with Serializable

   The value of an Attribute.

   The value of an Attribute.

   Annotations

   @SerialVersionUID()

2.  final case class Module(module: Option[TruncatableString] = _root_.scala.None, buildId: Option[TruncatableString] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Module] with Product with Serializable

   A description of a binary module.

   A description of a binary module.

   module

   TODO: document the meaning of this field. For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so.

   buildId

   A unique identifier for the module, usually a hash of its contents.

   Annotations

   @SerialVersionUID()

3.  final case class Span(traceId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, spanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, tracestate: Option[Tracestate] = _root_.scala.None, parentSpanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, name: Option[TruncatableString] = _root_.scala.None, kind: SpanKind = io.opencensus.proto.trace.v1.trace.Span.SpanKind.SPAN_KIND_UNSPECIFIED, startTime: Option[Timestamp] = _root_.scala.None, endTime: Option[Timestamp] = _root_.scala.None, attributes: Option[Attributes] = _root_.scala.None, stackTrace: Option[StackTrace] = _root_.scala.None, timeEvents: Option[TimeEvents] = _root_.scala.None, links: Option[Links] = _root_.scala.None, status: Option[Status] = _root_.scala.None, resource: Option[Resource] = _root_.scala.None, sameProcessAsParentSpan: Option[Boolean] = _root_.scala.None, childSpanCount: Option[Int] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Span] with Product with Serializable

   A span represents a single operation within a trace.

   A 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 id is 17. TODO(bdrutu): Add an example.

   traceId

   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.

   spanId

   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.

   tracestate

   The Tracestate on the span.

   parentSpanId

   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.

   name

   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.

   kind

   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.

   startTime

   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.

   endTime

   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.

   attributes

   A set of attributes on the span.

   stackTrace

   A stack trace captured at the start of the span.

   timeEvents

   The included time events.

   links

   The included links.

   status

   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).

   resource

   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.

   sameProcessAsParentSpan

   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.

   childSpanCount

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

   Annotations

   @SerialVersionUID()

4.  final case class StackTrace(stackFrames: Option[StackFrames] = _root_.scala.None, stackTraceHashId: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StackTrace] with Product with Serializable

   The call stack which originated this span.

   The call stack which originated this span.

   stackFrames

   Stack frames in this stack trace.

   stackTraceHashId

   The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both stack_frames and a value in stack_trace_hash_id. Subsequent spans within the same request can refer to that stack trace by setting only stack_trace_hash_id. TODO: describe how to deal with the case where stack_trace_hash_id is zero because it was not set.

   Annotations

   @SerialVersionUID()

5.  final case class Status(code: Int = 0, message: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Status] with Product with Serializable

   The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

   The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. This proto's fields are a subset of those of [google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto), which is used by [gRPC](https://github.com/grpc).

   code

   The status code. This is optional field. It is safe to assume 0 (OK) when not set.

   message

   A developer-facing error message, which should be in English.

   Annotations

   @SerialVersionUID()

6.  final case class TruncatableString(value: String = "", truncatedByteCount: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TruncatableString] with Product with Serializable

   A string that might be shortened to a specified length.

   A string that might be shortened to a specified length.

   value

   The shortened string. For example, if the original string was 500 bytes long and the limit of the string was 128 bytes, then this value contains the first 128 bytes of the 500-byte string. Note that truncation always happens on a character boundary, to ensure that a truncated string is still valid UTF-8. Because it may contain multi-byte characters, the size of the truncated string may be less than the truncation limit.

   truncatedByteCount

   The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

   Annotations

   @SerialVersionUID()