Span

import type { Span } from "https://googleapis.deno.dev/v1/cloudtrace:v2.ts";

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.

interface Span {

attributes?: Attributes;

childSpanCount?: number;

displayName?: TruncatableString;

endTime?: Date;

links?: Links;

name?: string;

parentSpanId?: string;

sameProcessAsParentSpan?: boolean;

spanId?: string;

spanKind?:

| "SPAN_KIND_UNSPECIFIED"

| "INTERNAL"

| "SERVER"

| "CLIENT"

| "PRODUCER"

| "CONSUMER";

stackTrace?: StackTrace;

startTime?: Date;

status?: Status;

timeEvents?: TimeEvents;

}

§Properties

attributes?: Attributes

[src]

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

childSpanCount?: number

[src]

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

displayName?: TruncatableString

[src]

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.

endTime?: Date

[src]

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.

links?: Links

[src]

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

name?: string

[src]

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

parentSpanId?: string

[src]

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

sameProcessAsParentSpan?: boolean

[src]

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.

spanId?: string

[src]

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

[src]

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.

stackTrace?: StackTrace

[src]

Stack trace captured at the start of the span.

startTime?: Date

[src]

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.

status?: Status

[src]

Optional. The final status for this span.

timeEvents?: TimeEvents

[src]

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