added abstract IMetric class and implementations for Solomon, Prometheus, OpenTelemetry

asmyasnikov · asmyasnikov · commit dbeb92b77bd0 · 2025-03-21T16:02:22.000+03:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -7,6 +7,15 @@ option(YDB_SDK_EXAMPLES "Build YDB C++ SDK examples" On)
 set(YDB_SDK_GOOGLE_COMMON_PROTOS_TARGET "" CACHE STRING "Name of cmake target preparing google common proto library")
 option(YDB_SDK_USE_RAPID_JSON "Search for rapid json library in system" ON)
 
+# Опции для систем мониторинга
+option(YDB_SDK_MONITORING_PROMETHEUS "Enable Prometheus monitoring" OFF)
+option(YDB_SDK_MONITORING_OPENTELEMETRY "Enable OpenTelemetry monitoring" OFF)
+option(YDB_SDK_MONITORING_DATADOG "Enable Datadog monitoring" OFF)
+option(YDB_SDK_MONITORING_NEWRELIC "Enable New Relic monitoring" OFF)
+option(YDB_SDK_MONITORING_APPDYNAMICS "Enable AppDynamics monitoring" OFF)
+option(YDB_SDK_MONITORING_VICTORIAMETRICS "Enable Victoria Metrics monitoring" OFF)
+option(YDB_SDK_MONITORING_SOLOMON "Enable Yandex Solomon monitoring" ON)
+
 set(BUILD_SHARED_LIBS Off)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED On)
@@ -97,3 +106,38 @@ if (YDB_SDK_INSTALL)
     DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ydb-cpp-sdk/Modules
   )
 endif()
