Types for Stackdriver Trace API Client#
-
class
google.cloud.trace_v1.types.
Empty
#
-
class
google.cloud.trace_v1.types.
GetTraceRequest
# The request message for the
GetTrace
method.-
project_id
# ID of the Cloud project where the trace data is stored.
-
trace_id
# ID of the trace to return.
-
project_id
Field google.devtools.cloudtrace.v1.GetTraceRequest.project_id
-
trace_id
Field google.devtools.cloudtrace.v1.GetTraceRequest.trace_id
-
-
class
google.cloud.trace_v1.types.
ListTracesRequest
# The request message for the
ListTraces
method. All fields are required unless specified.-
project_id
# ID of the Cloud project where the trace data is stored.
-
view
# Type of data returned for traces in the list. Optional. Default is
MINIMAL
.
-
page_size
# Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
-
page_token
# Token identifying the page of results to return. If provided, use the value of the
next_page_token
field from a previous request. Optional.
-
start_time
# Start of the time interval (inclusive) during which the trace data was collected from the application.
-
end_time
# End of the time interval (inclusive) during which the trace data was collected from the application.
-
filter
# An optional filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (
+
) to the search term. Multiple terms are ANDed. Syntax: -root:NAME_PREFIX
orNAME_PREFIX
: Return traces where any root span starts withNAME_PREFIX
. -+root:NAME
or+NAME
: Return traces where any root span’s name is exactlyNAME
. -span:NAME_PREFIX
: Return traces where any span starts withNAME_PREFIX
. -+span:NAME
: Return traces where any span’s name is exactlyNAME
. -latency:DURATION
: Return traces whose overall latency is greater or equal to thanDURATION
. Accepted units are nanoseconds (ns
), milliseconds (ms
), and seconds (s
). Default isms
. For example,latency:24ms
returns traces whose overall latency is greater than or equal to 24 milliseconds. -label:LABEL_KEY
: Return all traces containing the specified label key (exact match, case- sensitive) regardless of the key:value pair’s value (including empty values). -LABEL_KEY:VALUE_PREFIX
: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts withVALUE_PREFIX
. Both a key and a value must be specified. -+LABEL_KEY:VALUE
: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. -method:VALUE
: Equivalent to/http/method:VALUE
. -url:VALUE
: Equivalent to/http/url:VALUE
.
-
order_by
# Field used to sort the returned traces. Optional. Can be one of the following: -
trace_id
-name
(name
field of root span in the trace) -duration
(difference betweenend_time
andstart_time
fields of the root span) -start
(start_time
field of the root span) Descending order can be specified by appendingdesc
to the sort field (for example,name desc
). Only one sort field is permitted.
-
end_time
Field google.devtools.cloudtrace.v1.ListTracesRequest.end_time
-
filter
Field google.devtools.cloudtrace.v1.ListTracesRequest.filter
-
order_by
Field google.devtools.cloudtrace.v1.ListTracesRequest.order_by
-
page_size
Field google.devtools.cloudtrace.v1.ListTracesRequest.page_size
-
page_token
Field google.devtools.cloudtrace.v1.ListTracesRequest.page_token
-
project_id
Field google.devtools.cloudtrace.v1.ListTracesRequest.project_id
-
start_time
Field google.devtools.cloudtrace.v1.ListTracesRequest.start_time
-
view
Field google.devtools.cloudtrace.v1.ListTracesRequest.view
-
-
class
google.cloud.trace_v1.types.
ListTracesResponse
# The response message for the
ListTraces
method.-
traces
# List of trace records returned.
-
next_page_token
# If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.
-
next_page_token
Field google.devtools.cloudtrace.v1.ListTracesResponse.next_page_token
-
traces
Field google.devtools.cloudtrace.v1.ListTracesResponse.traces
-
-
class
google.cloud.trace_v1.types.
PatchTracesRequest
# The request message for the
PatchTraces
method.-
project_id
# ID of the Cloud project where the trace data is stored.
-
traces
# The body of the message.
-
project_id
Field google.devtools.cloudtrace.v1.PatchTracesRequest.project_id
-
traces
Field google.devtools.cloudtrace.v1.PatchTracesRequest.traces
-
-
class
google.cloud.trace_v1.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.trace_v1.types.
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.
-
project_id
# Project ID of the Cloud project where the trace data is stored.
-
trace_id
# Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
-
spans
# Collection of spans in the trace.
-
project_id
Field google.devtools.cloudtrace.v1.Trace.project_id
-
spans
Field google.devtools.cloudtrace.v1.Trace.spans
-
trace_id
Field google.devtools.cloudtrace.v1.Trace.trace_id
-
-
class
google.cloud.trace_v1.types.
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.
-
span_id
# Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace.
-
kind
# Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using
RPC_CLIENT
andRPC_SERVER
to identify queueing latency associated with the span.
-
name
# Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the {% dynamic print site_values.console_name %}. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
-
start_time
# Start time of the span in nanoseconds from the UNIX epoch.
-
end_time
# End time of the span in nanoseconds from the UNIX epoch.
-
parent_span_id
# ID of the parent span, if any. Optional.
-
labels
# Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for
/stacktrace
values). Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats: -/category/product/key
for agents of well-known products (e.g./db/mongodb/read_size
). -short_host/path/key
for domain-specific keys (e.g.foo.com/myproduct/bar
) Predefined labels include: -/agent
-/component
-/error/message
-/error/name
-/http/client_city
-/http/client_country
-/http/client_protocol
-/http/client_region
-/http/host
-/http/method
-/http/path
-/http/redirected_url
-/http/request/size
-/http/response/size
-/http/route
-/http/status_code
-/http/url
-/http/user_agent
-/pid
-/stacktrace
-/tid
-
class
LabelsEntry
# -
key
# Field google.devtools.cloudtrace.v1.TraceSpan.LabelsEntry.key
-
value
# Field google.devtools.cloudtrace.v1.TraceSpan.LabelsEntry.value
-
-
end_time
Field google.devtools.cloudtrace.v1.TraceSpan.end_time
-
kind
Field google.devtools.cloudtrace.v1.TraceSpan.kind
-
labels
Field google.devtools.cloudtrace.v1.TraceSpan.labels
-
name
Field google.devtools.cloudtrace.v1.TraceSpan.name
-
parent_span_id
Field google.devtools.cloudtrace.v1.TraceSpan.parent_span_id
-
span_id
Field google.devtools.cloudtrace.v1.TraceSpan.span_id
-
start_time
Field google.devtools.cloudtrace.v1.TraceSpan.start_time
-