Package Classes (1.13.4)

Summary of entries of Classes for cloudtrace.

Classes

TraceServiceAsyncClient

This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. Spans for a single trace may span multiple services.

TraceServiceClient

This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. Spans for a single trace may span multiple services.

ListTracesAsyncPager

A pager for iterating through list_traces requests.

This class thinly wraps an initial ListTracesResponse object, and provides an __aiter__ method to iterate through its traces field.

If there are more pages, the __aiter__ method will make additional ListTraces requests and continue to iterate through the traces field on the corresponding responses.

All the usual ListTracesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTracesPager

A pager for iterating through list_traces requests.

This class thinly wraps an initial ListTracesResponse object, and provides an __iter__ method to iterate through its traces field.

If there are more pages, the __iter__ method will make additional ListTraces requests and continue to iterate through the traces field on the corresponding responses.

All the usual ListTracesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

GetTraceRequest

The request message for the GetTrace method.

ListTracesRequest

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

ViewType

Type of data returned for traces in the list.

ListTracesResponse

The response message for the ListTraces method.

PatchTracesRequest

The request message for the PatchTraces method.

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.

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.

LabelsEntry

The abstract base class for a message.

SpanKind

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

Traces

List of new or updated traces.

TraceServiceAsyncClient

Service for collecting and viewing traces and spans within a trace. A trace is a collection of spans corresponding to a single operation or a set of operations in an application.

A span is an individual timed event which forms a node of the trace tree. A single trace can contain spans from multiple services.

TraceServiceClient

Service for collecting and viewing traces and spans within a trace. A trace is a collection of spans corresponding to a single operation or a set of operations in an application.

A span is an individual timed event which forms a node of the trace tree. A single trace can contain spans from multiple services.

AttributeValue

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchWriteSpansRequest

The request message for the BatchWriteSpans method.

Module

Binary module.

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

Attributes

A set of attributes as key-value pairs.

AttributeMapEntry

The abstract base class for a message.

A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project.

Type

The relationship of the current span relative to the linked span: child, parent, or unspecified.

A collection of links, which are references from this span to a span in the same or different trace.

SpanKind

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

TimeEvent

A time-stamped annotation or message event in the Span.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Annotation

Text annotation with a set of attributes.

MessageEvent

An event describing a message sent/received between Spans.

Type

Indicates whether the message was sent or received.

TimeEvents

A collection of TimeEvent\ s. A TimeEvent is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans.

StackTrace

A call stack appearing in a trace.

StackFrame

Represents a single stack frame in a stack trace.

StackFrames

A collection of stack frames, which can be truncated.

TruncatableString

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

Modules

pagers

API documentation for trace_v1.services.trace_service.pagers module.