Support tracing in SDK

Author: user2

CMakeLists.txt

@@ -7,6 +7,8 @@ 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_TRACING "Enable tracing support" ON)
+
 set(BUILD_SHARED_LIBS Off)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED On)

cmake/external_libs.cmake

@@ -15,6 +15,11 @@ find_package(jwt-cpp REQUIRED)
 find_package(GTest REQUIRED)
 find_package(double-conversion REQUIRED)
 
+# OpenTelemetry
+if(YDB_SDK_TRACING)
+  find_package(opentelemetry-cpp REQUIRED)
+endif()
+
 # RapidJSON
 if (YDB_SDK_USE_RAPID_JSON)
   find_package(RapidJSON REQUIRED)
@@ -85,4 +90,4 @@ target_include_directories(nayuki_md5 PUBLIC
   $<INSTALL_INTERFACE:third_party/nayuki_md5>
 )
 
-_ydb_sdk_install_targets(TARGETS nayuki_md5)
+_ydb_sdk_install_targets(TARGETS nayuki_md5)

examples/tracing/CMakeLists.txt

@@ -0,0 +1,11 @@
+add_executable(tracing_example tracing_example.cpp)
+
+if(YDB_SDK_TRACING)
+    target_link_libraries(tracing_example PRIVATE
+            ydb-cpp-sdk
+            ${OPENTELEMETRY_LIBRARIES}
+    )
+else()
+    target_link_libraries(tracing_example PRIVATE ydb-cpp-sdk)
+    target_compile_definitions(tracing_example PRIVATE -DYDB_SDK_TRACING_DISABLED)
+endif()

examples/tracing/tracing_example.cpp

@@ -4,23 +4,19 @@
 #include <ydb-cpp-sdk/client/driver.h>
 
 int main() {
-    // 1. Настройка OpenTelemetry с экспортером в Jaeger
     auto exporter = opentelemetry::exporter::jaeger::JaegerExporterFactory::Create();
     auto provider = opentelemetry::sdk::trace::TracerProviderFactory::Create(std::move(exporter));
-    auto otel_tracer = provider->GetTracer("ydb-cpp-sdk");
+    auto otelTracer = provider->GetTracer("ydb-cpp-sdk");
 
-    // 2. Создание адаптера для YDB SDK
-    auto ydb_tracer = std::make_shared<NYdb::NTracing::TOpenTelemetryTracer>(otel_tracer);
+    auto ydbTracer = std::make_shared<NYdb::NTracing::TOpenTelemetryTracer>(otelTracer);
 
-    // 3. Инициализация драйвера YDB с трейсером
     auto driver = NYdb::TDriver(
         NYdb::TDriverConfig()
-            .SetEndpoint("grpc://localhost:2136")
+            .SetEndpoint("localhost:2136")
             .SetDatabase("/local")
-            .SetTracer(ydb_tracer)
+            .SetTracer(ydbTracer)
     );
 
-    // 4. Тестовый запрос (спан создастся автоматически внутри SDK)
     auto client = NYdb::NTable::TTableClient(driver);
     auto session = client.CreateSession().GetValueSync();
     session.ExecuteDataQuery("SELECT 1", NYdb::NTable::TTxControl::BeginTx().CommitTx()).GetValueSync();

include/ydb-cpp-sdk/client/driver/driver.h

@@ -8,6 +8,7 @@
 #include <ydb-cpp-sdk/client/types/fatal_error_handlers/handlers.h>
 #include <ydb-cpp-sdk/client/types/request_settings.h>
 #include <ydb-cpp-sdk/client/types/status/status.h>
+#include <ydb-cpp-sdk/client/tracing/tracer.h>
 
 #include <library/cpp/logger/backend.h>
 

include/ydb-cpp-sdk/client/tracing/noop_tracer.h

@@ -9,7 +9,6 @@ namespace NTracing {
 
 using TAttributeMap = std::unordered_map<std::string, std::string>;
 
-// Контекст с идентификаторами трассировки
 class TTraceContext {
 public:
     TTraceContext(std::string traceId, std::string spanId, std::string parentSpanId = "")
@@ -22,13 +21,8 @@ class TTraceContext {
     const std::string& GetSpanId() const { return SpanId_; }
     const std::string& GetParentSpanId() const { return ParentSpanId_; }
 
-    // Генерация нового контекста (создает новые уникальные traceId и spanId)
     static std::shared_ptr<TTraceContext> GenerateNew();
-
-    // Создание дочернего контекста (новый spanId, тот же traceId)
     std::shared_ptr<TTraceContext> CreateChild() const;
-
-    // Формирование W3C traceparent ("00-traceId-spanId-01")
     std::string ToTraceParent() const;
 
 private:
@@ -55,16 +49,13 @@ class ITracer {
 public:
     virtual ~ITracer() = default;
 
-    // Создать новый спан с именем, атрибутами и опциональным родительским контекстом
     virtual std::unique_ptr<ISpan> StartSpan(
         const std::string& name,
         const TAttributeMap& attributes = {},
         std::shared_ptr<TTraceContext> parentContext = nullptr) = 0;
 
-    // Получить текущий контекст
     virtual std::shared_ptr<TTraceContext> GetCurrentContext() const = 0;
 
-    // Получить W3C traceparent текущего контекста (если есть)
     virtual std::string GetCurrentTraceParent() const {
         if (auto ctx = GetCurrentContext()) {
             return ctx->ToTraceParent();

include/ydb-cpp-sdk/client/tracing/otel_tracer.h

@@ -1,4 +1,5 @@
 #include <ydb-cpp-sdk/client/driver/driver.h>
+#include <ydb-cpp-sdk/client/tracing/tracer.h>
 
 #define INCLUDE_YDB_INTERNAL_H
 #include <src/client/impl/ydb_internal/driver/constants.h>
@@ -203,6 +204,11 @@ TDriverConfig& TDriverConfig::SetLog(std::unique_ptr<TLogBackend>&& log) {
     return *this;
 }
 
+TDriverConfig& TDriverConfig::SetTracer(std::shared_ptr<NTracing::ITracer> tracer) {
+    Impl_->Tracer_ = tracer ? tracer : std::make_shared<NTracing::TNoopTracer>();
+    return *this;
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 
 std::shared_ptr<TGRpcConnectionsImpl> CreateInternalInterface(const TDriver connection) {

include/ydb-cpp-sdk/client/tracing/tracer.h

@@ -0,0 +1,37 @@
+#pragma once
+
+#include <ydb-cpp-sdk/client/tracing/tracer.h>
+
+namespace NYdb::inline V3 {
+namespace NTracing {
+
+    class TNoopSpan : public ISpan {
+    public:
+        void AddAttribute(const std::string&, const std::string&) override {}
+        void AddEvent(const std::string&, const TAttributeMap& = {}) override {}
+        void SetStatus(bool, const std::string& = "") override {}
+        void End() override {}
+
+        const TTraceContext& GetContext() const override {
+            static TTraceContext emptyContext("", "");
+            return emptyContext;
+        }
+    };
+
+    class TNoopTracer : public ITracer {
+    public:
+        std::unique_ptr<ISpan> StartSpan(
+            const std::string&,
+            const TAttributeMap& = {},
+            std::shared_ptr<TTraceContext> = nullptr) override
+        {
+            return std::make_unique<TNoopSpan>();
+        }
+
+        std::shared_ptr<TTraceContext> GetCurrentContext() const override {
+            return nullptr;
+        }
+    };
+
+} // namespace NTracing
+} // namespace NYdb