impl(bigtable): add OperationContextFactory (#15297)

Author: scotthart

ci/cloudbuild/builds/cmake-oldest-deps.sh

@@ -27,7 +27,8 @@ source module ci/cloudbuild/builds/lib/integration.sh
 source module ci/cloudbuild/builds/lib/vcpkg.sh
 source module ci/lib/io.sh
 
-mapfile -t feature_list < <(features::always_build | grep -v "experimental-bigquery")
+# TODO(#14944): add bigtable back when we are able to update vcpkg version.
+mapfile -t feature_list < <(features::always_build | grep -v "experimental-bigquery" | grep -v "bigtable")
 ENABLED_FEATURES="$(printf ",%s" "${feature_list[@]}")"
 ENABLED_FEATURES="${ENABLED_FEATURES:1}"
 readonly ENABLED_FEATURES

cmake/GoogleCloudCppFeatures.cmake

@@ -300,6 +300,7 @@ export_libraries_bzl()
 #   other feature, or even if no features are enabled.
 # ~~~
 macro (google_cloud_cpp_enable_deps)
+    find_package(opentelemetry-cpp CONFIG)
     if (__ga_libraries__ IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         list(APPEND GOOGLE_CLOUD_CPP_ENABLE ${GOOGLE_CLOUD_CPP_GA_LIBRARIES})
         list(APPEND GOOGLE_CLOUD_CPP_ENABLE
@@ -338,6 +339,11 @@ macro (google_cloud_cpp_enable_deps)
     if (asset IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         list(INSERT GOOGLE_CLOUD_CPP_ENABLE 0 accesscontextmanager osconfig)
     endif ()
+    if (bigtable IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
+        if (opentelemetry-cpp_FOUND)
+            list(INSERT GOOGLE_CLOUD_CPP_ENABLE 0 opentelemetry)
+        endif ()
+    endif ()
     if (contentwarehouse IN_LIST GOOGLE_CLOUD_CPP_ENABLE)
         list(INSERT GOOGLE_CLOUD_CPP_ENABLE 0 documentai)
     endif ()

google/cloud/bigtable/CMakeLists.txt

@@ -47,6 +47,8 @@ include(CTest)
 # Export the version information for Bazel.
 include(CreateBazelConfig)
 
+find_package(opentelemetry-cpp CONFIG)
+
 # the client library
 add_library(
     google_cloud_cpp_bigtable # cmake-format: sort
@@ -199,6 +201,8 @@ add_library(
     internal/mutate_rows_limiter.h
     internal/operation_context.cc
     internal/operation_context.h
+    internal/operation_context_factory.cc
+    internal/operation_context_factory.h
     internal/prefix_range_end.cc
     internal/prefix_range_end.h
     internal/rate_limiter.cc
@@ -261,6 +265,14 @@ target_link_libraries(
            gRPC::grpc++
            gRPC::grpc
            protobuf::libprotobuf)
+if (opentelemetry-cpp_FOUND)
+    target_compile_definitions(
+        google_cloud_cpp_bigtable
+        PRIVATE GOOGLE_CLOUD_CPP_BIGTABLE_WITH_OTEL_METRICS)
+    target_link_libraries(google_cloud_cpp_bigtable
+                          PUBLIC google-cloud-cpp::opentelemetry)
+    set(EXTRA_MODULES "google_cloud_cpp_opentelemetry" "opentelemetry_metrics")
+endif ()
 google_cloud_cpp_add_common_options(google_cloud_cpp_bigtable)
 target_include_directories(
     google_cloud_cpp_bigtable
@@ -305,7 +317,8 @@ google_cloud_cpp_add_pkgconfig(
     "Provides C++ APIs to access Google Cloud Bigtable."
     "google_cloud_cpp_grpc_utils"
     "google_cloud_cpp_common"
-    "google_cloud_cpp_bigtable_protos")
+    "google_cloud_cpp_bigtable_protos"
+    ${EXTRA_MODULES})
 
 # Create and install the CMake configuration files.
 include(CMakePackageConfigHelpers)
@@ -501,6 +514,10 @@ if (BUILD_TESTING)
                     gRPC::grpc++
                     gRPC::grpc
                     protobuf::libprotobuf)
+        if (opentelemetry-cpp_FOUND)
+            target_compile_definitions(
+                ${target} PRIVATE GOOGLE_CLOUD_CPP_BIGTABLE_WITH_OTEL_METRICS)
+        endif ()
         google_cloud_cpp_add_common_options(${target})
         add_test(NAME ${target} COMMAND ${target})
     endforeach ()

google/cloud/bigtable/config.cmake.in

@@ -17,6 +17,7 @@ include(CMakeFindDependencyMacro)
 find_dependency(google_cloud_cpp_googleapis)
 find_dependency(google_cloud_cpp_common)
 find_dependency(google_cloud_cpp_grpc_utils)
+find_dependency(google_cloud_cpp_opentelemetry)
 find_dependency(absl)
 
 include("${CMAKE_CURRENT_LIST_DIR}/google_cloud_cpp_bigtable-targets.cmake")

google/cloud/bigtable/google_cloud_cpp_bigtable.bzl

@@ -99,6 +99,7 @@ google_cloud_cpp_bigtable_hdrs = [
     "internal/metrics.h",
     "internal/mutate_rows_limiter.h",
     "internal/operation_context.h",
+    "internal/operation_context_factory.h",
     "internal/prefix_range_end.h",
     "internal/rate_limiter.h",
     "internal/readrowsparser.h",
@@ -202,6 +203,7 @@ google_cloud_cpp_bigtable_srcs = [
     "internal/metrics.cc",
     "internal/mutate_rows_limiter.cc",
     "internal/operation_context.cc",
+    "internal/operation_context_factory.cc",
     "internal/prefix_range_end.cc",
     "internal/rate_limiter.cc",
     "internal/readrowsparser.cc",

google/cloud/bigtable/internal/data_connection_impl.cc

@@ -26,6 +26,7 @@
 #include "google/cloud/idempotency.h"
 #include "google/cloud/internal/async_retry_loop.h"
 #include "google/cloud/internal/make_status.h"
+#include "google/cloud/internal/random.h"
 #include "google/cloud/internal/retry_loop.h"
 #include <memory>
 #include <string>
@@ -88,7 +89,26 @@ DataConnectionImpl::DataConnectionImpl(
       stub_(std::move(stub)),
       limiter_(std::move(limiter)),
       options_(internal::MergeOptions(std::move(options),
-                                      DataConnection::options())) {}
+                                      DataConnection::options())) {
+#ifdef GOOGLE_CLOUD_CPP_BIGTABLE_WITH_OTEL_METRICS
+  if (options_.get<bigtable::EnableMetricsOption>()) {
+    // The client_uid is eventually used in conjunction with other data labels
+    // to identify metric data points. This pseudorandom string is used to aid
+    // in disambiguation.
+    auto gen = internal::MakeDefaultPRNG();
+    std::string client_uid =
+        internal::Sample(gen, 16, "abcdefghijklmnopqrstuvwxyz0123456789");
+    operation_context_factory_ =
+        std::make_unique<MetricsOperationContextFactory>(std::move(client_uid));
+  } else {
+    operation_context_factory_ =
+        std::make_unique<SimpleOperationContextFactory>();
+  }
+#else
+  operation_context_factory_ =
+      std::make_unique<SimpleOperationContextFactory>();
+#endif
+}
 
 Status DataConnectionImpl::Apply(std::string const& table_name,
                                  bigtable::SingleRowMutation mut) {

google/cloud/bigtable/internal/data_connection_impl.h

@@ -18,6 +18,7 @@
 #include "google/cloud/bigtable/data_connection.h"
 #include "google/cloud/bigtable/internal/bigtable_stub.h"
 #include "google/cloud/bigtable/internal/mutate_rows_limiter.h"
+#include "google/cloud/bigtable/internal/operation_context_factory.h"
 #include "google/cloud/background_threads.h"
 #include "google/cloud/options.h"
 #include "google/cloud/status_or.h"
@@ -94,6 +95,7 @@ class DataConnectionImpl : public bigtable::DataConnection {
       bigtable::Filter filter) override;
 
  private:
+  std::unique_ptr<OperationContextFactory> operation_context_factory_;
   std::unique_ptr<BackgroundThreads> background_;
   std::shared_ptr<BigtableStub> stub_;
   std::shared_ptr<MutateRowsLimiter> limiter_;

google/cloud/bigtable/internal/defaults.cc

@@ -221,6 +221,17 @@ Options DefaultOptions(Options opts) {
   products.insert(products.begin(),
                   ::google::cloud::internal::UserAgentPrefix());
 
+  if (!opts.has<EnableMetricsOption>()) {
+    opts.set<EnableMetricsOption>(true);
+  }
+
+  if (opts.get<EnableMetricsOption>()) {
+    if (!opts.has<MetricsPeriodOption>() ||
+        (opts.get<MetricsPeriodOption>() < std::chrono::seconds(5))) {
+      opts.set<MetricsPeriodOption>(std::chrono::seconds(60));
+    }
+  }
+
   return opts;
 }
 

google/cloud/bigtable/internal/defaults_test.cc

@@ -318,6 +318,34 @@ TEST(OptionsTest, BigtableEndpointEnvVarsOverrideUniverseDomain) {
             "emulator-host:8000");
 }
 
+TEST(OptionsTest, EnableMetrics) {
+  Options options;
+  options = DefaultOptions(std::move(options));
+  EXPECT_TRUE(options.get<EnableMetricsOption>());
+
+  options = Options{}.set<EnableMetricsOption>(true);
+  options = DefaultOptions(std::move(options));
+  EXPECT_TRUE(options.get<EnableMetricsOption>());
+
+  options = Options{}.set<EnableMetricsOption>(false);
+  options = DefaultOptions(std::move(options));
+  EXPECT_FALSE(options.get<EnableMetricsOption>());
+}
+
+TEST(OptionsTest, MetricsPeriod) {
+  Options options;
+  options = DefaultOptions(std::move(options));
+  EXPECT_EQ(options.get<MetricsPeriodOption>(), std::chrono::seconds(60));
+
+  options.set<MetricsPeriodOption>(std::chrono::seconds(30));
+  options = DefaultOptions(std::move(options));
+  EXPECT_EQ(options.get<MetricsPeriodOption>(), std::chrono::seconds(30));
+
+  options.set<MetricsPeriodOption>(std::chrono::seconds(3));
+  options = DefaultOptions(std::move(options));
+  EXPECT_EQ(options.get<MetricsPeriodOption>(), std::chrono::seconds(60));
+}
+
 TEST(EndpointEnvTest, EmulatorEnvOnly) {
   ScopedEnvironment emulator("BIGTABLE_EMULATOR_HOST", "emulator-host:8000");