Updated version up to v3.16.0 (#594)

Author: Gazizonoki

examples/otel_tracing/README.md

@@ -73,7 +73,7 @@ cmake --build . --target otel_tracing_example -j$(nproc)
 |-----------|------------------------------|---------------------------------|
 | Grafana   | http://localhost:3000         | Дашборд "YDB QueryService"     |
 | Jaeger    | http://localhost:16686        | Поиск трейсов по сервису        |
-| Prometheus| http://localhost:9090         | Метрики `ydb_ydb_query_*`      |
+| Prometheus| http://localhost:9090         | Метрики `ydb_query_*`      |
 
 **Grafana**: логин `admin` / пароль `admin`.
 
@@ -96,9 +96,9 @@ cmake --build . --target otel_tracing_example -j$(nproc)
   - `db.response.status_code`, `error.type` (при ошибках)
 
 #### В Prometheus:
-- `ydb_ydb_query_requests_total` — счётчик запросов
-- `ydb_ydb_query_errors_total` — счётчик ошибок
-- `ydb_ydb_query_latency_ms_bucket` — гистограмма задержек
+- `ydb_query_requests_total` — счётчик запросов
+- `ydb_query_errors_total` — счётчик ошибок
+- `ydb_query_latency_ms_bucket` — гистограмма задержек
 
 ### 6. Остановить
 

examples/otel_tracing/main.cpp

@@ -190,7 +190,7 @@ int main(int argc, char** argv) {
     auto tracerProvider = InitTracing(cfg);
     auto meterProvider = InitMetrics(cfg);
 
-    auto ydbTraceProvider = NMetrics::CreateOtelTraceProvider(tracerProvider);
+    auto ydbTraceProvider = NTrace::CreateOtelTraceProvider(tracerProvider);
     auto ydbMetricRegistry = NMetrics::CreateOtelMetricRegistry(meterProvider);
 
     std::cout << "Connecting to YDB at " << cfg.Endpoint << cfg.Database << std::endl;

src/client/query/client.cpp

@@ -477,11 +477,9 @@ class TQueryClient::TImpl: public TClientImplCommon<TQueryClient::TImpl>, public
     TAsyncCreateSessionResult GetSession(const TCreateSessionSettings& settings) {
         class TQueryClientGetSessionCtx : public NSessionPool::IGetSessionCtx {
         public:
-            TQueryClientGetSessionCtx(std::shared_ptr<TQueryClient::TImpl> client
-                , const TCreateSessionSettings& settings
-                , std::shared_ptr<NObservability::TOperationSpan> span
-                , std::shared_ptr<NObservability::TOperationMetrics> metrics
-            ) : Promise(NThreading::NewPromise<TCreateSessionResult>())
+            TQueryClientGetSessionCtx(std::shared_ptr<TQueryClient::TImpl> client, const TCreateSessionSettings& settings,
+                std::shared_ptr<NObservability::TOperationSpan> span, std::shared_ptr<NObservability::TOperationMetrics> metrics)
+                : Promise(NThreading::NewPromise<TCreateSessionResult>())
                 , Client(client)
                 , RpcSettings(TRpcRequestSettings::Make(settings))
                 , Span(span)

src/version.h

@@ -2,7 +2,7 @@
 
 namespace NYdb {
 
-inline const char* YDB_SDK_VERSION = "3.14.0";
+inline const char* YDB_SDK_VERSION = "3.16.0";
 inline const char* YDB_CERTIFICATE_FILE_KEY = "ydb_root_ca_v3.pem";
 
 } // namespace NYdb

tests/common/fake_trace_provider.h

@@ -12,7 +12,7 @@ struct TFakeEvent {
     std::map<std::string, std::string> Attributes;
 };
 
-class TFakeSpan : public NMetrics::ISpan {
+class TFakeSpan : public NTrace::ISpan {
 public:
     void End() override {
         std::lock_guard lock(Mutex_);
@@ -74,9 +74,9 @@ class TFakeSpan : public NMetrics::ISpan {
     std::vector<TFakeEvent> Events_;
 };
 
-class TFakeTracer : public NMetrics::ITracer {
+class TFakeTracer : public NTrace::ITracer {
 public:
-    std::shared_ptr<NMetrics::ISpan> StartSpan(const std::string& name, NMetrics::ESpanKind kind) override {
+    std::shared_ptr<NTrace::ISpan> StartSpan(const std::string& name, NTrace::ESpanKind kind) override {
         auto span = std::make_shared<TFakeSpan>();
         std::lock_guard lock(Mutex_);
         Spans_.push_back({name, kind, span});
@@ -85,7 +85,7 @@ class TFakeTracer : public NMetrics::ITracer {
 
     struct TSpanRecord {
         std::string Name;
-        NMetrics::ESpanKind Kind;
+        NTrace::ESpanKind Kind;
         std::shared_ptr<TFakeSpan> Span;
     };
 
@@ -114,9 +114,9 @@ class TFakeTracer : public NMetrics::ITracer {
     std::vector<TSpanRecord> Spans_;
 };
 
-class TFakeTraceProvider : public NMetrics::ITraceProvider {
+class TFakeTraceProvider : public NTrace::ITraceProvider {
 public:
-    std::shared_ptr<NMetrics::ITracer> GetTracer(const std::string& name) override {
+    std::shared_ptr<NTrace::ITracer> GetTracer(const std::string& name) override {
         std::lock_guard lock(Mutex_);
         auto it = Tracers_.find(name);
         if (it != Tracers_.end()) {

tests/unit/client/CMakeLists.txt

@@ -123,7 +123,8 @@ add_ydb_test(NAME client-ydb_query_spans_ut GTEST
     query/query_spans_ut.cpp
   LINK_LIBRARIES
     yutil
-    client-ydb_query-impl
+    impl-observability
+    client-types
     client-trace
   LABELS
     unit

tests/unit/client/query/query_spans_ut.cpp

@@ -1,11 +1,14 @@
-#include <src/client/query/impl/query_spans.h>
+#include <src/client/impl/observability/operation_span.h>
 #include <tests/common/fake_trace_provider.h>
 
+#include <library/cpp/logger/log.h>
+
 #include <gtest/gtest.h>
 
 using namespace NYdb;
-using namespace NYdb::NQuery;
-using namespace NYdb::NMetrics;
+using namespace NYdb::NObservability;
+
+using namespace NYdb::NTrace;
 using namespace NYdb::NTests;
 
 class QuerySpanTest : public ::testing::Test {
@@ -18,23 +21,23 @@ class QuerySpanTest : public ::testing::Test {
 };
 
 TEST_F(QuerySpanTest, SpanNameFormat) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "localhost:2135");
+    TOperationSpan span(Tracer, "ExecuteQuery", "localhost:2135", TLog());
     span.End(EStatus::SUCCESS);
 
     ASSERT_EQ(Tracer->SpanCount(), 1u);
     EXPECT_EQ(Tracer->GetLastSpanRecord().Name, "ydb.ExecuteQuery");
 }
 
 TEST_F(QuerySpanTest, SpanKindIsClient) {
-    TQuerySpan span(Tracer, "CreateSession", "localhost:2135");
+    TOperationSpan span(Tracer, "CreateSession", "localhost:2135", TLog());
     span.End(EStatus::SUCCESS);
 
     ASSERT_EQ(Tracer->SpanCount(), 1u);
     EXPECT_EQ(Tracer->GetLastSpanRecord().Kind, ESpanKind::CLIENT);
 }
 
 TEST_F(QuerySpanTest, DbSystemAttribute) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "localhost:2135");
+    TOperationSpan span(Tracer, "ExecuteQuery", "localhost:2135", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -43,7 +46,7 @@ TEST_F(QuerySpanTest, DbSystemAttribute) {
 }
 
 TEST_F(QuerySpanTest, ServerAddressAndPort) {
-    TQuerySpan span(Tracer, "Commit", "ydb.server:2135");
+    TOperationSpan span(Tracer, "Commit", "ydb.server:2135", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -53,7 +56,7 @@ TEST_F(QuerySpanTest, ServerAddressAndPort) {
 }
 
 TEST_F(QuerySpanTest, ServerAddressCustomPort) {
-    TQuerySpan span(Tracer, "Rollback", "myhost:9090");
+    TOperationSpan span(Tracer, "Rollback", "myhost:9090", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -63,7 +66,7 @@ TEST_F(QuerySpanTest, ServerAddressCustomPort) {
 }
 
 TEST_F(QuerySpanTest, ServerAddressNoPortDefaultsTo2135) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "myhost");
+    TOperationSpan span(Tracer, "ExecuteQuery", "myhost", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -73,7 +76,7 @@ TEST_F(QuerySpanTest, ServerAddressNoPortDefaultsTo2135) {
 }
 
 TEST_F(QuerySpanTest, IPv6EndpointParsing) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "[::1]:2136");
+    TOperationSpan span(Tracer, "ExecuteQuery", "[::1]:2136", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -83,7 +86,7 @@ TEST_F(QuerySpanTest, IPv6EndpointParsing) {
 }
 
 TEST_F(QuerySpanTest, IPv6EndpointNoPort) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "[fe80::1]");
+    TOperationSpan span(Tracer, "ExecuteQuery", "[fe80::1]", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -93,7 +96,7 @@ TEST_F(QuerySpanTest, IPv6EndpointNoPort) {
 }
 
 TEST_F(QuerySpanTest, PeerEndpointAttributes) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "discovery.ydb:2135");
+    TOperationSpan span(Tracer, "ExecuteQuery", "discovery.ydb:2135", TLog());
     span.SetPeerEndpoint("10.0.0.1:2136");
     span.End(EStatus::SUCCESS);
 
@@ -104,7 +107,7 @@ TEST_F(QuerySpanTest, PeerEndpointAttributes) {
 }
 
 TEST_F(QuerySpanTest, SuccessStatusRecorded) {
-    TQuerySpan span(Tracer, "Commit", "localhost:2135");
+    TOperationSpan span(Tracer, "Commit", "localhost:2135", TLog());
     span.End(EStatus::SUCCESS);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -115,7 +118,7 @@ TEST_F(QuerySpanTest, SuccessStatusRecorded) {
 }
 
 TEST_F(QuerySpanTest, ErrorStatusSetsErrorType) {
-    TQuerySpan span(Tracer, "Rollback", "localhost:2135");
+    TOperationSpan span(Tracer, "Rollback", "localhost:2135", TLog());
     span.End(EStatus::UNAVAILABLE);
 
     auto fakeSpan = Tracer->GetLastSpan();
@@ -126,7 +129,7 @@ TEST_F(QuerySpanTest, ErrorStatusSetsErrorType) {
 }
 
 TEST_F(QuerySpanTest, SpanIsEndedAfterEnd) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "localhost:2135");
+    TOperationSpan span(Tracer, "ExecuteQuery", "localhost:2135", TLog());
     auto fakeSpan = Tracer->GetLastSpan();
     ASSERT_NE(fakeSpan, nullptr);
 
@@ -137,7 +140,7 @@ TEST_F(QuerySpanTest, SpanIsEndedAfterEnd) {
 
 TEST_F(QuerySpanTest, NullTracerDoesNotCrash) {
     EXPECT_NO_THROW({
-        TQuerySpan span(nullptr, "ExecuteQuery", "localhost:2135");
+        TOperationSpan span(nullptr, "ExecuteQuery", "localhost:2135", TLog());
         span.SetPeerEndpoint("10.0.0.1:2136");
         span.AddEvent("retry", {{"attempt", "1"}});
         span.End(EStatus::SUCCESS);
@@ -146,7 +149,7 @@ TEST_F(QuerySpanTest, NullTracerDoesNotCrash) {
 
 TEST_F(QuerySpanTest, DestructorEndsSpan) {
     auto fakeSpan = [&]() -> std::shared_ptr<TFakeSpan> {
-        TQuerySpan span(Tracer, "CreateSession", "localhost:2135");
+        TOperationSpan span(Tracer, "CreateSession", "localhost:2135", TLog());
         return Tracer->GetLastSpan();
     }();
 
@@ -156,7 +159,7 @@ TEST_F(QuerySpanTest, DestructorEndsSpan) {
 
 TEST_F(QuerySpanTest, ExplicitEndThenDestructorDoesNotDoubleEnd) {
     auto fakeSpan = [&]() -> std::shared_ptr<TFakeSpan> {
-        TQuerySpan span(Tracer, "Commit", "localhost:2135");
+        TOperationSpan span(Tracer, "Commit", "localhost:2135", TLog());
         span.End(EStatus::SUCCESS);
         return Tracer->GetLastSpan();
     }();
@@ -166,7 +169,7 @@ TEST_F(QuerySpanTest, ExplicitEndThenDestructorDoesNotDoubleEnd) {
 }
 
 TEST_F(QuerySpanTest, AddEventForwarded) {
-    TQuerySpan span(Tracer, "ExecuteQuery", "localhost:2135");
+    TOperationSpan span(Tracer, "ExecuteQuery", "localhost:2135", TLog());
     span.AddEvent("retry", {{"ydb.attempt", "2"}, {"error.type", "UNAVAILABLE"}});
     span.End(EStatus::SUCCESS);
 
@@ -180,7 +183,7 @@ TEST_F(QuerySpanTest, AddEventForwarded) {
 }
 
 TEST_F(QuerySpanTest, EmptyPeerEndpointIgnored) {
-    TQuerySpan span(Tracer, "CreateSession", "localhost:2135");
+    TOperationSpan span(Tracer, "CreateSession", "localhost:2135", TLog());
     span.SetPeerEndpoint("");
     span.End(EStatus::SUCCESS);
 
@@ -194,7 +197,7 @@ TEST_F(QuerySpanTest, AllFourOperationNames) {
     const std::vector<std::string> operations = {"CreateSession", "ExecuteQuery", "Commit", "Rollback"};
 
     for (const auto& op : operations) {
-        TQuerySpan span(Tracer, op, "localhost:2135");
+        TOperationSpan span(Tracer, op, "localhost:2135", TLog());
         span.End(EStatus::SUCCESS);
     }
 
@@ -223,7 +226,7 @@ TEST_F(QuerySpanTest, MultipleErrorStatuses) {
     };
 
     for (auto status : errorStatuses) {
-        TQuerySpan span(Tracer, "ExecuteQuery", "localhost:2135");
+        TOperationSpan span(Tracer, "ExecuteQuery", "localhost:2135", TLog());
         span.End(status);
 
         auto fakeSpan = Tracer->GetLastSpan();
@@ -236,7 +239,7 @@ TEST_F(QuerySpanTest, MultipleErrorStatuses) {
 
 TEST_F(QuerySpanTest, EmptyEndpointDoesNotCrash) {
     EXPECT_NO_THROW({
-        TQuerySpan span(Tracer, "ExecuteQuery", "");
+        TOperationSpan span(Tracer, "ExecuteQuery", "", TLog());
         span.End(EStatus::SUCCESS);
     });
 }