dev: added sdk version header to any RPC call

Author: KirillKurdyukov

src/Ydb.Sdk/CHANGELOG.md

@@ -1,3 +1,5 @@
+- Added `x-ydb-sdk-build-info` header to any RPC call.
+
 ## v0.16.0
 
 - **Breaking Change**: `Ydb.Sdk.Yc.Auth` version <= 0.1.0 is not compatible with newer versions.

src/Ydb.Sdk/src/Driver.cs

@@ -1,5 +1,4 @@
 using System.Collections.Immutable;
-using System.Reflection;
 using Grpc.Core;
 using Grpc.Net.Client;
 using Microsoft.Extensions.Logging;
@@ -16,7 +15,6 @@ public sealed class Driver : BaseDriver
 {
     private const int AttemptDiscovery = 10;
 
-    private readonly string _sdkInfo;
     private readonly GrpcChannelFactory _grpcChannelFactory;
     private readonly EndpointPool _endpointPool;
     private readonly ChannelPool<GrpcChannel> _channelPool;
@@ -35,10 +33,6 @@ public Driver(DriverConfig config, ILoggerFactory? loggerFactory = null)
             _grpcChannelFactory
         );
 
-        var version = Assembly.GetExecutingAssembly().GetName().Version;
-        var versionStr = version is null ? "unknown" : version.ToString(3);
-        _sdkInfo = $"ydb-dotnet-sdk/{versionStr}";
-
         CredentialsProvider = Config.User != null
             ? new CachedCredentialsProvider(
                 new StaticCredentialsAuthClient(config, _grpcChannelFactory, LoggerFactory),
@@ -134,12 +128,10 @@ private async Task<Status> DiscoverEndpoints()
             TransportTimeout = Config.EndpointDiscoveryTimeout
         };
 
-        var options = await GetCallOptions(requestSettings);
-        options.Headers?.Add(Metadata.RpcSdkInfoHeader, _sdkInfo);
-
         var response = await client.ListEndpointsAsync(
             request: request,
-            options: options);
+            options: await GetCallOptions(requestSettings)
+        );
 
         if (!response.Operation.Ready)
         {
@@ -168,7 +160,8 @@ private async Task<Status> DiscoverEndpoints()
 
         Logger.LogDebug(
             "Successfully discovered endpoints: {EndpointsCount}, self location: {SelfLocation}, sdk info: {SdkInfo}",
-            resultProto.Endpoints.Count, resultProto.SelfLocation, _sdkInfo);
+            resultProto.Endpoints.Count, resultProto.SelfLocation, Config.SdkVersion
+        );
 
         _endpointPool.Reset(resultProto.Endpoints
             .Select(endpointSettings => new EndpointSettings(
@@ -189,15 +182,16 @@ private async Task PeriodicDiscovery()
             try
             {
                 await Task.Delay(Config.EndpointDiscoveryInterval);
+                
                 _ = await DiscoverEndpoints();
             }
             catch (RpcException e)
             {
-                Logger.LogWarning($"RPC error during endpoint discovery: {e.Status}");
+                Logger.LogWarning("RPC error during endpoint discovery: {Status}", e.Status);
             }
             catch (Exception e)
             {
-                Logger.LogError($"Unexpected exception during session pool periodic check: {e}");
+                Logger.LogError(e, "Unexpected exception during session pool periodic check");
             }
         }
     }

src/Ydb.Sdk/src/DriverConfig.cs

@@ -1,4 +1,5 @@
-using System.Security.Cryptography.X509Certificates;
+using System.Reflection;
+using System.Security.Cryptography.X509Certificates;
 using Ydb.Sdk.Auth;
 
 namespace Ydb.Sdk;
@@ -21,6 +22,7 @@ public class DriverConfig
     internal X509Certificate2Collection CustomServerCertificates { get; } = new();
     internal TimeSpan EndpointDiscoveryInterval = TimeSpan.FromMinutes(1);
     internal TimeSpan EndpointDiscoveryTimeout = TimeSpan.FromSeconds(10);
+    internal string SdkVersion { get; }
 
     public DriverConfig(
         string endpoint,
@@ -42,6 +44,10 @@ public DriverConfig(
         {
             CustomServerCertificates.AddRange(customServerCertificates);
         }
+        
+        var version = Assembly.GetExecutingAssembly().GetName().Version;
+        var versionStr = version is null ? "unknown" : version.ToString(3);
+        SdkVersion = $"ydb-dotnet-sdk/{versionStr}";
     }
 
     private static string FormatEndpoint(string endpoint)

src/Ydb.Sdk/src/IDriver.cs

@@ -138,7 +138,8 @@ protected async ValueTask<CallOptions> GetCallOptions(GrpcRequestSettings settin
     {
         var meta = new Grpc.Core.Metadata
         {
-            { Metadata.RpcDatabaseHeader, Config.Database }
+            { Metadata.RpcDatabaseHeader, Config.Database },
+            { Metadata.RpcSdkInfoHeader, Config.SdkVersion }
         };
 
         if (CredentialsProvider != null)