As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Trace v1 API

class google.cloud.trace_v1.types.GetTraceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for the GetTrace method.

project_id

Required. ID of the Cloud project where the trace data is stored.

Type

str

trace_id

Required. ID of the trace to return.

Type

str

class google.cloud.trace_v1.types.ListTracesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

project_id

Required. ID of the Cloud project where the trace data is stored.

Type

str

view

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

Type

google.cloud.trace_v1.types.ListTracesRequest.ViewType

page_size

Optional. Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size.

Type

int

page_token

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

Type

str

start_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

filter

Optional. A filter against labels for the request.

By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax:

  • root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX.

  • +root:NAME or +NAME: Return traces where any root span’s name is exactly NAME.

  • span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX.

  • +span:NAME: Return traces where any span’s name is exactly NAME.

  • latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds.

  • label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair’s value (including empty values).

  • LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified.

  • +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified.

  • method:VALUE: Equivalent to /http/method:VALUE.

  • url:VALUE: Equivalent to /http/url:VALUE.

Type

str

order_by

Optional. Field used to sort the returned traces. 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.

Type

str

class ViewType(value)[source]

Bases: proto.enums.Enum

Type of data returned for traces in the list.

Values:
VIEW_TYPE_UNSPECIFIED (0):

Default is MINIMAL if unspecified.

MINIMAL (1):

Minimal view of the trace record that contains only the project and trace IDs.

ROOTSPAN (2):

Root span view of the trace record that returns the root spans along with the minimal trace data.

COMPLETE (3):

Complete view of the trace record that contains the actual trace data. This is equivalent to calling the REST get or RPC GetTrace method using the ID of each listed trace.

class google.cloud.trace_v1.types.ListTracesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for the ListTraces method.

traces

List of trace records as specified by the view parameter.

Type

MutableSequence[google.cloud.trace_v1.types.Trace]

next_page_token

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.

Type

str

class google.cloud.trace_v1.types.PatchTracesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for the PatchTraces method.

project_id

Required. ID of the Cloud project where the trace data is stored.

Type

str

traces

Required. The body of the message.

Type

google.cloud.trace_v1.types.Traces

class google.cloud.trace_v1.types.Trace(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

project_id

Project ID of the Cloud project where the trace data is stored.

Type

str

trace_id

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

Type

str

spans

Collection of spans in the trace.

Type

MutableSequence[google.cloud.trace_v1.types.TraceSpan]

class google.cloud.trace_v1.types.TraceSpan(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

span_id

Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284.

Type

int

kind

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.

Type

google.cloud.trace_v1.types.TraceSpan.SpanKind

name

Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.

Type

str

start_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

parent_span_id

Optional. ID of the parent span, if any.

Type

int

labels

Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

  • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).

  • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

Predefined labels include:

  • /agent

  • /component

  • /error/message

  • /error/name

  • /http/client_city

  • /http/client_country

  • /http/client_protocol

  • /http/client_region

  • /http/host

  • /http/method

  • /http/path

  • /http/redirected_url

  • /http/request/size

  • /http/response/size

  • /http/route

  • /http/status_code

  • /http/url

  • /http/user_agent

  • /pid

  • /stacktrace

  • /tid

Type

MutableMapping[str, str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class SpanKind(value)[source]

Bases: proto.enums.Enum

Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

Values:
SPAN_KIND_UNSPECIFIED (0):

Unspecified.

RPC_SERVER (1):

Indicates that the span covers server-side handling of an RPC or other remote network request.

RPC_CLIENT (2):

Indicates that the span covers the client-side wrapper around an RPC or other remote request.

class google.cloud.trace_v1.types.Traces(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

List of new or updated traces.

traces

List of traces.

Type

MutableSequence[google.cloud.trace_v1.types.Trace]