google-cloud-cpp icon indicating copy to clipboard operation
google-cloud-cpp copied to clipboard

Rename options named tracing that do logging

Open dbolduc opened this issue 1 year ago • 0 comments

Googlers can see: go/cloud-cxx:s-slash-tracing-logging-options


I say we adopt OpenTelemetry’s naming scheme for our telemetry interfaces. This basically means s/Tracing/Logging/ for these types.

We will introduce new types using “Logging” instead of “Tracing”. We will leave using declarations for the old types, for backwards compatibility. We will also mark the old types as deprecated.

This looks like:

  • introducing g::c::LoggingComponentsOption, to replace g::c::TracingComponentsOption.
  • introducing g::c::LoggingFormat, to replace g::c::TracingOptions.
  • introducing g::c::LoggingFormatOption, (in common) to replace g::c::GrpcTracingOptionsOption and g::c::RestTracingOptionsOption.
  • introducing GOOGLE_CLOUD_CPP_ENABLE_LOGGING, GOOGLE_CLOUD_CPP_LOGGING_FORMAT to replace the old ones. We still respect the legacy environment variables for backwards compatibility, but we purge our docs of them.

We will need to do a pass on the public docs referencing the old types / old env vars.

We also need to look into legacy GCS env var: CLOUD_STORAGE_TRACING

dbolduc avatar May 21 '24 21:05 dbolduc