OpenTelemetry.Proto.Trace.V1.Span

sealed class Span : IMessage<Span>, IMessage, IEquatable<Span>, IDeepCloneable<Span>, IBufferMessage

A Span represents a single operation performed by a single component of the system. The next available field id is 17.

public static class Types

Container for nested types declared in the Span message type.

public const int AttributesFieldNumber = 9

Field number for the "attributes" field.

public const int DroppedAttributesCountFieldNumber = 10

Field number for the "dropped_attributes_count" field.

public const int DroppedEventsCountFieldNumber = 12

Field number for the "dropped_events_count" field.

public const int DroppedLinksCountFieldNumber = 14

Field number for the "dropped_links_count" field.

public const int EndTimeUnixNanoFieldNumber = 8

Field number for the "end_time_unix_nano" field.

public const int EventsFieldNumber = 11

Field number for the "events" field.

public const int FlagsFieldNumber = 16

Field number for the "flags" field.

public const int KindFieldNumber = 6

Field number for the "kind" field.

public const int LinksFieldNumber = 13

Field number for the "links" field.

public const int NameFieldNumber = 5

Field number for the "name" field.

public const int ParentSpanIdFieldNumber = 4

Field number for the "parent_span_id" field.

public const int SpanIdFieldNumber = 2

Field number for the "span_id" field.

public const int StartTimeUnixNanoFieldNumber = 7

Field number for the "start_time_unix_nano" field.

public const int StatusFieldNumber = 15

Field number for the "status" field.

public const int TraceIdFieldNumber = 1

Field number for the "trace_id" field.

public const int TraceStateFieldNumber = 3

Field number for the "trace_state" field.

public static MessageDescriptor Descriptor { get; }

public static MessageParser<Span> Parser { get; }

public RepeatedField<KeyValue> Attributes { get; }

attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes: "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36" "/http/server_latency": 300 "example.com/myattribute": true "example.com/score": 10.239 The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

public uint DroppedAttributesCount { get; set; }

dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.

public uint DroppedEventsCount { get; set; }

dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.

public uint DroppedLinksCount { get; set; }

dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.

public ulong EndTimeUnixNano { get; set; }

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.

public RepeatedField<Event> Events { get; }

events is a collection of Event items.

public uint Flags { get; set; }

Flags, a bit field. 8 least significant bits are the trace flags as defined in W3C Trace Context specification. Readers MUST not assume that 24 most significant bits will be zero. To read the 8-bit W3C trace flag, use `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`. When creating span messages, if the message is logically forwarded from another source with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD be copied as-is. If creating from a source that does not have an equivalent flags field (such as a runtime representation of an OpenTelemetry span), the high 24 bits MUST be set to zero. [Optional]. See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.

public SpanKind Kind { get; set; }

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.

public RepeatedField<Link> Links { get; }

links is a collection of Links, which are references from this span to a span in the same or different trace.

public string Name { get; set; }

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.

public ByteString ParentSpanId { get; set; }

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.

public ByteString SpanId { get; set; }

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 OR of length other than 8 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid). This field is required.

public ulong StartTimeUnixNano { get; set; }

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.

public Status Status { get; set; }

An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).

public ByteString TraceId { get; set; }

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 OR of length other than 16 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid). This field is required.

public string TraceState { get; set; }

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.

public Span()

public Span(Span other)

public int CalculateSize()

public Span Clone()

public bool Equals(Span other)

public void MergeFrom(Span other)

public void MergeFrom(CodedInputStream input)

public void WriteTo(CodedOutputStream output)