Module types (0.24.2)

API documentation for trace_v2.types module.

Classes

Any

API documentation for trace_v2.types.Any class.

AttributeValue

The allowed types for [VALUE] in a [KEY]:[VALUE] attribute.

A string up to 256 bytes long.

A Boolean value represented by true or false.

BatchWriteSpansRequest

The request message for the BatchWriteSpans method.

Required. A list of new spans. The span names must not match existing spans, or the results are undefined.

BoolValue

API documentation for trace_v2.types.BoolValue class.

BytesValue

API documentation for trace_v2.types.BytesValue class.

DoubleValue

API documentation for trace_v2.types.DoubleValue class.

Empty

API documentation for trace_v2.types.Empty class.

FloatValue

API documentation for trace_v2.types.FloatValue class.

Int32Value

API documentation for trace_v2.types.Int32Value class.

Int64Value

API documentation for trace_v2.types.Int64Value class.

Module

Binary module.

A unique identifier for the module, usually a hash of its contents (up to 128 bytes).

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

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

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

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.

Stack trace captured at the start of the span.

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

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.

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

A call stack appearing in a trace.

The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the stackFrame content and a value in stackTraceHashId. Subsequent spans within the same request can refer to that stack trace by only setting stackTraceHashId.

Status

API documentation for trace_v2.types.Status class.

StringValue

API documentation for trace_v2.types.StringValue class.

Timestamp

API documentation for trace_v2.types.Timestamp class.

TruncatableString

Represents a string that might be shortened to a specified length.

The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

UInt32Value

API documentation for trace_v2.types.UInt32Value class.

UInt64Value

API documentation for trace_v2.types.UInt64Value class.