WIP: OpenTelemetry integration refactoring

Author: avsej

.github/workflows/columnar.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install build environment
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y libssl-dev cmake gcc g++ curl gdb
+          sudo apt-get install -y libssl-dev cmake gcc g++ curl gdb libcurl4-openssl-dev libprotobuf-dev libgrpc-dev gdb
       - uses: actions/checkout@v4
         with:
           submodules: recursive

.github/workflows/linters.yml

@@ -38,7 +38,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y libssl-dev cmake curl wget gnupg2
+          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 libcurl4-openssl-dev libprotobuf-dev libgrpc-dev gdb
           wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
           sudo bash -c "echo 'deb https://apt.llvm.org/noble/ llvm-toolchain-noble main' >> /etc/apt/sources.list"
           sudo apt-get update -y
@@ -65,7 +65,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 clang clang-tools cppcheck
+          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 clang clang-tools cppcheck libcurl4-openssl-dev libprotobuf-dev libgrpc-dev gdb
       - name: Run cppcheck
         run: ./bin/check-cppcheck
 
@@ -78,6 +78,6 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 clang clang-tools clang-tidy
+          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 clang clang-tools clang-tidy libcurl4-openssl-dev libprotobuf-dev libgrpc-dev gdb
       - name: Run cppcheck
         run: ./bin/check-clang-tidy

.github/workflows/sanitizers.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 gdb clang clang-tools valgrind
+          sudo apt-get install -y libssl-dev cmake curl wget gnupg2 libcurl4-openssl-dev libprotobuf-dev libgrpc-dev gdb clang clang-tools valgrind
       - uses: actions/checkout@v4
         with:
           submodules: recursive

.github/workflows/tests.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install build environment
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y libssl-dev cmake gcc g++ curl gdb
+          sudo apt-get install -y libssl-dev cmake gcc g++ curl libcurl4-openssl-dev libprotobuf-dev libgrpc-dev gdb
       - uses: actions/checkout@v4
         with:
           submodules: recursive

CMakeLists.txt

@@ -404,6 +404,7 @@ set(couchbase_cxx_client_FILES
     core/search_query_options.cxx
     core/seed_config.cxx
     core/topology/configuration.cxx
+    core/tracing/otel_tracer.cxx
     core/tracing/threshold_logging_tracer.cxx
     core/tracing/tracer_wrapper.cxx
     core/transactions/active_transaction_record.cxx
@@ -531,6 +532,7 @@ foreach(TARGET ${couchbase_cxx_client_LIBRARIES})
             snappy
             jsonsl
             couchbase_backtrace
+            opentelemetry_api
             hdr_histogram_static)
 
   if(WIN32)

cmake/ThirdPartyDependencies.cmake

@@ -40,6 +40,30 @@ if(NOT TARGET spdlog::spdlog)
     "SPDLOG_FMT_EXTERNAL OFF")
 endif()
 
+if(NOT TARGET opentelemetry_api)
+  # https://github.com/open-telemetry/opentelemetry-cpp/releases
+  cpmaddpackage(
+    NAME
+    opentelemetry_api
+    VERSION
+    1.20.0
+    GITHUB_REPOSITORY
+    "open-telemetry/opentelemetry-cpp"
+    EXCLUDE_FROM_ALL ON
+    OPTIONS
+    "OPENTELEMETRY_INSTALL OFF"
+    "WITH_STL ON"
+    "WITH_ABSEIL OFF"
+    "WITH_OTLP_HTTP ON"
+    "WITH_OTLP_GRPC OFF"
+    "WITH_BENCHMARK OFF"
+    "BUILD_TESTING OFF"
+    "BUILD_SHARED_LIBS OFF"
+    "CMAKE_C_VISIBILITY_PRESET hidden"
+    "CMAKE_CXX_VISIBILITY_PRESET hidden"
+    "CMAKE_POSITION_INDEPENDENT_CODE ON")
+endif()
+
 if(NOT TARGET Microsoft.GSL::GSL)
   # https://github.com/microsoft/GSL/releases
   cpmaddpackage(

core/meta/version.cxx

@@ -31,6 +31,7 @@
 #include <llhttp.h>
 #include <openssl/crypto.h>
 #include <openssl/x509.h>
+#include <opentelemetry/version.h>
 #include <snappy-stubs-public.h>
 #include <spdlog/fmt/bundled/core.h>
 #include <spdlog/version.h>
@@ -168,6 +169,7 @@ sdk_build_info() -> std::map<std::string, std::string>
 #if defined(__GLIBC__)
   info["libc"] = fmt::format("glibc {}.{}", __GLIBC__, __GLIBC_MINOR__);
 #endif
+  info["opentelemetry_api"] = OPENTELEMETRY_VERSION;
 
   return info;
 }

core/metrics/otel_meter.cxx

