package google.devtools.cloudtrace.v2

Get desktop application:
View/edit binary Protocol Buffers messages

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. A single trace may contain span(s) from multiple services.

• rpc BatchWriteSpans (BatchWriteSpansRequest, protobuf.Empty)

  tracing.proto:39

  Sends new spans to new or existing traces. You cannot update existing spans.

  message BatchWriteSpansRequest

  tracing.proto:56

  The request message for the `BatchWriteSpans` method.

  • string name = 1

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

  • repeated Span spans = 2

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

• rpc CreateSpan (Span, Span)

  tracing.proto:47

  Creates a new span.

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

Used in: Span.Attributes

• oneof value

  The type of the value.

  • TruncatableString string_value = 1

    A string up to 256 bytes long.

  • int64 int_value = 2

    A 64-bit signed integer.

  • bool bool_value = 3

    A Boolean value represented by `true` or `false`.

Binary module.

Used in: StackTrace.StackFrame

• optional TruncatableString module = 1

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

• optional TruncatableString build_id = 2

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

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

Used as request type in: TraceService.CreateSpan

Used as response type in: TraceService.CreateSpan

Used as field type in: BatchWriteSpansRequest

• string name = 1

  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. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

• string span_id = 2

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

• string parent_span_id = 3

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

• optional TruncatableString display_name = 4

  A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the {% dynamic print site_values.console_name %}. 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.

• optional protobuf.Timestamp start_time = 5

  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.

• optional protobuf.Timestamp end_time = 6

  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.

• optional Span.Attributes attributes = 7

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

• optional StackTrace stack_trace = 8

  Stack trace captured at the start of the span.

• optional Span.TimeEvents time_events = 9

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

• optional Span.Links links = 10

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

• optional rpc.Status status = 11

  An optional final status for this span.

• optional protobuf.BoolValue same_process_as_parent_span = 12

  (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.

• optional protobuf.Int32Value child_span_count = 13

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

A set of attributes, each in the format `[KEY]:[VALUE]`.

Used in: Span, Link, TimeEvent.Annotation

• map<string, AttributeValue> attribute_map = 1

  The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, an integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true

• int32 dropped_attributes_count = 2

  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.

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.

Used in: Links

• string trace_id = 1

  The [TRACE_ID] for a trace within a project.

• string span_id = 2

  The [SPAN_ID] for a span within a trace.

• Link.Type type = 3

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

• optional Attributes attributes = 4

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

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

Used in: Link

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

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

Used in: Span

• repeated Link link = 1

  A collection of links.

• int32 dropped_links_count = 2

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

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

Used in: TimeEvents

• optional protobuf.Timestamp time = 1

  The timestamp indicating the time the event occurred.

• oneof value

  A `TimeEvent` can contain either an `Annotation` object or a `MessageEvent` object, but not both.

  • TimeEvent.Annotation annotation = 2

    Text annotation with a set of attributes.

  • TimeEvent.MessageEvent message_event = 3

    An event describing a message sent/received between Spans.

Text annotation with a set of attributes.

Used in: TimeEvent

• optional TruncatableString description = 1

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

• optional Attributes attributes = 2

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

An event describing a message sent/received between Spans.

Used in: TimeEvent

• MessageEvent.Type type = 1

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

• int64 id = 2

  An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.

• int64 uncompressed_size_bytes = 3

  The number of uncompressed bytes sent or received.

• int64 compressed_size_bytes = 4

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

Indicates whether the message was sent or received.

Used in: MessageEvent

• TYPE_UNSPECIFIED = 0

  Unknown event type.

• SENT = 1

  Indicates a sent message.

• RECEIVED = 2

  Indicates a received message.

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.

Used in: Span

• repeated TimeEvent time_event = 1

  A collection of `TimeEvent`s.

• int32 dropped_annotations_count = 2

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

• int32 dropped_message_events_count = 3

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

A call stack appearing in a trace.

Used in: Span

• optional StackTrace.StackFrames stack_frames = 1

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

• int64 stack_trace_hash_id = 2

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

Represents a single stack frame in a stack trace.

Used in: StackFrames

• optional TruncatableString function_name = 1

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

• optional TruncatableString original_function_name = 2

  An un-mangled function name, if `function_name` is [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can be fully-qualified (up to 1024 bytes).

• optional TruncatableString file_name = 3

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

• int64 line_number = 4

  The line number in `file_name` where the function call appears.

• int64 column_number = 5

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

• optional Module load_module = 6

  The binary module from where the code was loaded.

• optional TruncatableString source_version = 7

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

A collection of stack frames, which can be truncated.

Used in: StackTrace

• repeated StackFrame frame = 1

  Stack frames in this call stack.

• int32 dropped_frames_count = 2

  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.

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

Used in: AttributeValue, Module, Span, Span.TimeEvent.Annotation, StackTrace.StackFrame

• string value = 1

  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.

• int32 truncated_byte_count = 2

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