tracing/foundry.tracing/Span

Span

class Span(val id: ByteString = ByteString.EMPTY, val parent_id: ByteString = ByteString.EMPTY, val trace_id: ByteString = ByteString.EMPTY, val name: String = "", val start_timestamp_micros: Long = 0, val duration_micros: Long = 0, tags: List<KeyValue> = emptyList(), unknownFields: ByteString = ByteString.EMPTY) : Message<Span, Nothing>

A span defines a single event in a trace. This span format is inspired by the zipkin span design at: https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto

Constructors

Span

constructor(id: ByteString = ByteString.EMPTY, parent_id: ByteString = ByteString.EMPTY, trace_id: ByteString = ByteString.EMPTY, name: String = "", start_timestamp_micros: Long = 0, duration_micros: Long = 0, tags: List<KeyValue> = emptyList(), unknownFields: ByteString = ByteString.EMPTY)

Types

Companion

object Companion

Properties

adapter

val adapter: ProtoAdapter<Span>

duration_micros

val duration_micros: Long = 0

This field stored the duration in microseconds for the event in the critical path. For example 150 milliseconds is 150000 microseconds. This field is required.

val id: ByteString

A field that uniquely identifies this event. This field usually contains a randomly generated UUID. This field is required and encoded as 8 or 16 bytes, in big endian byte order.

name

val name: String

A name for the event.

parent_id

val parent_id: ByteString

This field contains the parent id of this span. It is useful to establish a parent-child relationships between spans. If empty, this span will be considered a root span.

start_timestamp_micros

val start_timestamp_micros: Long = 0

The timestamp field stores the epoch microseconds at which this event happened. For example: a value of 1551849569000000 represents March 6, 2019 5:19:29 UTC. We use fixed64 since it is more wire efficient for than int64 for larger numbers. This field is required.

Functions

copy

fun copy(id: ByteString = this.id, parent_id: ByteString = this.parent_id, trace_id: ByteString = this.trace_id, name: String = this.name, start_timestamp_micros: Long = this.start_timestamp_micros, duration_micros: Long = this.duration_micros, tags: List<KeyValue> = this.tags, unknownFields: ByteString = this.unknownFields): Span

encode

fun encode(): ByteArray

fun encode(stream: OutputStream)

fun encode(sink: BufferedSink)

encodeByteString

fun encodeByteString(): ByteString

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withoutUnknownFields

fun withoutUnknownFields(): Span