impl(bigtable): rename RetryContext and support optional otel dep (#15265)

Author: scotthart

google/cloud/bigtable/BUILD.bazel

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+load("@bazel_skylib//rules:common_settings.bzl", "bool_flag")
 load(":bigtable_client_testing.bzl", "bigtable_client_testing_hdrs", "bigtable_client_testing_srcs")
 load(":bigtable_client_unit_tests.bzl", "bigtable_client_unit_tests")
 load(":google_cloud_cpp_bigtable.bzl", "google_cloud_cpp_bigtable_hdrs", "google_cloud_cpp_bigtable_srcs")
@@ -21,6 +22,16 @@ package(default_visibility = ["//visibility:private"])
 
 licenses(["notice"])  # Apache 2.0
 
+bool_flag(
+    name = "enable_metrics",
+    build_setting_default = True,
+)
+
+config_setting(
+    name = "metrics_enabled",
+    flag_values = {":enable_metrics": "true"},
+)
+
 filegroup(
     name = "public_hdrs",
     srcs = [h for h in google_cloud_cpp_bigtable_hdrs if not h.startswith("internal/")],
@@ -31,6 +42,10 @@ cc_library(
     name = "google_cloud_cpp_bigtable",
     srcs = google_cloud_cpp_bigtable_srcs,
     hdrs = google_cloud_cpp_bigtable_hdrs,
+    local_defines = select({
+        ":metrics_enabled": ["GOOGLE_CLOUD_CPP_BIGTABLE_WITH_OTEL_METRICS"],
+        "//conditions:default": [],
+    }),
     visibility = [
         ":__subpackages__",
         "//:__pkg__",
@@ -45,7 +60,14 @@ cc_library(
         "@com_google_googleapis//google/longrunning:longrunning_cc_grpc",
         "@com_google_googleapis//google/rpc:error_details_cc_proto",
         "@com_github_grpc_grpc//:grpc++",
-    ],
+    ] + select({
+        ":metrics_enabled": [
+            "//:opentelemetry",
+            "@io_opentelemetry_cpp//api",
+            "@io_opentelemetry_cpp//sdk/src/metrics",
+        ],
+        "//conditions:default": [],
+    }),
 )
 
 filegroup(

google/cloud/bigtable/CMakeLists.txt

@@ -195,14 +195,14 @@ add_library(
     internal/logging_data_client.h
     internal/mutate_rows_limiter.cc
     internal/mutate_rows_limiter.h
+    internal/operation_context.cc
+    internal/operation_context.h
     internal/prefix_range_end.cc
     internal/prefix_range_end.h
     internal/rate_limiter.cc
     internal/rate_limiter.h
     internal/readrowsparser.cc
     internal/readrowsparser.h
-    internal/retry_context.cc
-    internal/retry_context.h
     internal/retry_traits.h
     internal/row_reader_impl.h
     internal/rpc_policy_parameters.h
@@ -440,9 +440,9 @@ if (BUILD_TESTING)
         internal/legacy_row_reader_test.cc
         internal/logging_data_client_test.cc
         internal/mutate_rows_limiter_test.cc
+        internal/operation_context_test.cc
         internal/prefix_range_end_test.cc
         internal/rate_limiter_test.cc
-        internal/retry_context_test.cc
         internal/retry_traits_test.cc
         internal/traced_row_reader_test.cc
         legacy_table_test.cc

google/cloud/bigtable/bigtable_client_unit_tests.bzl

@@ -60,9 +60,9 @@ bigtable_client_unit_tests = [
     "internal/legacy_row_reader_test.cc",
     "internal/logging_data_client_test.cc",
     "internal/mutate_rows_limiter_test.cc",
+    "internal/operation_context_test.cc",
     "internal/prefix_range_end_test.cc",
     "internal/rate_limiter_test.cc",
-    "internal/retry_context_test.cc",
     "internal/retry_traits_test.cc",
     "internal/traced_row_reader_test.cc",
     "legacy_table_test.cc",

google/cloud/bigtable/google_cloud_cpp_bigtable.bzl

@@ -97,10 +97,10 @@ google_cloud_cpp_bigtable_hdrs = [
     "internal/legacy_row_reader.h",
     "internal/logging_data_client.h",
     "internal/mutate_rows_limiter.h",
+    "internal/operation_context.h",
     "internal/prefix_range_end.h",
     "internal/rate_limiter.h",
     "internal/readrowsparser.h",
-    "internal/retry_context.h",
     "internal/retry_traits.h",
     "internal/row_reader_impl.h",
     "internal/rpc_policy_parameters.h",
@@ -199,10 +199,10 @@ google_cloud_cpp_bigtable_srcs = [
     "internal/legacy_row_reader.cc",
     "internal/logging_data_client.cc",
     "internal/mutate_rows_limiter.cc",
+    "internal/operation_context.cc",
     "internal/prefix_range_end.cc",
     "internal/rate_limiter.cc",
     "internal/readrowsparser.cc",
-    "internal/retry_context.cc",
     "internal/traced_row_reader.cc",
     "metadata_update_policy.cc",
     "mutation_batcher.cc",

google/cloud/bigtable/internal/async_bulk_apply.cc

@@ -73,7 +73,7 @@ void AsyncBulkApplier::MakeRequest() {
   internal::ScopedCallContext scope(call_context_);
   context_ = std::make_shared<grpc::ClientContext>();
   internal::ConfigureContext(*context_, *call_context_.options);
-  retry_context_->PreCall(*context_);
+  operation_context_->PreCall(*context_);
 
   auto self = this->shared_from_this();
   PerformAsyncStreamingRead(
@@ -105,7 +105,7 @@ void AsyncBulkApplier::OnFinish(Status const& status) {
     return;
   }
 
-  retry_context_->PostCall(*context_);
+  operation_context_->PostCall(*context_);
   context_.reset();
   auto self = this->shared_from_this();
   internal::TracedAsyncBackoff(cq_, *call_context_.options, *delay,

google/cloud/bigtable/internal/async_bulk_apply.h

@@ -17,7 +17,7 @@
 
 #include "google/cloud/bigtable/internal/bigtable_stub.h"
 #include "google/cloud/bigtable/internal/bulk_mutator.h"
-#include "google/cloud/bigtable/internal/retry_context.h"
+#include "google/cloud/bigtable/internal/operation_context.h"
 #include "google/cloud/bigtable/options.h"
 #include "google/cloud/bigtable/version.h"
 #include "google/cloud/completion_queue.h"
@@ -78,8 +78,8 @@ class AsyncBulkApplier : public std::enable_shared_from_this<AsyncBulkApplier> {
   internal::ImmutableOptions options_;
   internal::CallContext call_context_;
   std::shared_ptr<grpc::ClientContext> context_;
-  std::shared_ptr<RetryContext> retry_context_ =
-      std::make_shared<RetryContext>();
+  std::shared_ptr<OperationContext> operation_context_ =
+      std::make_shared<OperationContext>();
 };
 
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END

google/cloud/bigtable/internal/async_row_reader.cc

@@ -47,7 +47,7 @@ void AsyncRowReader::MakeRequest() {
   internal::ScopedCallContext scope(call_context_);
   context_ = std::make_shared<grpc::ClientContext>();
   internal::ConfigureContext(*context_, *call_context_.options);
-  retry_context_->PreCall(*context_);
+  operation_context_->PreCall(*context_);
 
   auto self = this->shared_from_this();
   PerformAsyncStreamingRead(
@@ -220,7 +220,7 @@ void AsyncRowReader::OnStreamFinished(Status status) {
     TryGiveRowToUser();
     return;
   }
-  retry_context_->PostCall(*context_);
+  operation_context_->PostCall(*context_);
   context_.reset();
   auto self = this->shared_from_this();
   internal::TracedAsyncBackoff(cq_, *call_context_.options, *delay,

google/cloud/bigtable/internal/async_row_reader.h

@@ -18,8 +18,8 @@
 #include "google/cloud/bigtable/filters.h"
 #include "google/cloud/bigtable/internal/async_streaming_read.h"
 #include "google/cloud/bigtable/internal/bigtable_stub.h"
+#include "google/cloud/bigtable/internal/operation_context.h"
 #include "google/cloud/bigtable/internal/readrowsparser.h"
-#include "google/cloud/bigtable/internal/retry_context.h"
 #include "google/cloud/bigtable/options.h"
 #include "google/cloud/bigtable/row.h"
 #include "google/cloud/bigtable/row_set.h"
@@ -176,8 +176,8 @@ class AsyncRowReader : public std::enable_shared_from_this<AsyncRowReader> {
   internal::ImmutableOptions options_;
   internal::CallContext call_context_;
   std::shared_ptr<grpc::ClientContext> context_;
-  std::shared_ptr<RetryContext> retry_context_ =
-      std::make_shared<RetryContext>();
+  std::shared_ptr<OperationContext> operation_context_ =
+      std::make_shared<OperationContext>();
 };
 
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END

google/cloud/bigtable/internal/async_row_sampler.cc

@@ -64,7 +64,7 @@ void AsyncRowSampler::StartIteration() {
   internal::ScopedCallContext scope(call_context_);
   context_ = std::make_shared<grpc::ClientContext>();
   internal::ConfigureContext(*context_, *call_context_.options);
-  retry_context_->PreCall(*context_);
+  operation_context_->PreCall(*context_);
 
   auto self = this->shared_from_this();
   PerformAsyncStreamingRead<v2::SampleRowKeysResponse>(
@@ -96,7 +96,7 @@ void AsyncRowSampler::OnFinish(Status const& status) {
     return;
   }
 
-  retry_context_->PostCall(*context_);
+  operation_context_->PostCall(*context_);
   context_.reset();
   samples_.clear();
   auto self = this->shared_from_this();

google/cloud/bigtable/internal/async_row_sampler.h

@@ -17,7 +17,7 @@
 
 #include "google/cloud/bigtable/completion_queue.h"
 #include "google/cloud/bigtable/internal/bigtable_stub.h"
-#include "google/cloud/bigtable/internal/retry_context.h"
+#include "google/cloud/bigtable/internal/operation_context.h"
 #include "google/cloud/bigtable/options.h"
 #include "google/cloud/bigtable/row_key_sample.h"
 #include "google/cloud/bigtable/version.h"
@@ -70,8 +70,8 @@ class AsyncRowSampler : public std::enable_shared_from_this<AsyncRowSampler> {
   internal::ImmutableOptions options_;
   internal::CallContext call_context_;
   std::shared_ptr<grpc::ClientContext> context_;
-  std::shared_ptr<RetryContext> retry_context_ =
-      std::make_shared<RetryContext>();
+  std::shared_ptr<OperationContext> operation_context_ =
+      std::make_shared<OperationContext>();
 };
 
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END