feat(otel): promote OpenTelemetryTracingOption to GA (#12728)

Author: dbolduc

ci/abi-dumps/google_cloud_cpp_common.expected.abi.dump.gz

@@ -76,7 +76,7 @@ void EndSpan(opentelemetry::trace::Span& span) { EndSpanImpl(span, Status{}); }
 
 #ifdef GOOGLE_CLOUD_CPP_HAVE_OPENTELEMETRY
 bool TracingEnabled(Options const& options) {
-  return options.get<experimental::OpenTelemetryTracingOption>();
+  return options.get<OpenTelemetryTracingOption>();
 }
 #else
 bool TracingEnabled(Options const&) { return false; }

google/cloud/internal/opentelemetry.cc

@@ -277,10 +277,10 @@ TEST(OpenTelemetry, TracingEnabled) {
   auto options = Options{};
   EXPECT_FALSE(TracingEnabled(options));
 
-  options.set<experimental::OpenTelemetryTracingOption>(false);
+  options.set<OpenTelemetryTracingOption>(false);
   EXPECT_FALSE(TracingEnabled(options));
 
-  options.set<experimental::OpenTelemetryTracingOption>(true);
+  options.set<OpenTelemetryTracingOption>(true);
   EXPECT_TRUE(TracingEnabled(options));
 }
 

google/cloud/internal/opentelemetry_test.cc

@@ -61,7 +61,7 @@ Options PopulateCommonOptions(Options opts, std::string const& endpoint_env_var,
 
   e = GetEnv("GOOGLE_CLOUD_CPP_OPENTELEMETRY_TRACING");
   if (e && !e->empty()) {
-    opts.set<experimental::OpenTelemetryTracingOption>(true);
+    opts.set<OpenTelemetryTracingOption>(true);
   }
   if (!opts.has<TracingComponentsOption>()) {
     opts.set<TracingComponentsOption>(DefaultTracingComponents());
@@ -81,9 +81,9 @@ std::set<std::string> DefaultTracingComponents() {
 
 Options MakeAuthOptions(Options const& options) {
   Options opts;
-  if (options.has<experimental::OpenTelemetryTracingOption>()) {
-    opts.set<experimental::OpenTelemetryTracingOption>(
-        options.get<experimental::OpenTelemetryTracingOption>());
+  if (options.has<OpenTelemetryTracingOption>()) {
+    opts.set<OpenTelemetryTracingOption>(
+        options.get<OpenTelemetryTracingOption>());
   }
   return opts;
 }

google/cloud/internal/populate_common_options.cc

@@ -132,13 +132,11 @@ TEST(PopulateCommonOptions, OpenTelemetryTracing) {
       {"", false},
       {"ON", true},
   };
-  auto const input =
-      Options{}.set<experimental::OpenTelemetryTracingOption>(false);
+  auto const input = Options{}.set<OpenTelemetryTracingOption>(false);
   for (auto const& test : tests) {
     ScopedEnvironment env("GOOGLE_CLOUD_CPP_OPENTELEMETRY_TRACING", test.env);
     auto options = PopulateCommonOptions(input, {}, {}, {}, {});
-    EXPECT_EQ(options.get<experimental::OpenTelemetryTracingOption>(),
-              test.value);
+    EXPECT_EQ(options.get<OpenTelemetryTracingOption>(), test.value);
   }
 }
 
@@ -158,16 +156,16 @@ TEST(MakeAuthOptions, WithoutTracing) {
   auto options = Options{}.set<EndpointOption>("endpoint_option");
   auto auth_options = MakeAuthOptions(options);
   EXPECT_FALSE(auth_options.has<EndpointOption>());
-  EXPECT_FALSE(auth_options.get<experimental::OpenTelemetryTracingOption>());
+  EXPECT_FALSE(auth_options.get<OpenTelemetryTracingOption>());
 }
 
 TEST(MakeAuthOptions, WithTracing) {
   auto options = Options{}
                      .set<EndpointOption>("endpoint_option")
-                     .set<experimental::OpenTelemetryTracingOption>(true);
+                     .set<OpenTelemetryTracingOption>(true);
   auto auth_options = MakeAuthOptions(options);
   EXPECT_FALSE(auth_options.has<EndpointOption>());
-  EXPECT_TRUE(auth_options.get<experimental::OpenTelemetryTracingOption>());
+  EXPECT_TRUE(auth_options.get<OpenTelemetryTracingOption>());
 }
 
 }  // namespace

google/cloud/internal/populate_common_options_test.cc

@@ -46,8 +46,7 @@ int main(int argc, char* argv[]) {
   auto configuration = gc::otel::ConfigureBasicTracing(project);
 
   // Create a client with OpenTelemetry tracing enabled.
-  auto options =
-      gc::Options{}.set<gc::experimental::OpenTelemetryTracingOption>(true);
+  auto options = gc::Options{}.set<gc::OpenTelemetryTracingOption>(true);
   auto client = gcs::Client(options);
 
   auto writer = client.WriteObject(bucket_name, "quickstart.txt");

google/cloud/opentelemetry/README.md

@@ -36,8 +36,7 @@ int main(int argc, char* argv[]) {
   auto configuration = gc::otel::ConfigureBasicTracing(project);
 
   // Create a client with OpenTelemetry tracing enabled.
-  auto options =
-      gc::Options{}.set<gc::experimental::OpenTelemetryTracingOption>(true);
+  auto options = gc::Options{}.set<gc::OpenTelemetryTracingOption>(true);
   auto client = gcs::Client(options);
 
   auto writer = client.WriteObject(bucket_name, "quickstart.txt");

google/cloud/opentelemetry/quickstart/quickstart.cc

@@ -20,7 +20,6 @@
 namespace google {
 namespace cloud {
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
-namespace experimental {
 
 /**
  * Enables tracing with [OpenTelemetry]
@@ -79,6 +78,9 @@ struct OpenTelemetryTracingOption {
   using Type = bool;
 };
 
+namespace experimental {
+/// @deprecated Use google::cloud::OpenTelemetryTracingOption instead.
+using OpenTelemetryTracingOption = ::google::cloud::OpenTelemetryTracingOption;
 }  // namespace experimental
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 }  // namespace cloud

google/cloud/opentelemetry_options.h

@@ -172,12 +172,12 @@ std::shared_ptr<SpanCatcher> InstallSpanCatcher() {
 }
 
 Options EnableTracing(Options options) {
-  options.set<experimental::OpenTelemetryTracingOption>(true);
+  options.set<OpenTelemetryTracingOption>(true);
   return options;
 }
 
 Options DisableTracing(Options options) {
-  options.set<experimental::OpenTelemetryTracingOption>(false);
+  options.set<OpenTelemetryTracingOption>(false);
   return options;
 }