Struct OpenTelemetryTracingOption (2.20.0-rc)

Enables tracing with OpenTelemetry

Setting this option enables the generation of traces by the client library. The library uses the global tracer provider to generate traces.

Prerequisites

The library must be compiled with OpenTelemetry in order for this option to take effect.

See Also

The OpenTelemetry tracing quickstart for instructions on how to compile google-cloud-cpp with opentelemetry-cpp.

Effect

Setting this option enables the generation of traces by the client library. The library uses the global tracer provider to generate traces. To create a client that traces, this option must be provided to the Make*Connection(...) factory functions. It does not have an effect when passed to a client's constructor. If you use custom credentials, this option must also be provided to the Make*Credentials(...) factory functions in order to trace the authentication components.

Exporting traces

Providing this option only enables the generation of traces. It does not enable the export of traces. In order to export the traces, the application must set the global tracer provider. The client library recommends using #google::cloud::otel::ConfigureBasicTracing() to configure the global tracer provider. This will send the traces generated by the client library to Cloud Trace, Google Cloud's visualizer for distributed traces.

See Also

Google Cloud C++ OpenTelemetry reference docs.

Environment variable

This option is controlled by the GOOGLE_CLOUD_CPP_OPENTELEMETRY_TRACING environment variable. If the environment variable is set to a non-empty value, tracing with OpenTelemetry is enabled.

Type Aliases

Type

Alias Of: bool