Class TraceSpan

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 may be gaps or overlaps between spans in a trace.

Inheritance
object
TraceSpan
Implements
Inherited Members
Namespace: Google.Apis.ServiceControl.v1.Data
Assembly: Google.Apis.ServiceControl.v1.dll
Syntax
public class TraceSpan : 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

An optional 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
int?

DisplayName

A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform 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

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

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 string EndTimeRaw { get; set; }
Property Value
Type Description
string

Name

The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
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
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, Stackdriver Trace is unable to take advantage of this helpful information.

Declaration
[JsonProperty("sameProcessAsParentSpan")]
public virtual bool? SameProcessAsParentSpan { get; set; }
Property Value
Type Description
bool?

SpanId

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

Declaration
[JsonProperty("spanId")]
public virtual string SpanId { get; set; }
Property Value
Type Description
string

SpanKind

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
string

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

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 string StartTimeRaw { get; set; }
Property Value
Type Description
string

Status

An optional final status for this span.

Declaration
[JsonProperty("status")]
public virtual Status Status { get; set; }
Property Value
Type Description
Status

Implements