@@ -0,0 +1,146 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2021 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include "otel_meter.hxx"
+
+#include <couchbase/metrics/meter.hxx>
+
+#include <opentelemetry/metrics/meter_provider.h>
+#include <opentelemetry/metrics/provider.h>
+
+#include <algorithm>
+#include <iostream>
+#include <thread>
+#include <utility>
+
+namespace couchbase::core::metrics
+{
+namespace
+{
+class otel_sync_histogram
+{
+public:
+  otel_sync_histogram(
+    opentelemetry::nostd::shared_ptr<opentelemetry::metrics::Histogram<std::uint64_t>>
+      histogram_counter)
+    : histogram_counter_(histogram_counter)
+  {
+  }
+
+  void record(std::uint64_t value,
+              const opentelemetry::common::KeyValueIterable& tags,
+              opentelemetry::context::Context& ctx)
+  {
+    histogram_counter_->Record(value, tags, ctx);
+  }
+
+private:
+  opentelemetry::nostd::shared_ptr<opentelemetry::metrics::Histogram<std::uint64_t>>
+    histogram_counter_;
+  std::mutex mutex_;
+};
+
+class otel_value_recorder : public couchbase::metrics::value_recorder
+{
+public:
+  explicit otel_value_recorder(
+    nostd::shared_ptr<metrics_api::Histogram<std::uint64_t>> histogram_counter,
+    const std::map<std::string, std::string>& tags)
+    : histogram_counter_(histogram_counter)
+    , tags_(tags)
+  {
+  }
+  void record_value(std::int64_t value) override
+  {
+    value = std::max<int64_t>(value, 0);
+    auto uvalue = static_cast<std::uint64_t>(value);
+    histogram_counter_->Record(
+      uvalue, opentelemetry::common::KeyValueIterableView<decltype(tags_)>{ tags_ }, context_);
+  }
+
+  auto tags() -> const std::map<std::string, std::string>
+  {
+    return tags_;
+  }
+
+  auto histogram_counter()
+    -> opentelemetry::nostd::shared_ptr<opentelemetry::metrics::Histogram<std::uint64_t>>
+  {
+    return histogram_counter_;
+  }
+
+private:
+  opentelemetry::nostd::shared_ptr<opentelemetry::metrics::Histogram<std::uint64_t>>
+    histogram_counter_;
+  const std::map<std::string, std::string> tags_;
+  opentelemetry::context::Context context_{};
+  std::mutex mutex_;
+};
+} // namespace
+
+class otel_meter_impl
+{
+  friend otel_meter;
+
+public:
+  explicit otel_meter_impl(opentelemetry::nostd::shared_ptr<opentelemetry::metrics::Meter> meter)
+    : meter_(meter)
+  {
+  }
+
+private:
+  opentelemetry::nostd::shared_ptr<opentelemetry::metrics::Meter> meter_;
+  std::mutex mutex_;
+  std::multimap<std::string, std::shared_ptr<otel_value_recorder>> recorders_;
+};
+
+auto
+otel_meter::get_value_recorder(const std::string& name,
+                               const std::map<std::string, std::string>& tags)
+  -> std::shared_ptr<couchbase::metrics::value_recorder>
+{
+  // first look up the histogram, in case we already have it...
+  std::scoped_lock<std::mutex> lock(mutex_);
+  auto it = recorders_.equal_range(name);
+  if (it.first == it.second) {
+    // this name isn't associated with any histogram, so make one and return it.
+    // Note we'd like to make one with more buckets than default, given the range of
+    // response times we'd like to display (queries vs kv for instance), but otel
+    // api doesn't seem to allow this.
+    return recorders_
+      .insert({ name,
+                std::make_shared<otel_value_recorder>(meter_->CreateUInt64Histogram(name, "", "us"),
+                                                      tags) })
+      ->second;
+  }
+  // so it is already, lets see if we already have one with those tags, or need
+  // to make a new one (using the histogram we already have).
+  for (auto itr = it.first; itr != it.second; itr++) {
+    if (tags == itr->second->tags()) {
+      return itr->second;
+    }
+  }
+  // if you are here, we need to add one with these tags and the histogram associated with the
+  // name.
+  return recorders_
+    .insert(
+      { name, std::make_shared<otel_value_recorder>(it.first->second->histogram_counter(), tags) })
+    ->second;
+}
+} // namespace couchbase::core::metrics

core/metrics/otel_meter.hxx

@@ -0,0 +1,36 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2021 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <couchbase/metrics/meter.hxx>
+
+namespace couchbase::core::metrics
+{
+
+class otel_meter_impl;
+
+class otel_meter : public couchbase::metrics::meter
+{
+public:
+  auto get_value_recorder(const std::string& name, const std::map<std::string, std::string>& tags)
+    -> std::shared_ptr<couchbase::metrics::value_recorder> override;
+
+private:
+  std::unique_ptr<otel_meter_impl> impl_;
+};
+} // namespace couchbase::core::metrics

core/tracing/noop_tracer.hxx

@@ -39,7 +39,7 @@ class noop_span : public couchbase::tracing::request_span
     /* do nothing */
   }
 
-  auto uses_tags() const -> bool override
+  [[nodiscard]] auto uses_tags() const -> bool override
   {
     return false;
   }