+
+# Поиск зависимостей для систем мониторинга
+if(YDB_SDK_MONITORING_PROMETHEUS)
+    find_package(Prometheus REQUIRED)
+endif()
+
+if(YDB_SDK_MONITORING_OPENTELEMETRY)
+    find_package(OpenTelemetry REQUIRED)
+endif()
+
+if(YDB_SDK_MONITORING_DATADOG)
+    find_package(Datadog REQUIRED)
+endif()
+
+if(YDB_SDK_MONITORING_NEWRELIC)
+    find_package(NewRelic REQUIRED)
+endif()
+
+if(YDB_SDK_MONITORING_APPDYNAMICS)
+    find_package(AppDynamics REQUIRED)
+endif()
+
+if(YDB_SDK_MONITORING_VICTORIAMETRICS)
+    find_package(VictoriaMetrics REQUIRED)
+endif()
+
+# Добавляем зависимости в target_link_libraries
+target_link_libraries(ydb-cpp-sdk
+    $<$<BOOL:${YDB_SDK_MONITORING_PROMETHEUS}>:prometheus::prometheus-cpp>
+    $<$<BOOL:${YDB_SDK_MONITORING_OPENTELEMETRY}>:OpenTelemetry::OpenTelemetry>
+    $<$<BOOL:${YDB_SDK_MONITORING_DATADOG}>:Datadog::Datadog>
+    $<$<BOOL:${YDB_SDK_MONITORING_NEWRELIC}>:NewRelic::NewRelic>
+    $<$<BOOL:${YDB_SDK_MONITORING_APPDYNAMICS}>:AppDynamics::AppDynamics>
+    $<$<BOOL:${YDB_SDK_MONITORING_VICTORIAMETRICS}>:VictoriaMetrics::VictoriaMetrics>
+)
diff --git a/docs/monitoring.md b/docs/monitoring.md
@@ -0,0 +1,94 @@
+# Мониторинг в YDB C++ SDK
+
+YDB C++ SDK поддерживает различные системы мониторинга для сбора метрик. Вы можете выбрать одну или несколько систем мониторинга при сборке проекта.
+
+## Поддерживаемые системы мониторинга
+
+- Prometheus
+- OpenTelemetry
+- Datadog
+- New Relic
+- AppDynamics
+- Victoria Metrics
+- Yandex Solomon (по умолчанию)
+
+## Настройка сборки
+
+При сборке проекта вы можете включить поддержку нужных систем мониторинга с помощью CMake опций:
+
+```cmake
+cmake -DYDB_SDK_MONITORING_PROMETHEUS=ON \
+      -DYDB_SDK_MONITORING_OPENTELEMETRY=ON \
+      -DYDB_SDK_MONITORING_DATADOG=ON \
+      -DYDB_SDK_MONITORING_NEWRELIC=ON \
+      -DYDB_SDK_MONITORING_APPDYNAMICS=ON \
+      -DYDB_SDK_MONITORING_VICTORIAMETRICS=ON \
+      -DYDB_SDK_MONITORING_SOLOMON=ON \
+      ..
+```
+
+## Использование
+
+### Prometheus
+
+```cpp
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <ydb-cpp-sdk/client/monitoring/impl/prometheus.h>
+
+// Создаем систему мониторинга
+auto monitoringSystem = TMonitoringSystemFactory::CreatePrometheus("localhost:9090");
+TMetricsContext::Instance().SetMonitoringSystem(std::move(monitoringSystem));
+
+// Создаем метрику
+std::unordered_map<std::string, std::string> labels = {
+    {"operation", "query"},
+    {"status", "success"}
+};
+TPrometheusMetric metric("ydb_query_count", "1", labels);
+
+// Записываем метрику
+TMetricsContext::Instance().RecordMetric(metric);
+```
+
+### OpenTelemetry
+
+```cpp
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <ydb-cpp-sdk/client/monitoring/impl/opentelemetry.h>
+
+// Создаем систему мониторинга
+auto monitoringSystem = TMonitoringSystemFactory::CreateOpenTelemetry("localhost:4317");
+TMetricsContext::Instance().SetMonitoringSystem(std::move(monitoringSystem));
+
+// Создаем метрику
+std::unordered_map<std::string, std::string> labels = {
+    {"operation", "query"},
+    {"status", "success"}
+};
+TOpenTelemetryMetric metric("ydb_query_count", "1", labels);
+
+// Записываем метрику
+TMetricsContext::Instance().RecordMetric(metric);
+```
+
+## Доступные метрики
+
+YDB C++ SDK собирает следующие метрики:
+
+- `ydb_query_count` - количество запросов
+- `ydb_query_latency` - задержка запросов
+- `ydb_error_count` - количество ошибок
+- `ydb_connection_count` - количество активных соединений
+- `ydb_session_count` - количество активных сессий
+
+## Примеры
+
+Полные примеры использования различных систем мониторинга можно найти в директории `examples/monitoring/`:
+
+- `prometheus_example.cpp` - пример использования Prometheus
+- `opentelemetry_example.cpp` - пример использования OpenTelemetry
+- `datadog_example.cpp` - пример использования Datadog
+- `newrelic_example.cpp` - пример использования New Relic
+- `appdynamics_example.cpp` - пример использования AppDynamics
+- `victoriametrics_example.cpp` - пример использования Victoria Metrics
+- `solomon_example.cpp` - пример использования Yandex Solomon 
diff --git a/examples/monitoring/opentelemetry_example.cpp b/examples/monitoring/opentelemetry_example.cpp
@@ -0,0 +1,28 @@
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <ydb-cpp-sdk/client/monitoring/impl/opentelemetry.h>
+#include <ydb-cpp-sdk/client/driver/driver.h>
+#include <iostream>
+
+using namespace NYdb;
+using namespace NYdb::NMonitoring;
+
+int main() {
+    // Создаем систему мониторинга OpenTelemetry
+    auto monitoringSystem = TMonitoringSystemFactory::CreateOpenTelemetry("localhost:4317");
+    TMetricsContext::Instance().SetMonitoringSystem(std::move(monitoringSystem));
+
+    // Создаем метрику
+    std::unordered_map<std::string, std::string> labels = {
+        {"operation", "query"},
+        {"status", "success"}
+    };
+    TOpenTelemetryMetric metric("ydb_query_count", "1", labels);
+
+    // Записываем метрику
+    TMetricsContext::Instance().RecordMetric(metric);
+
+    // Принудительно отправляем метрики
+    TMetricsContext::Instance().Flush();
+
+    return 0;
+} 
diff --git a/examples/monitoring/prometheus_example.cpp b/examples/monitoring/prometheus_example.cpp
@@ -0,0 +1,28 @@
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <ydb-cpp-sdk/client/monitoring/impl/prometheus.h>
+#include <ydb-cpp-sdk/client/driver/driver.h>
+#include <iostream>
+
+using namespace NYdb;
+using namespace NYdb::NMonitoring;
+
+int main() {
+    // Создаем систему мониторинга Prometheus
+    auto monitoringSystem = TMonitoringSystemFactory::CreatePrometheus("localhost:9090");
+    TMetricsContext::Instance().SetMonitoringSystem(std::move(monitoringSystem));
+
+    // Создаем метрику
+    std::unordered_map<std::string, std::string> labels = {
+        {"operation", "query"},
+        {"status", "success"}
+    };
+    TPrometheusMetric metric("ydb_query_count", "1", labels);
+
+    // Записываем метрику
+    TMetricsContext::Instance().RecordMetric(metric);
+
+    // Принудительно отправляем метрики
+    TMetricsContext::Instance().Flush();
+
+    return 0;
+} 
diff --git a/examples/monitoring_example.cpp b/examples/monitoring_example.cpp
@@ -0,0 +1,27 @@
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <ydb-cpp-sdk/client/driver/driver.h>
+#include <iostream>
+
+using namespace NYdb;
+using namespace NYdb::NMonitoring;
+
+int main() {
+    // Создаем систему мониторинга Prometheus
+    auto monitoringSystem = TMonitoringSystemFactory::CreatePrometheus("localhost:9090");
+    TMetricsContext::Instance().SetMonitoringSystem(std::move(monitoringSystem));
+
+    // Создаем метрику
+    std::unordered_map<std::string, std::string> labels = {
+        {"operation", "query"},
+        {"status", "success"}
+    };
+    TPrometheusMetric metric("ydb_query_count", "1", labels);
+
+    // Записываем метрику
+    TMetricsContext::Instance().RecordMetric(metric);
+
+    // Принудительно отправляем метрики
+    TMetricsContext::Instance().Flush();
+
+    return 0;
+} 
diff --git a/include/ydb-cpp-sdk/client/monitoring/impl/opentelemetry.h b/include/ydb-cpp-sdk/client/monitoring/impl/opentelemetry.h
@@ -0,0 +1,47 @@
+#pragma once
+
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <opentelemetry/sdk/metrics/meter_provider.h>
+#include <opentelemetry/sdk/metrics/metric_reader.h>
+#include <opentelemetry/sdk/metrics/push_metric_exporter.h>
+
+namespace NYdb::NMonitoring {
+
+class TOpenTelemetryMetric : public IMetric {
+public:
+    TOpenTelemetryMetric(const std::string& name, const std::string& value, 
+                        const std::unordered_map<std::string, std::string>& labels)
+        : Name_(name)
+        , Value_(value)
+        , Labels_(labels)
+    {}
+
+    std::string GetName() const override { return Name_; }
+    std::string GetValue() const override { return Value_; }
+    std::unordered_map<std::string, std::string> GetLabels() const override { return Labels_; }
+
+private:
+    std::string Name_;
+    std::string Value_;
+    std::unordered_map<std::string, std::string> Labels_;
+};
+
+class TOpenTelemetryMonitoringSystem : public IMonitoringSystem {
+public:
+    explicit TOpenTelemetryMonitoringSystem(const std::string& endpoint)
+        : Endpoint_(endpoint)
+    {
+        Initialize();
+    }
+
+    void RecordMetric(const IMetric& metric) override;
+    void Flush() override;
+
+private:
+    void Initialize();
+    std::string Endpoint_;
+    std::shared_ptr<opentelemetry::sdk::metrics::MeterProvider> MeterProvider_;
+    std::shared_ptr<opentelemetry::sdk::metrics::MetricReader> MetricReader_;
+};
+
+} // namespace NYdb::NMonitoring 
diff --git a/include/ydb-cpp-sdk/client/monitoring/impl/prometheus.h b/include/ydb-cpp-sdk/client/monitoring/impl/prometheus.h
@@ -0,0 +1,47 @@
+#pragma once
+
+#include <ydb-cpp-sdk/client/monitoring/metrics.h>
+#include <prometheus/counter.h>
+#include <prometheus/gauge.h>
+#include <prometheus/exposer.h>
+#include <prometheus/registry.h>
+
+namespace NYdb::NMonitoring {
+
+class TPrometheusMetric : public IMetric {
+public:
+    TPrometheusMetric(const std::string& name, const std::string& value, 
+                      const std::unordered_map<std::string, std::string>& labels)
+        : Name_(name)
+        , Value_(value)
+        , Labels_(labels)
+    {}
+
+    std::string GetName() const override { return Name_; }
+    std::string GetValue() const override { return Value_; }
+    std::unordered_map<std::string, std::string> GetLabels() const override { return Labels_; }
+
+private:
+    std::string Name_;
+    std::string Value_;
+    std::unordered_map<std::string, std::string> Labels_;
+};
+
+class TPrometheusMonitoringSystem : public IMonitoringSystem {
+public:
+    explicit TPrometheusMonitoringSystem(const std::string& endpoint)
+        : Exposer_(endpoint)
+        , Registry_(std::make_shared<prometheus::Registry>())
+    {
+        Exposer_.RegisterCollectable(Registry_);
+    }
+
+    void RecordMetric(const IMetric& metric) override;
+    void Flush() override;
+
+private:
+    prometheus::Exposer Exposer_;
+    std::shared_ptr<prometheus::Registry> Registry_;
+};
+
+} // namespace NYdb::NMonitoring 
diff --git a/include/ydb-cpp-sdk/client/monitoring/metrics.h b/include/ydb-cpp-sdk/client/monitoring/metrics.h
diff --git a/src/client/monitoring/prometheus.cpp b/src/client/monitoring/prometheus.cpp
