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

System.Object

Span

Implements

Google.Apis.Requests.IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.CloudTrace.v2.Data

Assembly: Google.Apis.CloudTrace.v2.dll

Syntax

public class Span : IDirectResponseSchema

Properties

Attributes

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

Declaration

[JsonProperty("attributes")]
public virtual Attributes Attributes { get; set; }

Property Value

Type	Description
Attributes

ChildSpanCount

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

Declaration

[JsonProperty("childSpanCount")]
public virtual int? ChildSpanCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

DisplayName

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.

Declaration

[JsonProperty("displayName")]
public virtual TruncatableString DisplayName { get; set; }

Property Value

Type	Description
TruncatableString

EndTime

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.

Declaration

[JsonProperty("endTime")]
public virtual object EndTime { get; set; }

Property Value

Type	Description
System.Object

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

Links

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

Declaration

[JsonProperty("links")]
public virtual Links Links { get; set; }

Property Value

Type	Description
Links

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
System.String

ParentSpanId

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

Declaration

[JsonProperty("parentSpanId")]
public virtual string ParentSpanId { get; set; }

Property Value

Type	Description
System.String

SameProcessAsParentSpan

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.

Declaration

[JsonProperty("sameProcessAsParentSpan")]
public virtual bool? SameProcessAsParentSpan { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

SpanId

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

Declaration

[JsonProperty("spanId")]
public virtual string SpanId { get; set; }

Property Value

Type	Description
System.String

SpanKind

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.

Declaration

[JsonProperty("spanKind")]
public virtual string SpanKind { get; set; }

Property Value

Type	Description
System.String

StackTrace

Stack trace captured at the start of the span.

Declaration

[JsonProperty("stackTrace")]
public virtual StackTrace StackTrace { get; set; }

Property Value

Type	Description
StackTrace

StartTime

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.

Declaration

[JsonProperty("startTime")]
public virtual object StartTime { get; set; }

Property Value

Type	Description
System.Object

Status

Optional. The final status for this span.

Declaration

[JsonProperty("status")]
public virtual Status Status { get; set; }

Property Value

Type	Description
Status

TimeEvents

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

Declaration

[JsonProperty("timeEvents")]
public virtual TimeEvents TimeEvents { get; set; }

Property Value

Type	Description
TimeEvents

Implements

Google.Apis.Requests.IDirectResponseSchema