couchbase 4.3.1 → 4.4.1-dev.1

package/deps/couchbase-cxx-client/core/tracing/threshold_logging_tracer.cxx

@@ -36,381 +36,390 @@
 namespace couchbase::core::tracing
 {
 struct reported_span {
-    std::chrono::microseconds duration;
-    tao::json::value payload;
+  std::chrono::microseconds duration;
+  tao::json::value payload;
 
-    bool operator<(const reported_span& other) const
-    {
-        return duration < other.duration;
-    }
+  auto operator<(const reported_span& other) const -> bool
+  {
+    return duration < other.duration;
+  }
 };
 
 class threshold_logging_span
   : public couchbase::tracing::request_span
   , public std::enable_shared_from_this<threshold_logging_span>
 {
-  private:
-    std::chrono::system_clock::time_point start_{ std::chrono::system_clock::now() };
-    std::string id_{ uuid::to_string(uuid::random()) };
-    std::map<std::string, std::uint64_t> integer_tags_{};
-    std::map<std::string, std::string> string_tags_{
-        { attributes::system, "couchbase" },
-        { attributes::span_kind, "client" },
-        { attributes::component, couchbase::core::meta::sdk_id() },
-    };
-    std::chrono::microseconds duration_{ 0 };
-    std::uint64_t last_server_duration_us_{ 0 };
-    std::uint64_t total_server_duration_us_{ 0 };
-
-    std::shared_ptr<threshold_logging_tracer> tracer_{};
-
-  public:
-    threshold_logging_span(std::string name,
-                           std::shared_ptr<threshold_logging_tracer> tracer,
-                           std::shared_ptr<request_span> parent = nullptr)
-      : request_span(std::move(name), parent)
-      , tracer_{ std::move(tracer) }
-    {
-    }
-
-    void add_tag(const std::string& name, std::uint64_t value) override
-    {
-        if (name == tracing::attributes::server_duration) {
-            last_server_duration_us_ = value;
-            total_server_duration_us_ += value;
-        }
-        integer_tags_.try_emplace(name, value);
-    }
-
-    void add_tag(const std::string& name, const std::string& value) override
-    {
-        string_tags_.try_emplace(name, value);
-    }
-
-    void end() override;
-
-    [[nodiscard]] const auto& string_tags() const
-    {
-        return string_tags_;
-    }
-
-    [[nodiscard]] std::chrono::microseconds duration() const
-    {
-        return duration_;
-    }
-
-    [[nodiscard]] std::uint64_t last_server_duration_us() const
-    {
-        return last_server_duration_us_;
-    }
-
-    [[nodiscard]] std::uint64_t total_server_duration_us() const
-    {
-        return total_server_duration_us_;
-    }
-
-    [[nodiscard]] bool orphan() const
-    {
-        return string_tags_.find(tracing::attributes::orphan) != string_tags_.end();
-    }
-
-    [[nodiscard]] bool is_key_value() const
-    {
-        auto service_tag = string_tags_.find(tracing::attributes::service);
-        if (service_tag == string_tags_.end()) {
-            return false;
-        }
-        return service_tag->second == tracing::service::key_value;
-    }
-
-    [[nodiscard]] std::optional<service_type> service() const
-    {
-        auto service_tag = string_tags_.find(tracing::attributes::service);
-        if (service_tag == string_tags_.end()) {
-            return {};
-        }
-        const auto& service_name = service_tag->second;
-        if (service_name == tracing::service::key_value) {
-            return service_type::key_value;
-        }
-        if (service_name == tracing::service::query) {
-            return service_type::query;
-        }
-        if (service_name == tracing::service::view) {
-            return service_type::view;
-        }
-        if (service_name == tracing::service::search) {
-            return service_type::search;
-        }
-        if (service_name == tracing::service::analytics) {
-            return service_type::analytics;
-        }
-        if (service_name == tracing::service::management) {
-            return service_type::management;
-        }
-        return {};
-    }
+private:
+  std::chrono::system_clock::time_point start_{ std::chrono::system_clock::now() };
+  std::string id_{ uuid::to_string(uuid::random()) };
+  std::map<std::string, std::uint64_t> integer_tags_{};
+  std::map<std::string, std::string> string_tags_{
+    { attributes::system, "couchbase" },
+    { attributes::span_kind, "client" },
+    { attributes::component, couchbase::core::meta::sdk_id() },
+  };
+  std::chrono::microseconds duration_{ 0 };
+  std::uint64_t last_server_duration_us_{ 0 };
+  std::uint64_t total_server_duration_us_{ 0 };
+
+  std::shared_ptr<threshold_logging_tracer> tracer_{};
+
+public:
+  threshold_logging_span(std::string name,
+                         std::shared_ptr<threshold_logging_tracer> tracer,
+                         std::shared_ptr<request_span> parent = nullptr)
+    : request_span(std::move(name), parent)
+    , tracer_{ std::move(tracer) }
+  {
+  }
+
+  void add_tag(const std::string& name, std::uint64_t value) override
+  {
+    if (name == tracing::attributes::server_duration) {
+      last_server_duration_us_ = value;
+      total_server_duration_us_ += value;
+    }
+    integer_tags_.try_emplace(name, value);
+  }
+
+  void add_tag(const std::string& name, const std::string& value) override
+  {
+    string_tags_.try_emplace(name, value);
+  }
+
+  void end() override;
+
+  [[nodiscard]] auto string_tags() const -> const auto&
+  {
+    return string_tags_;
+  }
+
+  [[nodiscard]] auto duration() const -> std::chrono::microseconds
+  {
+    return duration_;
+  }
+
+  [[nodiscard]] auto last_server_duration_us() const -> std::uint64_t
+  {
+    return last_server_duration_us_;
+  }
+
+  [[nodiscard]] auto total_server_duration_us() const -> std::uint64_t
+  {
+    return total_server_duration_us_;
+  }
+
+  [[nodiscard]] auto orphan() const -> bool
+  {
+    return string_tags_.find(tracing::attributes::orphan) != string_tags_.end();
+  }
+
+  [[nodiscard]] auto is_key_value() const -> bool
+  {
+    auto service_tag = string_tags_.find(tracing::attributes::service);
+    if (service_tag == string_tags_.end()) {
+      return false;
+    }
+    return service_tag->second == tracing::service::key_value;
+  }
+
+  [[nodiscard]] auto service() const -> std::optional<service_type>
+  {
+    auto service_tag = string_tags_.find(tracing::attributes::service);
+    if (service_tag == string_tags_.end()) {
+      return {};
+    }
+    const auto& service_name = service_tag->second;
+    if (service_name == tracing::service::key_value) {
+      return service_type::key_value;
+    }
+    if (service_name == tracing::service::query) {
+      return service_type::query;
+    }
+    if (service_name == tracing::service::view) {
+      return service_type::view;
+    }
+    if (service_name == tracing::service::search) {
+      return service_type::search;
+    }
+    if (service_name == tracing::service::analytics) {
+      return service_type::analytics;
+    }
+    if (service_name == tracing::service::management) {
+      return service_type::management;
+    }
+    return {};
+  }
 };
 
 template<typename T>
 class concurrent_fixed_queue
 {
-  private:
-    std::mutex mutex_;
-    std::priority_queue<T> data_;
-    std::size_t capacity_{};
-
-  public:
-    using size_type = typename std::priority_queue<T>::size_type;
-
-    explicit concurrent_fixed_queue(std::size_t capacity)
-      : capacity_(capacity)
-    {
-    }
-
-    concurrent_fixed_queue(concurrent_fixed_queue& other)
-    {
-        std::unique_lock<std::mutex> lock(other.mutex_);
-        data_ = other.data_;
-        capacity_ = other.capacity_;
-    }
-
-    concurrent_fixed_queue(const concurrent_fixed_queue& other) = delete;
-
-    concurrent_fixed_queue(concurrent_fixed_queue&& other) noexcept
-    {
-        std::unique_lock<std::mutex> lock(other.mutex_);
-        std::swap(data_, other.data_);
-        std::swap(capacity_, other.capacity_);
-    }
-
-    void pop()
-    {
-        std::unique_lock<std::mutex> lock(mutex_);
-        data_.pop();
-    }
-
-    size_type size()
-    {
-        std::unique_lock<std::mutex> lock(mutex_);
-        return data_.size();
-    }
-
-    bool empty()
-    {
-        std::unique_lock<std::mutex> lock(mutex_);
-        return data_.empty();
-    }
-
-    void emplace(const T&& item)
-    {
-        std::unique_lock<std::mutex> lock(mutex_);
-        data_.emplace(std::forward<const T>(item));
-        if (data_.size() > capacity_) {
-            data_.pop();
-        }
-    }
-
-    std::priority_queue<T> steal_data()
-    {
-        std::priority_queue<T> data;
-        std::unique_lock<std::mutex> lock(mutex_);
-        std::swap(data, data_);
-        return data;
-    }
+private:
+  std::mutex mutex_;
+  std::priority_queue<T> data_;
+  std::size_t capacity_{};
+
+public:
+  using size_type = typename std::priority_queue<T>::size_type;
+
+  explicit concurrent_fixed_queue(std::size_t capacity)
+    : capacity_(capacity)
+  {
+  }
+
+  concurrent_fixed_queue(concurrent_fixed_queue& other)
+  {
+    std::unique_lock<std::mutex> lock(other.mutex_);
+    data_ = other.data_;
+    capacity_ = other.capacity_;
+  }
+
+  concurrent_fixed_queue(const concurrent_fixed_queue& other) = delete;
+
+  concurrent_fixed_queue(concurrent_fixed_queue&& other) noexcept
+  {
+    std::unique_lock<std::mutex> lock(other.mutex_);
+    std::swap(data_, other.data_);
+    std::swap(capacity_, other.capacity_);
+  }
+
+  void pop()
+  {
+    std::unique_lock<std::mutex> lock(mutex_);
+    data_.pop();
+  }
+
+  auto size() -> size_type
+  {
+    std::unique_lock<std::mutex> lock(mutex_);
+    return data_.size();
+  }
+
+  auto empty() -> bool
+  {
+    std::unique_lock<std::mutex> lock(mutex_);
+    return data_.empty();
+  }
+
+  void emplace(const T&& item)
+  {
+    std::unique_lock<std::mutex> lock(mutex_);
+    data_.emplace(std::forward<const T>(item));
+    if (data_.size() > capacity_) {
+      data_.pop();
+    }
+  }
+
+  auto steal_data() -> std::priority_queue<T>
+  {
+    std::priority_queue<T> data;
+    std::unique_lock<std::mutex> lock(mutex_);
+    std::swap(data, data_);
+    return data;
+  }
 };
 
 using fixed_span_queue = concurrent_fixed_queue<reported_span>;
 
-reported_span
-convert(std::shared_ptr<threshold_logging_span> span)
+auto
+convert(std::shared_ptr<threshold_logging_span> span) -> reported_span
 {
-    tao::json::value entry{ { "operation_name", span->name() },
-                            { "total_duration_us", std::chrono::duration_cast<std::chrono::microseconds>(span->duration()).count() } };
-    if (span->is_key_value()) {
-        entry["last_server_duration_us"] = span->last_server_duration_us();
-        entry["total_server_duration_us"] = span->total_server_duration_us();
-    }
-
-    const auto& tags = span->string_tags();
-    auto pair = tags.find(attributes::operation_id);
-    if (pair != tags.end()) {
-        entry["last_operation_id"] = pair->second;
-    }
-
-    pair = tags.find(attributes::local_id);
-    if (pair != tags.end()) {
-        entry["last_local_id"] = pair->second;
-    }
-
-    pair = tags.find(attributes::local_socket);
-    if (pair != tags.end()) {
-        entry["last_local_socket"] = pair->second;
-    }
-
-    pair = tags.find(attributes::remote_socket);
-    if (pair != tags.end()) {
-        entry["last_remote_socket"] = pair->second;
-    }
-
-    return { span->duration(), std::move(entry) };
+  tao::json::value entry{
+    { "operation_name", span->name() },
+    { "total_duration_us",
+      std::chrono::duration_cast<std::chrono::microseconds>(span->duration()).count() }
+  };
+  if (span->is_key_value()) {
+    entry["last_server_duration_us"] = span->last_server_duration_us();
+    entry["total_server_duration_us"] = span->total_server_duration_us();
+  }
+
+  const auto& tags = span->string_tags();
+  auto pair = tags.find(attributes::operation_id);
+  if (pair != tags.end()) {
+    entry["last_operation_id"] = pair->second;
+  }
+
+  pair = tags.find(attributes::local_id);
+  if (pair != tags.end()) {
+    entry["last_local_id"] = pair->second;
+  }
+
+  pair = tags.find(attributes::local_socket);
+  if (pair != tags.end()) {
+    entry["last_local_socket"] = pair->second;
+  }
+
+  pair = tags.find(attributes::remote_socket);
+  if (pair != tags.end()) {
+    entry["last_remote_socket"] = pair->second;
+  }
+
+  return { span->duration(), std::move(entry) };
 }
 
 class threshold_logging_tracer_impl
 {
-  public:
-    threshold_logging_tracer_impl(const threshold_logging_options& options, asio::io_context& ctx)
-      : options_(options)
-      , emit_orphan_report_(ctx)
-      , emit_threshold_report_(ctx)
-      , orphan_queue_{ options.orphaned_sample_size }
-    {
-        threshold_queues_.try_emplace(service_type::key_value, options.threshold_sample_size);
-        threshold_queues_.try_emplace(service_type::query, options.threshold_sample_size);
-        threshold_queues_.try_emplace(service_type::view, options.threshold_sample_size);
-        threshold_queues_.try_emplace(service_type::search, options.threshold_sample_size);
-        threshold_queues_.try_emplace(service_type::analytics, options.threshold_sample_size);
-        threshold_queues_.try_emplace(service_type::management, options.threshold_sample_size);
-    }
-
-    ~threshold_logging_tracer_impl()
-    {
-        emit_orphan_report_.cancel();
-        emit_threshold_report_.cancel();
-
-        log_orphan_report();
-        log_threshold_report();
-    }
-
-    void start()
-    {
-        rearm_orphan_reporter();
-        rearm_threshold_reporter();
-    }
-
-    void stop()
-    {
-        emit_orphan_report_.cancel();
-        emit_threshold_report_.cancel();
-    }
-
-    void add_orphan(std::shared_ptr<threshold_logging_span> span)
-    {
-        orphan_queue_.emplace(convert(std::move(span)));
-    }
-
-    void check_threshold(std::shared_ptr<threshold_logging_span> span)
-    {
-        auto service = span->service();
-        if (!service.has_value()) {
-            return;
-        }
-        if (span->duration() > options_.threshold_for_service(service.value())) {
-            auto queue = threshold_queues_.find(service.value());
-            if (queue != threshold_queues_.end()) {
-                queue->second.emplace(convert(span));
-            }
-        }
-    }
-
-  private:
-    void rearm_orphan_reporter()
-    {
-        emit_orphan_report_.expires_after(options_.orphaned_emit_interval);
-        emit_orphan_report_.async_wait([this](std::error_code ec) {
-            if (ec == asio::error::operation_aborted) {
-                return;
-            }
-            log_orphan_report();
-            rearm_orphan_reporter();
-        });
-    }
-
-    void rearm_threshold_reporter()
-    {
-        emit_threshold_report_.expires_after(options_.threshold_emit_interval);
-        emit_threshold_report_.async_wait([this](std::error_code ec) {
-            if (ec == asio::error::operation_aborted) {
-                return;
-            }
-            log_threshold_report();
-            rearm_threshold_reporter();
-        });
-    }
-
-    void log_orphan_report()
-    {
-        if (orphan_queue_.empty()) {
-            return;
-        }
-        auto queue = orphan_queue_.steal_data();
-        tao::json::value report
-        {
-            { "count", queue.size() },
+public:
+  threshold_logging_tracer_impl(const threshold_logging_options& options, asio::io_context& ctx)
+    : options_(options)
+    , emit_orphan_report_(ctx)
+    , emit_threshold_report_(ctx)
+    , orphan_queue_{ options.orphaned_sample_size }
+  {
+    threshold_queues_.try_emplace(service_type::key_value, options.threshold_sample_size);
+    threshold_queues_.try_emplace(service_type::query, options.threshold_sample_size);
+    threshold_queues_.try_emplace(service_type::view, options.threshold_sample_size);
+    threshold_queues_.try_emplace(service_type::search, options.threshold_sample_size);
+    threshold_queues_.try_emplace(service_type::analytics, options.threshold_sample_size);
+    threshold_queues_.try_emplace(service_type::management, options.threshold_sample_size);
+  }
+
+  ~threshold_logging_tracer_impl()
+  {
+    emit_orphan_report_.cancel();
+    emit_threshold_report_.cancel();
+
+    log_orphan_report();
+    log_threshold_report();
+  }
+
+  void start()
+  {
+    rearm_orphan_reporter();
+    rearm_threshold_reporter();
+  }
+
+  void stop()
+  {
+    emit_orphan_report_.cancel();
+    emit_threshold_report_.cancel();
+  }
+
+  void add_orphan(std::shared_ptr<threshold_logging_span> span)
+  {
+    orphan_queue_.emplace(convert(std::move(span)));
+  }
+
+  void check_threshold(std::shared_ptr<threshold_logging_span> span)
+  {
+    auto service = span->service();
+    if (!service.has_value()) {
+      return;
+    }
+    if (span->duration() > options_.threshold_for_service(service.value())) {
+      auto queue = threshold_queues_.find(service.value());
+      if (queue != threshold_queues_.end()) {
+        queue->second.emplace(convert(span));
+      }
+    }
+  }
+
+private:
+  void rearm_orphan_reporter()
+  {
+    emit_orphan_report_.expires_after(options_.orphaned_emit_interval);
+    emit_orphan_report_.async_wait([this](std::error_code ec) {
+      if (ec == asio::error::operation_aborted) {
+        return;
+      }
+      log_orphan_report();
+      rearm_orphan_reporter();
+    });
+  }
+
+  void rearm_threshold_reporter()
+  {
+    emit_threshold_report_.expires_after(options_.threshold_emit_interval);
+    emit_threshold_report_.async_wait([this](std::error_code ec) {
+      if (ec == asio::error::operation_aborted) {
+        return;
+      }
+      log_threshold_report();
+      rearm_threshold_reporter();
+    });
+  }
+
+  void log_orphan_report()
+  {
+    if (orphan_queue_.empty()) {
+      return;
+    }
+    auto queue = orphan_queue_.steal_data();
+    tao::json::value report{
+      { "count", queue.size() },
 #if COUCHBASE_CXX_CLIENT_DEBUG_BUILD
-              { "emit_interval_ms", options_.orphaned_emit_interval.count() }, { "sample_size", options_.orphaned_sample_size },
+      { "emit_interval_ms", options_.orphaned_emit_interval.count() },
+      { "sample_size", options_.orphaned_sample_size },
 #endif
-        };
-        tao::json::value entries = tao::json::empty_array;
-        while (!queue.empty()) {
-            entries.emplace_back(queue.top().payload);
-            queue.pop();
-        }
-        report["top"] = entries;
-        CB_LOG_WARNING("Orphan responses observed: {}", utils::json::generate(report));
-    }
-
-    void log_threshold_report()
-    {
-        for (auto& [service, threshold_queue] : threshold_queues_) {
-            if (threshold_queue.empty()) {
-                continue;
-            }
-            auto queue = threshold_queue.steal_data();
-            tao::json::value report
-            {
-                { "count", queue.size() }, { "service", fmt::format("{}", service) },
+    };
+    tao::json::value entries = tao::json::empty_array;
+    while (!queue.empty()) {
+      entries.emplace_back(queue.top().payload);
+      queue.pop();
+    }
+    report["top"] = entries;
+    CB_LOG_WARNING("Orphan responses observed: {}", utils::json::generate(report));
+  }
+
+  void log_threshold_report()
+  {
+    for (auto& [service, threshold_queue] : threshold_queues_) {
+      if (threshold_queue.empty()) {
+        continue;
+      }
+      auto queue = threshold_queue.steal_data();
+      tao::json::value report{
+        { "count", queue.size() },
+        { "service", fmt::format("{}", service) },
 #if COUCHBASE_CXX_CLIENT_DEBUG_BUILD
-                  { "emit_interval_ms", options_.threshold_emit_interval.count() }, { "sample_size", options_.threshold_sample_size },
-                  { "threshold_ms",
-                    std::chrono::duration_cast<std::chrono::microseconds>(options_.threshold_for_service(service)).count() },
+        { "emit_interval_ms", options_.threshold_emit_interval.count() },
+        { "sample_size", options_.threshold_sample_size },
+        { "threshold_ms",
+          std::chrono::duration_cast<std::chrono::microseconds>(
+            options_.threshold_for_service(service))
+            .count() },
 #endif
-            };
-            tao::json::value entries = tao::json::empty_array;
-            while (!queue.empty()) {
-                entries.emplace_back(queue.top().payload);
-                queue.pop();
-            }
-            report["top"] = entries;
-            CB_LOG_WARNING("Operations over threshold: {}", utils::json::generate(report));
-        }
-    }
-
-    const threshold_logging_options& options_;
-
-    asio::steady_timer emit_orphan_report_;
-    asio::steady_timer emit_threshold_report_;
-    fixed_span_queue orphan_queue_;
-    std::map<service_type, fixed_span_queue> threshold_queues_{};
+      };
+      tao::json::value entries = tao::json::empty_array;
+      while (!queue.empty()) {
+        entries.emplace_back(queue.top().payload);
+        queue.pop();
+      }
+      report["top"] = entries;
+      CB_LOG_WARNING("Operations over threshold: {}", utils::json::generate(report));
+    }
+  }
+
+  const threshold_logging_options& options_;
+
+  asio::steady_timer emit_orphan_report_;
+  asio::steady_timer emit_threshold_report_;
+  fixed_span_queue orphan_queue_;
+  std::map<service_type, fixed_span_queue> threshold_queues_{};
 };
 
-std::shared_ptr<couchbase::tracing::request_span>
-threshold_logging_tracer::start_span(std::string name, std::shared_ptr<couchbase::tracing::request_span> parent)
+auto
+threshold_logging_tracer::start_span(std::string name,
+                                     std::shared_ptr<couchbase::tracing::request_span> parent)
+  -> std::shared_ptr<couchbase::tracing::request_span>
 {
-    return std::make_shared<threshold_logging_span>(std::move(name), shared_from_this(), parent);
+  return std::make_shared<threshold_logging_span>(std::move(name), shared_from_this(), parent);
 }
 
 void
 threshold_logging_tracer::report(std::shared_ptr<threshold_logging_span> span)
 {
-    if (span->orphan()) {
-        impl_->add_orphan(std::move(span));
-    } else {
-        impl_->check_threshold(std::move(span));
-    }
+  if (span->orphan()) {
+    impl_->add_orphan(std::move(span));
+  } else {
+    impl_->check_threshold(std::move(span));
+  }
 }
 
-threshold_logging_tracer::threshold_logging_tracer(asio::io_context& ctx, threshold_logging_options options)
+threshold_logging_tracer::threshold_logging_tracer(asio::io_context& ctx,
+                                                   threshold_logging_options options)
   : options_{ options }
   , impl_(std::make_shared<threshold_logging_tracer_impl>(options_, ctx))
 {
@@ -419,20 +428,21 @@ threshold_logging_tracer::threshold_logging_tracer(asio::io_context& ctx, thresh
 void
 threshold_logging_tracer::start()
 {
-    impl_->start();
+  impl_->start();
 }
 
 void
 threshold_logging_tracer::stop()
 {
-    impl_->stop();
+  impl_->stop();
 }
 
 void
 threshold_logging_span::end()
 {
-    duration_ = std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::system_clock::now() - start_);
-    tracer_->report(shared_from_this());
+  duration_ = std::chrono::duration_cast<std::chrono::microseconds>(
+    std::chrono::system_clock::now() - start_);
+  tracer_->report(shared_from_this());
 }
 
 } // namespace couchbase::core::tracing