Class TraceServiceClient (2.28.0)

Service for collecting and viewing traces and spans within a trace.

A trace is a collection of spans corresponding 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.

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

BatchWriteSpans(std::string const &, std::vector< google::devtools::cloudtrace::v2::Span > const &, Options)

Batch writes new spans to new or existing traces.

You cannot update existing spans.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`.
`spans`	`std::vector< google::devtools::cloudtrace::v2::Span > const &` Required. A list of new spans. The span names must not match existing spans, otherwise the results are undefined.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

BatchWriteSpans(google::devtools::cloudtrace::v2::BatchWriteSpansRequest const &, Options)

Batch writes new spans to new or existing traces.

You cannot update existing spans.

Parameters
Name	Description
`request`	`google::devtools::cloudtrace::v2::BatchWriteSpansRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.cloudtrace.v2.BatchWriteSpansRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateSpan(google::devtools::cloudtrace::v2::Span const &, Options)

Creates a new span.

Parameters
Name	Description
`request`	`google::devtools::cloudtrace::v2::Span const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.cloudtrace.v2.Span. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::devtools::cloudtrace::v2::Span >`	the result of the RPC. The response message type (google.devtools.cloudtrace.v2.Span) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.