Package google.devtools.cloudtrace.v2

Index

TraceService (interface)
AttributeValue (message)
BatchWriteSpansRequest (message)
Module (message)
Span (message)
Span.Attributes (message)
Span.Link (message)
Span.Link.Type (enum)
Span.Links (message)
Span.SpanKind (enum)
Span.TimeEvent (message)
Span.TimeEvent.Annotation (message)
Span.TimeEvent.MessageEvent (message)
Span.TimeEvent.MessageEvent.Type (enum)
Span.TimeEvents (message)
StackTrace (message)
StackTrace.StackFrame (message)
StackTrace.StackFrames (message)
TruncatableString (message)

TraceService

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.

BatchWriteSpans

BatchWriteSpans
`rpc BatchWriteSpans(BatchWriteSpansRequest) returns (Empty)` Batch writes new spans to new or existing traces. You cannot update existing spans. Authorization scopes Requires one of the following OAuth scopes: `https://www.googleapis.com/auth/trace.append` `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc BatchWriteSpans(BatchWriteSpansRequest) returns (Empty)

Batch writes new spans to new or existing traces. You cannot update existing spans.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/trace.append
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateSpan

CreateSpan
`rpc CreateSpan(Span) returns (Span)` Creates a new span. Authorization scopes Requires one of the following OAuth scopes: `https://www.googleapis.com/auth/trace.append` `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc CreateSpan(Span) returns (Span)

Creates a new span.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/trace.append
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AttributeValue

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

Fields
Union field `value`. The type of the value. `value` can be only one of the following:
`string_value`	`TruncatableString` A string up to 256 bytes long.
`int_value`	`int64` A 64-bit signed integer.
`bool_value`	`bool` A Boolean value represented by `true` or `false`.

BatchWriteSpansRequest

The request message for the BatchWriteSpans method.

Fields

Fields
`name`	`string` Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`. Authorization requires the following IAM permission on the specified resource `name`: `cloudtrace.traces.patch`
`spans[]`	`Span` Required. A list of new spans. The span names must not match existing spans, otherwise the results are undefined.

name

string

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

Authorization requires the following IAM permission on the specified resource name:

cloudtrace.traces.patch

spans[]

Span

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

Module

Binary module.

Fields

Fields
`module`	`TruncatableString` For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
`build_id`	`TruncatableString` A unique identifier for the module, usually a hash of its contents (up to 128 bytes).

module

TruncatableString

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

build_id

TruncatableString

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

Fields
`name`	`string` 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. . Authorization requires the following IAM permission on the specified resource `name`: `cloudtrace.traces.patch`
`span_id`	`string` Required. The `[SPAN_ID]` portion of the span's resource name.
`parent_span_id`	`string` The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty.
`display_name`	`TruncatableString` 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.
`start_time`	`Timestamp` 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.
`end_time`	`Timestamp` 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.
`attributes`	`Attributes` A set of attributes on the span. You can have up to 32 attributes per span.
`stack_trace`	`StackTrace` Stack trace captured at the start of the span.
`time_events`	`TimeEvents` A set of time events. You can have up to 32 annotations and 128 message events per span.
`links`	`Links` Links associated with the span. You can have up to 128 links per Span.
`status`	`Status` Optional. The final status for this span.
`same_process_as_parent_span`	`BoolValue` 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.
`child_span_count`	`Int32Value` Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
`span_kind`	`SpanKind` 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.

Attributes

A set of attributes as key-value pairs.

Fields

Fields
`attribute_map`	`map<string, AttributeValue>` 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 } "example.com/myattribute": { "bool_value": false }`
`dropped_attributes_count`	`int32` 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.

attribute_map

map<string, AttributeValue>

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 }
"example.com/myattribute": { "bool_value": false }

dropped_attributes_count

int32

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.

Link

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.

Fields
`trace_id`	`string` The `[TRACE_ID]` for a trace within a project.
`span_id`	`string` The `[SPAN_ID]` for a span within a trace.
`type`	`Type` The relationship of the current span relative to the linked span.
`attributes`	`Attributes` A set of attributes on the link. Up to 32 attributes can be specified per link.

Type

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

Enums
`TYPE_UNSPECIFIED`	The relationship of the two spans is unknown.
`CHILD_LINKED_SPAN`	The linked span is a child of the current span.
`PARENT_LINKED_SPAN`	The linked span is a parent of the current span.

Links

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

Fields

Fields
`link[]`	`Link` A collection of links.
`dropped_links_count`	`int32` The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.

link[]

Link

A collection of links.

dropped_links_count

int32

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

SpanKind

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

Enums
`SPAN_KIND_UNSPECIFIED`	Unspecified. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default.
`INTERNAL`	Indicates that the span is used internally. Default value.
`SERVER`	Indicates that the span covers server-side handling of an RPC or other remote network request.
`CLIENT`	Indicates that the span covers the client-side wrapper around an RPC or other remote request.
`PRODUCER`	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`	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).

TimeEvent

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

Fields
`time`	`Timestamp` The timestamp indicating the time the event occurred.
Union field `value`. A `TimeEvent` can contain either an `Annotation` object or a `MessageEvent` object, but not both. `value` can be only one of the following:
`annotation`	`Annotation` Text annotation with a set of attributes.
`message_event`	`MessageEvent` An event describing a message sent/received between Spans.

Annotation

Text annotation with a set of attributes.

Fields

Fields
`description`	`TruncatableString` A user-supplied message describing the event. The maximum length for the description is 256 bytes.
`attributes`	`Attributes` A set of attributes on the annotation. You can have up to 4 attributes per Annotation.

description

TruncatableString

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

attributes

Attributes

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

MessageEvent

An event describing a message sent/received between Spans.

Fields
`type`	`Type` Type of MessageEvent. Indicates whether the message was sent or received.
`id`	`int64` An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents.
`uncompressed_size_bytes`	`int64` The number of uncompressed bytes sent or received.
`compressed_size_bytes`	`int64` 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

Indicates whether the message was sent or received.

Enums
`TYPE_UNSPECIFIED`	Unknown event type.
`SENT`	Indicates a sent message.
`RECEIVED`	Indicates a received message.

TimeEvents

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.

Fields

Fields
`time_event[]`	`TimeEvent` A collection of `TimeEvent`s.
`dropped_annotations_count`	`int32` The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.
`dropped_message_events_count`	`int32` The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.

time_event[]

TimeEvent

A collection of TimeEvents.

dropped_annotations_count

int32

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

dropped_message_events_count

int32

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

StackTrace

A call stack appearing in a trace.

Fields

Fields
`stack_frames`	`StackFrames` Stack frames in this stack trace. A maximum of 128 frames are allowed.
`stack_trace_hash_id`	`int64` 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`.

stack_frames

StackFrames

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

stack_trace_hash_id

int64

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.

StackFrame

Represents a single stack frame in a stack trace.

Fields
`function_name`	`TruncatableString` The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).
`original_function_name`	`TruncatableString` 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).
`file_name`	`TruncatableString` The name of the source file where the function call appears (up to 256 bytes).
`line_number`	`int64` The line number in `file_name` where the function call appears.
`column_number`	`int64` The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.
`load_module`	`Module` The binary module from where the code was loaded.
`source_version`	`TruncatableString` The version of the deployed source code (up to 128 bytes).

StackFrames

A collection of stack frames, which can be truncated.

Fields

Fields
`frame[]`	`StackFrame` Stack frames in this call stack.
`dropped_frames_count`	`int32` 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.

frame[]

StackFrame

Stack frames in this call stack.

dropped_frames_count

int32

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.

TruncatableString

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

Fields

Fields
`value`	`string` 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.
`truncated_byte_count`	`int32` The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

value

string

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.

truncated_byte_count

int32

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