Google Cloud Trace v2 API - Class Span (3.5.0)

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

Reference documentation and code samples for the Google Cloud Trace v2 API class Span.

A span represents a single operation within a trace. Spans can be nested to form a trace tree. 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 might be gaps or overlaps between spans in a trace.

Inheritance

object > Span

Namespace

Google.Cloud.Trace.V2

Assembly

Google.Cloud.Trace.V2.dll

Constructors

Span()

public Span()

Span(Span)

public Span(Span other)
Parameter
NameDescription
otherSpan

Properties

Attributes

public Span.Types.Attributes Attributes { get; set; }

A set of attributes on the span. You can have up to 32 attributes per span.

Property Value
TypeDescription
SpanTypesAttributes

ChildSpanCount

public int? ChildSpanCount { get; set; }

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

Property Value
TypeDescription
int

DisplayName

public TruncatableString DisplayName { get; set; }

Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display 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 within an application and at the same call point. This makes it easier to correlate spans in different traces.

Property Value
TypeDescription
TruncatableString

EndTime

public Timestamp EndTime { get; set; }

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

Property Value
TypeDescription
Timestamp
public Span.Types.Links Links { get; set; }

Links associated with the span. You can have up to 128 links per Span.

Property Value
TypeDescription
SpanTypesLinks

Name

public string Name { get; set; }

Required. The resource name of the span in the following format:

  • projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero.

[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .

Property Value
TypeDescription
string

ParentSpanId

public string ParentSpanId { get; set; }

The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.

Property Value
TypeDescription
string

SameProcessAsParentSpan

public bool? SameProcessAsParentSpan { get; set; }

Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.

Property Value
TypeDescription
bool

SpanId

public string SpanId { get; set; }

Required. The [SPAN_ID] portion of the span's resource name.

Property Value
TypeDescription
string

SpanKind

public Span.Types.SpanKind SpanKind { get; set; }

Optional. 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 an RPC call.

Property Value
TypeDescription
SpanTypesSpanKind

SpanName

public SpanName SpanName { get; set; }

SpanName-typed view over the Name resource name property.

Property Value
TypeDescription
SpanName

StackTrace

public StackTrace StackTrace { get; set; }

Stack trace captured at the start of the span.

Property Value
TypeDescription
StackTrace

StartTime

public Timestamp StartTime { get; set; }

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

Property Value
TypeDescription
Timestamp

Status

public Status Status { get; set; }

Optional. The final status for this span.

Property Value
TypeDescription
Status

TimeEvents

public Span.Types.TimeEvents TimeEvents { get; set; }

A set of time events. You can have up to 32 annotations and 128 message events per span.

Property Value
TypeDescription
SpanTypesTimeEvents