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 v2 API¶

class google.cloud.trace_v2.types.AttributeValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

string_value¶

A string up to 256 bytes long.

This field is a member of oneof value.

Type: google.cloud.trace_v2.types.TruncatableString

int_value¶

A 64-bit signed integer.

This field is a member of oneof value.

Type: int

bool_value¶

A Boolean value represented by true or false.

This field is a member of oneof value.

Type: bool

class google.cloud.trace_v2.types.BatchWriteSpansRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for the BatchWriteSpans method.

name¶

Required. The name of the project where the spans belong. The format is projects/[PROJECT_ID].

Type: str

spans¶

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

Type: MutableSequence[google.cloud.trace_v2.types.Span]

class google.cloud.trace_v2.types.Module(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Binary module.

module¶

For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).

Type: google.cloud.trace_v2.types.TruncatableString

build_id¶

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

Type: google.cloud.trace_v2.types.TruncatableString

class google.cloud.trace_v2.types.Span(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

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

Type: str

span_id¶

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

Type: str

parent_span_id¶

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

Type: str

display_name¶

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.

Type: google.cloud.trace_v2.types.TruncatableString

start_time¶

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.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

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.

Type: google.protobuf.timestamp_pb2.Timestamp

attributes¶

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

Type: google.cloud.trace_v2.types.Span.Attributes

stack_trace¶

Stack trace captured at the start of the span.

Type: google.cloud.trace_v2.types.StackTrace

time_events¶

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

Type: google.cloud.trace_v2.types.Span.TimeEvents

links¶

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

Type: google.cloud.trace_v2.types.Span.Links

status¶

Optional. The final status for this span.

Type: google.rpc.status_pb2.Status

same_process_as_parent_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, Trace is unable to take advantage of this helpful information.

Type: google.protobuf.wrappers_pb2.BoolValue

child_span_count¶

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

Type: google.protobuf.wrappers_pb2.Int32Value

span_kind¶

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.

Type: google.cloud.trace_v2.types.Span.SpanKind

class Attributes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A set of attributes as key-value pairs.

attribute_map¶

A set of attributes. Each attribute’s key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values true or false. For example:

"/instance_id": { "string_value": { "value": "my-instance" } }
"/http/request_bytes": { "int_value": 300 }
"abc.com/myattribute": { "bool_value": false }

Type: MutableMapping[str, google.cloud.trace_v2.types.AttributeValue]

dropped_attributes_count¶

The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.

Type: int

class AttributeMapEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class Link(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.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.

trace_id¶

The [TRACE_ID] for a trace within a project.

Type: str

span_id¶

The [SPAN_ID] for a span within a trace.

Type: str

type¶

The relationship of the current span relative to the linked span.

Type: google.cloud.trace_v2.types.Span.Link.Type

attributes¶

A set of attributes on the link. Up to 32 attributes can be specified per link.

Type: google.cloud.trace_v2.types.Span.Attributes

class Type(value)[source]¶

Bases: proto.enums.Enum

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

Values:

TYPE_UNSPECIFIED (0):: The relationship of the two spans is unknown.
CHILD_LINKED_SPAN (1):: The linked span is a child of the current span.
PARENT_LINKED_SPAN (2):: The linked span is a parent of the current span.

class Links(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

link¶

A collection of links.

Type: MutableSequence[google.cloud.trace_v2.types.Span.Link]

dropped_links_count¶

The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.

Type: int

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. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default.
INTERNAL (1):: Indicates that the span is used internally. Default value.
SERVER (2):: Indicates that the span covers server-side handling of an RPC or other remote network request.
CLIENT (3):: Indicates that the span covers the client-side wrapper around an RPC or other remote request.
PRODUCER (4):: Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. publishing a message to a pubsub service).
CONSUMER (5):: Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. receiving a message from a pubsub service subscription).

class TimeEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

time¶

The timestamp indicating the time the event occurred.

Type: google.protobuf.timestamp_pb2.Timestamp

annotation¶

Text annotation with a set of attributes.

This field is a member of oneof value.

Type: google.cloud.trace_v2.types.Span.TimeEvent.Annotation

message_event¶

An event describing a message sent/received between Spans.

This field is a member of oneof value.

Type: google.cloud.trace_v2.types.Span.TimeEvent.MessageEvent

class Annotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Text annotation with a set of attributes.

description¶

A user-supplied message describing the event. The maximum length for the description is 256 bytes.

Type: google.cloud.trace_v2.types.TruncatableString

attributes¶

A set of attributes on the annotation. You can have up to 4 attributes per Annotation.

Type: google.cloud.trace_v2.types.Span.Attributes

class MessageEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An event describing a message sent/received between Spans.

type¶

Type of MessageEvent. Indicates whether the message was sent or received.

Type: google.cloud.trace_v2.types.Span.TimeEvent.MessageEvent.Type

id¶

An identifier for the MessageEvent’s message that can be used to match SENT and RECEIVED MessageEvents.

Type: int

uncompressed_size_bytes¶

The number of uncompressed bytes sent or received.

Type: int

compressed_size_bytes¶

The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.

Type: int

class Type(value)[source]¶

Bases: proto.enums.Enum

Indicates whether the message was sent or received.

Values:

TYPE_UNSPECIFIED (0):: Unknown event type.
SENT (1):: Indicates a sent message.
RECEIVED (2):: Indicates a received message.

class TimeEvents(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A collection of TimeEvents. 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.

time_event¶

A collection of TimeEvents.

Type: MutableSequence[google.cloud.trace_v2.types.Span.TimeEvent]

dropped_annotations_count¶

The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.

Type: int

dropped_message_events_count¶

The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.

Type: int

class google.cloud.trace_v2.types.StackTrace(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A call stack appearing in a trace.

stack_frames¶

Stack frames in this stack trace. A maximum of 128 frames are allowed.

Type: google.cloud.trace_v2.types.StackTrace.StackFrames

stack_trace_hash_id¶

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.

Type: int

class StackFrame(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a single stack frame in a stack trace.

function_name¶

The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).

Type: google.cloud.trace_v2.types.TruncatableString

original_function_name¶

An un-mangled function name, if function_name is mangled. To get information about name mangling, run this search. The name can be fully-qualified (up to 1024 bytes).

Type: google.cloud.trace_v2.types.TruncatableString

file_name¶

The name of the source file where the function call appears (up to 256 bytes).

Type: google.cloud.trace_v2.types.TruncatableString

line_number¶

The line number in file_name where the function call appears.

Type: int

column_number¶

The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.

Type: int

load_module¶

The binary module from where the code was loaded.

Type: google.cloud.trace_v2.types.Module

source_version¶

The version of the deployed source code (up to 128 bytes).

Type: google.cloud.trace_v2.types.TruncatableString

class StackFrames(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A collection of stack frames, which can be truncated.

frame¶

Stack frames in this call stack.

Type: MutableSequence[google.cloud.trace_v2.types.StackTrace.StackFrame]

dropped_frames_count¶

The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.

Type: int

class google.cloud.trace_v2.types.TruncatableString(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

value¶

The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then value contains the first 128 bytes of the 500-byte string.

Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.

Type: str

truncated_byte_count¶

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

Type: int

Types for Google Cloud Trace v2 API¶

google-cloud-trace

Navigation

Related Topics