Index
TraceService
(interface)GetTraceRequest
(message)ListTracesRequest
(message)ListTracesRequest.ViewType
(enum)ListTracesResponse
(message)PatchTracesRequest
(message)Trace
(message)TraceSpan
(message)TraceSpan.SpanKind
(enum)Traces
(message)
TraceService
Service for collecting and viewing traces and spans within a trace.
A trace is a collection of spans. A trace can correspond 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.
GetTrace |
---|
Gets a single trace by its ID.
|
ListTraces |
---|
Returns a list of traces that match the specified filter conditions.
|
PatchTraces |
---|
Sends new traces to Cloud Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.
|
GetTraceRequest
The request message for the GetTrace
method.
Fields | |
---|---|
project_id |
Required. ID of the Cloud project where the trace data is stored. Authorization requires the following IAM permission on the specified resource
|
trace_id |
Required. ID of the trace to return. |
ListTracesRequest
The request message for the ListTraces
method. All fields are required unless specified.
Fields | |
---|---|
project_id |
Required. ID of the Cloud project where the trace data is stored. Authorization requires the following IAM permission on the specified resource
|
view |
Optional. Type of data returned for traces in the list. Default is |
page_size |
Optional. 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. |
page_token |
Token identifying the page of results to return. If provided, use the value of the |
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 |
Optional. A filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (
|
order_by |
Optional. Field used to sort the returned traces. Can be one of the following:
Descending order can be specified by appending Only one sort field is permitted. |
ViewType
Type of data returned for traces in the list.
Enums | |
---|---|
VIEW_TYPE_UNSPECIFIED |
Default is MINIMAL if unspecified. |
MINIMAL |
Minimal view of the trace record that contains only the project and trace IDs. |
ROOTSPAN |
Root span view of the trace record that returns the root spans along with the minimal trace data. |
COMPLETE |
Complete view of the trace record that contains the actual trace data. This is equivalent to calling the REST get or RPC GetTrace method using the ID of each listed trace. |
ListTracesResponse
The response message for the ListTraces
method.
Fields | |
---|---|
traces[] |
List of trace records as specified by the view parameter. |
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. |
PatchTracesRequest
The request message for the PatchTraces
method.
Fields | |
---|---|
project_id |
Required. ID of the Cloud project where the trace data is stored. Authorization requires the following IAM permission on the specified resource
|
traces |
Required. The body of the message. |
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.
Fields | |
---|---|
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. For example, |
spans[] |
Collection of spans in the trace. |
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.
Fields | |
---|---|
span_id |
Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, |
kind |
Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using |
name |
Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. 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 seconds and nanoseconds from the UNIX epoch. |
end_time |
End time of the span in seconds and nanoseconds from the UNIX epoch. |
parent_span_id |
Optional. ID of the parent span, if any. |
labels |
Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own. For more information, see Cloud Trace labels. |
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. |
RPC_SERVER |
Indicates that the span covers server-side handling of an RPC or other remote network request. |
RPC_CLIENT |
Indicates that the span covers the client-side wrapper around an RPC or other remote request. |
Traces
List of new or updated traces.
Fields | |
---|---|
traces[] |
List of traces. |