feat(otel): GA for cmake (#12735)

dbolduc · web-flow · commit 885b2b3da7be · 2023-09-27T11:41:31.000-04:00
diff --git a/ci/cloudbuild/builds/cmake-install.sh b/ci/cloudbuild/builds/cmake-install.sh
@@ -201,7 +201,7 @@ env -C "${out_dir}" ctest "${ctest_args[@]}"
 # shellcheck disable=SC2046
 feature_list="$(printf "%s;" $(features::libraries))"
 # GCS+gRPC and OpenTelemetry also have quickstarts.
-feature_list="${feature_list}experimental-storage_grpc;experimental-opentelemetry"
+feature_list="${feature_list}experimental-storage_grpc;opentelemetry"
 cmake -G Ninja \
   -S "${PROJECT_ROOT}/ci/verify_quickstart" \
   -B "${PROJECT_ROOT}/cmake-out/quickstart" \
diff --git a/ci/cloudbuild/builds/lib/features.sh b/ci/cloudbuild/builds/lib/features.sh
@@ -39,7 +39,7 @@ function features::always_build() {
     logging
     # Build our code with OpenTelemetry. This feature includes both the client
     # library instrumentation, and the GCP exporters.
-    experimental-opentelemetry
+    opentelemetry
     # Enable storage_grpc in most builds.
     experimental-storage_grpc
   )
@@ -62,10 +62,10 @@ function features::libraries() {
 function features::list_full() {
   local feature_list
   mapfile -t feature_list < <(features::libraries)
-  feature_list+=(experimental-opentelemetry experimental-storage_grpc grafeas)
+  feature_list+=(opentelemetry experimental-storage_grpc grafeas)
   printf "%s\n" "${feature_list[@]}" | sort -u
 }
 
 function features::list_full_cmake() {
-  echo "__ga_libraries__,__experimental_libraries__,experimental-storage_grpc,experimental-opentelemetry,experimental-bigquery_rest"
+  echo "__ga_libraries__,__experimental_libraries__,experimental-storage_grpc,opentelemetry,experimental-bigquery_rest"
 }
diff --git a/ci/cloudbuild/builds/publish-docs.sh b/ci/cloudbuild/builds/publish-docs.sh
@@ -152,12 +152,11 @@ io::log_h2 "Publishing DocFX"
 io::log "branch:  ${BRANCH_NAME}"
 io::log "bucket:  gs://${docfx_bucket}"
 
-# Upload the documents for all features, including common. We need to
-# rename `experimental-opentelemetry`. Some features do not have documentation,
-# such as `experimental-storage_grpc`. These are harmless, as the
-# `stage_docfx()`` function skips missing directories without an error.
+# Upload the documents for all features, including common. Some features do not
+# have documentation, such as `experimental-storage_grpc`. These are harmless,
+# as the `stage_docfx()` function skips missing directories without an error.
 uploaded=(common)
-uploaded+=("${FEATURE_LIST[@]/experimental-opentelemetry/opentelemetry}")
+uploaded+=("${FEATURE_LIST[@]}")
 echo "${uploaded[@]}" | xargs -P "$(nproc)" -n 1 \
   bash -c "TIMEFORMAT=\"\${0} completed in %0lR\";
            time ci/retry-command.sh 3 120 stage_docfx \"\${0}\" \"${docfx_bucket}\" cmake-out \"cmake-out/\${0}.docfx.log\""
diff --git a/ci/verify_quickstart/CMakeLists.txt b/ci/verify_quickstart/CMakeLists.txt
@@ -105,7 +105,7 @@ foreach (feature IN LISTS FEATURES)
         add_make_quickstart_target("${feature}" storage quickstart_grpc)
         continue()
     endif ()
-    if ("${feature}" STREQUAL "experimental-opentelemetry")
+    if ("${feature}" STREQUAL "opentelemetry")
         add_cmake_quickstart_target("${feature}" opentelemetry quickstart)
         # TODO(#10795) - sort out opentelemetry-cpp pkgconfig
         # add_make_quickstart_target("${feature}" opentelemetry quickstart)
diff --git a/cmake/GoogleCloudCppFeatures.cmake b/cmake/GoogleCloudCppFeatures.cmake
@@ -322,6 +322,14 @@ macro (google_cloud_cpp_enable_deps)
         list(INSERT GOOGLE_CLOUD_CPP_ENABLE 0 storage)
     endif ()
     if (experimental-opentelemetry IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
+        message(
+            WARNING
+                "The feature `experimental-opentelemetry` is deprecated. Please use `opentelemetry` instead."
+        )
+        list(REMOVE_ITEM GOOGLE_CLOUD_CPP_ENABLE experimental-opentelemetry)
+        list(INSERT GOOGLE_CLOUD_CPP_ENABLE 0 opentelemetry)
+    endif ()
+    if (opentelemetry IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         list(INSERT GOOGLE_CLOUD_CPP_ENABLE 0 trace)
     endif ()
 endmacro ()
@@ -357,7 +365,7 @@ macro (google_cloud_cpp_enable_cleanup)
         OR (compute IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         OR (compute_features)
         OR (experimental-bigquery_rest IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
-        OR (experimental-opentelemetry IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
+        OR (opentelemetry IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         OR (sql IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         OR (generator IN_LIST GOOGLE_CLOUD_CPP_ENABLE))
         set(GOOGLE_CLOUD_CPP_ENABLE_REST ON)
@@ -385,8 +393,6 @@ function (google_cloud_cpp_enable_features)
             endif ()
         elseif ("${feature}" STREQUAL "experimental-http-transcoding")
             continue()
-        elseif ("${feature}" STREQUAL "experimental-opentelemetry")
-            add_subdirectory(google/cloud/opentelemetry)
         elseif ("${feature}" MATCHES "^compute_.*")
             if (NOT compute_added)
                 add_subdirectory(google/cloud/compute)
diff --git a/doc/compile-time-configuration.md b/doc/compile-time-configuration.md
@@ -39,7 +39,7 @@ customers will need to use these. If you have specific questions please start a
   team if you want to use this feature or are interested in the GA timeline.
 - `experimental-http-transcoding` enables support for HTTP/1.1 transport (as
   opposed to gRPC over HTTP/2) in some libraries.
-- `experimental-opentelemetry` enables support for [OpenTelemetry].
+- `opentelemetry` enables support for [OpenTelemetry].
 
 ### Override Protobuf compiler and gRPC's plugin
 
diff --git a/google/cloud/google_cloud_cpp_common.cmake b/google/cloud/google_cloud_cpp_common.cmake
@@ -171,7 +171,7 @@ target_link_libraries(
            Threads::Threads
            OpenSSL::Crypto)
 
-if (experimental-opentelemetry IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
+if (opentelemetry IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
     find_package(opentelemetry-cpp CONFIG)
     if (opentelemetry-cpp_FOUND)
         target_link_libraries(google_cloud_cpp_common
diff --git a/google/cloud/opentelemetry/CMakeLists.txt b/google/cloud/opentelemetry/CMakeLists.txt
@@ -57,10 +57,10 @@ target_compile_options(google_cloud_cpp_opentelemetry
                        PUBLIC ${GOOGLE_CLOUD_CPP_EXCEPTIONS_FLAG})
 set_target_properties(
     google_cloud_cpp_opentelemetry
-    PROPERTIES EXPORT_NAME "google-cloud-cpp::experimental-opentelemetry"
+    PROPERTIES EXPORT_NAME "google-cloud-cpp::opentelemetry"
                VERSION ${PROJECT_VERSION}
                SOVERSION ${PROJECT_VERSION_MAJOR})
-add_library(google-cloud-cpp::experimental-opentelemetry ALIAS
+add_library(google-cloud-cpp::opentelemetry ALIAS
             google_cloud_cpp_opentelemetry)
 create_bazel_config(google_cloud_cpp_opentelemetry YEAR 2023)
 
@@ -109,7 +109,6 @@ if (NOT BUILD_TESTING)
 endif ()
 
 add_subdirectory(integration_tests)
-add_subdirectory(samples)
 
 set(opentelemetry_unit_tests
     # cmake-format: sort
@@ -130,7 +129,7 @@ foreach (fname ${opentelemetry_unit_tests})
         PRIVATE google_cloud_cpp_testing
                 google_cloud_cpp_testing_grpc
                 google_cloud_cpp_testing_rest
-                google-cloud-cpp::experimental-opentelemetry
+                google-cloud-cpp::opentelemetry
                 google_cloud_cpp_trace_mocks
                 GTest::gmock_main
                 GTest::gmock
@@ -149,9 +148,8 @@ endif ()
 include(CTest)
 add_executable(opentelemetry_quickstart "quickstart/quickstart.cc")
 target_link_libraries(
-    opentelemetry_quickstart
-    PRIVATE google-cloud-cpp::experimental-opentelemetry
-            google-cloud-cpp::storage)
+    opentelemetry_quickstart PRIVATE google-cloud-cpp::opentelemetry
+                                     google-cloud-cpp::storage)
 google_cloud_cpp_add_common_options(opentelemetry_quickstart)
 add_test(
     NAME opentelemetry_quickstart
diff --git a/google/cloud/opentelemetry/config.cmake.in b/google/cloud/opentelemetry/config.cmake.in
@@ -18,3 +18,8 @@ find_dependency(google_cloud_cpp_trace)
 find_dependency(opentelemetry-cpp)
 
 include("${CMAKE_CURRENT_LIST_DIR}/google_cloud_cpp_opentelemetry-targets.cmake")
+
+if (NOT TARGET google-cloud-cpp::experimental-opentelemetry)
+    add_library(google-cloud-cpp::experimental-opentelemetry
+                ALIAS google-cloud-cpp::opentelemetry)
+endif ()
diff --git a/google/cloud/opentelemetry/integration_tests/CMakeLists.txt b/google/cloud/opentelemetry/integration_tests/CMakeLists.txt
@@ -37,9 +37,9 @@ foreach (fname ${opentelemetry_integration_tests})
     google_cloud_cpp_add_executable(target "opentelemetry" "${fname}")
     target_link_libraries(
         ${target}
-        PRIVATE google-cloud-cpp::experimental-opentelemetry
-                google_cloud_cpp_testing_grpc google_cloud_cpp_testing
-                GTest::gmock_main GTest::gmock GTest::gtest)
+        PRIVATE google-cloud-cpp::opentelemetry google_cloud_cpp_testing_grpc
+                google_cloud_cpp_testing GTest::gmock_main GTest::gmock
+                GTest::gtest)
     google_cloud_cpp_add_common_options(${target})
     add_test(NAME ${target} COMMAND ${target})
     set_tests_properties(${target} PROPERTIES LABELS "integration-test")
diff --git a/google/cloud/opentelemetry/quickstart/CMakeLists.txt b/google/cloud/opentelemetry/quickstart/CMakeLists.txt
@@ -30,5 +30,5 @@ endif ()
 
 # Once the packages are found, define the targets.
 add_executable(quickstart quickstart.cc)
-target_link_libraries(quickstart google-cloud-cpp::experimental-opentelemetry
+target_link_libraries(quickstart google-cloud-cpp::opentelemetry
                       google-cloud-cpp::storage)
diff --git a/google/cloud/opentelemetry/quickstart/README.md b/google/cloud/opentelemetry/quickstart/README.md
@@ -107,13 +107,13 @@ Also note that we explicitly load OpenTelemetry's dependencies in the
 
 The [packaging guide] contains instructions for how to build from source.
 
-The Google Cloud exporters are built as part of the `experimental-opentelemetry`
-feature. This quickstart also uses the GCS client, from the `storage` feature.
+The Google Cloud exporters are built as part of the `opentelemetry` feature.
+This quickstart also uses the GCS client, from the `storage` feature.
 
 To enable these features, add the following to your CMake configuration command:
 
 ```
--DGOOGLE_CLOUD_CPP_ENABLE="storage,experimental-opentelemetry"
+-DGOOGLE_CLOUD_CPP_ENABLE="storage,opentelemetry"
 ```
 
 #### Fetching `opentelemetry-cpp`
diff --git a/vcpkg.json b/vcpkg.json
@@ -29,7 +29,7 @@
     "benchmark",
     "gtest",
     {
-      "$description": "Only used for the experimental-opentelemetry feature.",
+      "$description": "Only used for the opentelemetry feature.",
       "name": "opentelemetry-cpp"
     },
     {
