Types for Stackdriver Trace API Client#
-
class
google.cloud.trace_v2.types.
Any
# -
type_url
# Field google.protobuf.Any.type_url
-
value
# Field google.protobuf.Any.value
-
-
class
google.cloud.trace_v2.types.
AttributeValue
# The allowed types for [VALUE] in a
[KEY]:[VALUE]
attribute.-
value
# The type of the value.
-
string_value
# A string up to 256 bytes long.
-
int_value
# A 64-bit signed integer.
-
bool_value
# A Boolean value represented by
true
orfalse
.
-
bool_value
Field google.devtools.cloudtrace.v2.AttributeValue.bool_value
-
int_value
Field google.devtools.cloudtrace.v2.AttributeValue.int_value
-
string_value
Field google.devtools.cloudtrace.v2.AttributeValue.string_value
-
-
class
google.cloud.trace_v2.types.
BatchWriteSpansRequest
# The request message for the
BatchWriteSpans
method.-
name
# Required. The name of the project where the spans belong. The format is
projects/[PROJECT_ID]
.
-
spans
# A list of new spans. The span names must not match existing spans, or the results are undefined.
-
name
Field google.devtools.cloudtrace.v2.BatchWriteSpansRequest.name
-
spans
Field google.devtools.cloudtrace.v2.BatchWriteSpansRequest.spans
-
-
class
google.cloud.trace_v2.types.
Empty
#
-
class
google.cloud.trace_v2.types.
Module
# Binary module.
-
module
# For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
-
build_id
# A unique identifier for the module, usually a hash of its contents (up to 128 bytes).
-
build_id
Field google.devtools.cloudtrace.v2.Module.build_id
-
module
Field google.devtools.cloudtrace.v2.Module.module
-
-
class
google.cloud.trace_v2.types.
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 may be gaps or overlaps between spans in a trace.
-
name
# - 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.
-
span_id
# The [SPAN_ID] portion of the span’s resource name.
-
parent_span_id
# The [SPAN_ID] of this span’s parent span. If this is a root span, then this field must be empty.
-
display_name
# 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.
-
start_time
# 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
# 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
# A set of attributes on the span. You can have up to 32 attributes per span.
-
stack_trace
# Stack trace captured at the start of the span.
-
time_events
# A set of time events. You can have up to 32 annotations and 128 message events per span.
-
links
# Links associated with the span. You can have up to 128 links per Span.
-
status
# An optional final status for this span.
-
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, Stackdriver Trace is unable to take advantage of this helpful information.
-
child_span_count
# An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
-
class
Attributes
# A set of attributes, each in the format
[KEY]:[VALUE]
.-
attribute_map
# 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
andfalse
. For example: :: “/instance_id”: “my-instance” “/http/user_agent”: “” “/http/request_bytes”: 300 “abc.com/myattribute”: true
-
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.
-
class
AttributeMapEntry
# -
key
# Field google.devtools.cloudtrace.v2.Span.Attributes.AttributeMapEntry.key
-
value
# Field google.devtools.cloudtrace.v2.Span.Attributes.AttributeMapEntry.value
-
-
attribute_map
Field google.devtools.cloudtrace.v2.Span.Attributes.attribute_map
-
dropped_attributes_count
Field google.devtools.cloudtrace.v2.Span.Attributes.dropped_attributes_count
-
-
class
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.
-
trace_id
# The [TRACE_ID] for a trace within a project.
-
span_id
# The [SPAN_ID] for a span within a trace.
-
type
# The relationship of the current span relative to the linked span.
-
attributes
# A set of attributes on the link. You have have up to 32 attributes per link.
-
attributes
Field google.devtools.cloudtrace.v2.Span.Link.attributes
-
span_id
Field google.devtools.cloudtrace.v2.Span.Link.span_id
-
trace_id
Field google.devtools.cloudtrace.v2.Span.Link.trace_id
-
type
Field google.devtools.cloudtrace.v2.Span.Link.type
-
-
class
Links
# A collection of links, which are references from this span to a span in the same or different trace.
-
link
# A collection of links.
-
dropped_links_count
# The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
-
dropped_links_count
Field google.devtools.cloudtrace.v2.Span.Links.dropped_links_count
-
link
Field google.devtools.cloudtrace.v2.Span.Links.link
-
-
class
TimeEvent
# A time-stamped annotation or message event in the Span.
-
time
# The timestamp indicating the time the event occurred.
-
value
# A
TimeEvent
can contain either anAnnotation
object or aMessageEvent
object, but not both.
-
annotation
# Text annotation with a set of attributes.
-
message_event
# An event describing a message sent/received between Spans.
-
class
Annotation
# Text annotation with a set of attributes.
-
description
# A user-supplied message describing the event. The maximum length for the description is 256 bytes.
-
attributes
# A set of attributes on the annotation. You can have up to 4 attributes per Annotation.
-
attributes
Field google.devtools.cloudtrace.v2.Span.TimeEvent.Annotation.attributes
-
description
Field google.devtools.cloudtrace.v2.Span.TimeEvent.Annotation.description
-
-
class
MessageEvent
# An event describing a message sent/received between Spans.
-
type
# Type of MessageEvent. Indicates whether the message was sent or received.
-
id
# 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.
-
uncompressed_size_bytes
# The number of uncompressed bytes sent or received.
-
compressed_size_bytes
# The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.
-
compressed_size_bytes
Field google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent.compressed_size_bytes
-
id
Field google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent.id
-
type
Field google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent.type
-
uncompressed_size_bytes
Field google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent.uncompressed_size_bytes
-
-
annotation
Field google.devtools.cloudtrace.v2.Span.TimeEvent.annotation
-
message_event
Field google.devtools.cloudtrace.v2.Span.TimeEvent.message_event
-
time
Field google.devtools.cloudtrace.v2.Span.TimeEvent.time
-
-
class
TimeEvents
# A collection of
TimeEvent
s. ATimeEvent
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
TimeEvent
s.
-
dropped_annotations_count
# 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
# The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.
-
dropped_annotations_count
Field google.devtools.cloudtrace.v2.Span.TimeEvents.dropped_annotations_count
-
dropped_message_events_count
Field google.devtools.cloudtrace.v2.Span.TimeEvents.dropped_message_events_count
-
time_event
Field google.devtools.cloudtrace.v2.Span.TimeEvents.time_event
-
-
attributes
Field google.devtools.cloudtrace.v2.Span.attributes
-
child_span_count
Field google.devtools.cloudtrace.v2.Span.child_span_count
-
display_name
Field google.devtools.cloudtrace.v2.Span.display_name
-
end_time
Field google.devtools.cloudtrace.v2.Span.end_time
-
links
Field google.devtools.cloudtrace.v2.Span.links
-
name
Field google.devtools.cloudtrace.v2.Span.name
-
parent_span_id
Field google.devtools.cloudtrace.v2.Span.parent_span_id
-
same_process_as_parent_span
Field google.devtools.cloudtrace.v2.Span.same_process_as_parent_span
-
span_id
Field google.devtools.cloudtrace.v2.Span.span_id
-
stack_trace
Field google.devtools.cloudtrace.v2.Span.stack_trace
-
start_time
Field google.devtools.cloudtrace.v2.Span.start_time
-
status
Field google.devtools.cloudtrace.v2.Span.status
-
time_events
Field google.devtools.cloudtrace.v2.Span.time_events
-
-
class
google.cloud.trace_v2.types.
StackTrace
# A call stack appearing in a trace.
-
stack_frames
# Stack frames in this stack trace. A maximum of 128 frames are allowed.
-
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 instackTraceHashId
. Subsequent spans within the same request can refer to that stack trace by only settingstackTraceHashId
.
-
class
StackFrame
# 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).
-
original_function_name
# An un-mangled function name, if
function_name
is mangled. The name can be fully-qualified (up to 1024 bytes).
-
file_name
# The name of the source file where the function call appears (up to 256 bytes).
-
line_number
# The line number in
file_name
where the function call appears.
-
column_number
# The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.
-
load_module
# The binary module from where the code was loaded.
-
source_version
# The version of the deployed source code (up to 128 bytes).
-
column_number
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.column_number
-
file_name
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.file_name
-
function_name
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.function_name
-
line_number
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.line_number
-
load_module
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.load_module
-
original_function_name
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.original_function_name
-
source_version
Field google.devtools.cloudtrace.v2.StackTrace.StackFrame.source_version
-
-
class
StackFrames
# A collection of stack frames, which can be truncated.
-
frame
# Stack frames in this call stack.
-
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.
-
dropped_frames_count
Field google.devtools.cloudtrace.v2.StackTrace.StackFrames.dropped_frames_count
-
frame
Field google.devtools.cloudtrace.v2.StackTrace.StackFrames.frame
-
-
stack_frames
Field google.devtools.cloudtrace.v2.StackTrace.stack_frames
-
stack_trace_hash_id
Field google.devtools.cloudtrace.v2.StackTrace.stack_trace_hash_id
-
-
class
google.cloud.trace_v2.types.
Status
# -
code
# Field google.rpc.Status.code
-
details
# Field google.rpc.Status.details
-
message
# Field google.rpc.Status.message
-
-
class
google.cloud.trace_v2.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.trace_v2.types.
TruncatableString
# 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.
-
truncated_byte_count
# The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
-
truncated_byte_count
Field google.devtools.cloudtrace.v2.TruncatableString.truncated_byte_count
-
value
Field google.devtools.cloudtrace.v2.TruncatableString.value
-