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. Spans for a single trace may span multiple services.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
TraceServiceClient(TraceServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TraceServiceClient const &
|
TraceServiceClient(TraceServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TraceServiceClient &&
|
TraceServiceClient(std::shared_ptr< TraceServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< TraceServiceConnection >
|
opts |
Options
|
Operators
operator=(TraceServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TraceServiceClient const &
|
Returns | |
---|---|
Type | Description |
TraceServiceClient & |
operator=(TraceServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TraceServiceClient &&
|
Returns | |
---|---|
Type | Description |
TraceServiceClient & |
Functions
ListTraces(std::string const &, Options)
Returns of a list of traces that match the specified filter conditions.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. ID of the Cloud project where the trace data is stored. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::devtools::cloudtrace::v1::Trace > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTraces(google::devtools::cloudtrace::v1::ListTracesRequest, Options)
Returns of a list of traces that match the specified filter conditions.
Parameters | |
---|---|
Name | Description |
request |
google::devtools::cloudtrace::v1::ListTracesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::devtools::cloudtrace::v1::Trace > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetTrace(std::string const &, std::string const &, Options)
Gets a single trace by its ID.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. ID of the Cloud project where the trace data is stored. |
trace_id |
std::string const &
Required. ID of the trace to return. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::devtools::cloudtrace::v1::Trace > |
the result of the RPC. The response message type (google.devtools.cloudtrace.v1.Trace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTrace(google::devtools::cloudtrace::v1::GetTraceRequest const &, Options)
Gets a single trace by its ID.
Parameters | |
---|---|
Name | Description |
request |
google::devtools::cloudtrace::v1::GetTraceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::devtools::cloudtrace::v1::Trace > |
the result of the RPC. The response message type (google.devtools.cloudtrace.v1.Trace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
PatchTraces(std::string const &, google::devtools::cloudtrace::v1::Traces const &, Options)
Sends new traces to Stackdriver 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.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. ID of the Cloud project where the trace data is stored. |
traces |
google::devtools::cloudtrace::v1::Traces const &
Required. The body of the message. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
PatchTraces(google::devtools::cloudtrace::v1::PatchTracesRequest const &, Options)
Sends new traces to Stackdriver 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.
Parameters | |
---|---|
Name | Description |
request |
google::devtools::cloudtrace::v1::PatchTracesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |