Module types (0.23.0)

API documentation for trace_v1.types module.

Classes

Empty

API documentation for trace_v1.types.Empty class.

GetTraceRequest

The request message for the GetTrace method.

ID of the trace to return.

ListTracesRequest

The request message for the ListTraces method. All fields are required unless specified.

Type of data returned for traces in the list. Optional. Default is MINIMAL.

Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request. Optional.

End of the time interval (inclusive) during which the trace data was collected from the application.

Field used to sort the returned traces. Optional. Can be one of the following: - trace_id - name (name field of root span in the trace) - duration (difference between end_time and start_time fields of the root span) - start (start_time field of the root span) Descending order can be specified by appending desc to the sort field (for example, name desc). Only one sort field is permitted.

ListTracesResponse

The response message for the ListTraces method.

If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.

PatchTracesRequest

The request message for the PatchTraces method.

The body of the message.

Timestamp

API documentation for trace_v1.types.Timestamp class.

Trace

A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.

Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.

TraceSpan

A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using RPC_CLIENT and RPC_SERVER to identify queueing latency associated with the span.

Start time of the span in nanoseconds from the UNIX epoch.

ID of the parent span, if any. Optional.

Traces

List of new or updated traces.