feat grpc: configurable client name in metrics

ivan-skryabin · ivan-skryabin · commit f5205f80ec2a · 2025-12-25T11:06:14.000+03:00
Introduce `destination-prefix-in-metrics` configuration option for gRPC clients that allows overriding the default `grpc_destination_full` metric label format. The default format is now `client(client_name)/service/method` instead of `client_name/service/method` for better clarity.
commit_hash:7f2fe596ed64c1ed138b78e3d4ea20ee988a9d15
diff --git a/grpc/functional_tests/metrics/tests/static/metrics_values.txt b/grpc/functional_tests/metrics/tests/static/metrics_values.txt
@@ -1,23 +1,23 @@
 alerts.grpc_client_qos_invalid_configuration:	GAUGE
-grpc.client.by-destination.abandoned-error: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.active: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	GAUGE
-grpc.client.by-destination.cancelled-by-deadline-propagation: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.cancelled: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.deadline-propagated: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.eps: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.network-error: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.rps: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.status: grpc_code=OK, grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.status: grpc_code=UNKNOWN, grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p0	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p100	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p50	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p90	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p95	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p98	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p99	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p99_6	GAUGE
-grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=greeter/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p99_9	GAUGE
+grpc.client.by-destination.abandoned-error: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.active: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	GAUGE
+grpc.client.by-destination.cancelled-by-deadline-propagation: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.cancelled: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.deadline-propagated: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.eps: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.network-error: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.rps: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.status: grpc_code=OK, grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.status: grpc_code=UNKNOWN, grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService	RATE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p0	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p100	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p50	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p90	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p95	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p98	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p99	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p99_6	GAUGE
+grpc.client.by-destination.timings: grpc_destination=samples.api.GreeterService/SayHello, grpc_destination_full=client(greeter)/samples.api.GreeterService/SayHello, grpc_method=SayHello, grpc_service=samples.api.GreeterService, percentile=p99_9	GAUGE
 grpc.client.total.abandoned-error:	RATE
 grpc.client.total.active:	GAUGE
 grpc.client.total.cancelled-by-deadline-propagation:	RATE
diff --git a/grpc/include/userver/ugrpc/client/client_settings.hpp b/grpc/include/userver/ugrpc/client/client_settings.hpp
@@ -4,6 +4,7 @@
 /// @brief @copybrief ugrpc::client::ClientSettings
 
 #include <cstddef>
+#include <optional>
 #include <string>
 #include <unordered_map>
 
@@ -31,6 +32,11 @@ struct ClientSettings final {
     /// https://grpc.github.io/grpc/cpp/md_doc_naming.html
     std::string endpoint;
 
+    /// **(Optional)**
+    /// Prefix for the full destination path in metrics: "destination_prefix_in_metrics/grpc_service/grpc_method".
+    /// Default: "client(client_name)".
+    std::optional<std::string> destination_prefix_in_metrics{std::nullopt};
+
     /// **(Optional)**
     /// The name of the QOS
     /// @ref scripts/docs/en/userver/dynamic_config.md "dynamic config"
diff --git a/grpc/include/userver/ugrpc/client/impl/client_internals.hpp b/grpc/include/userver/ugrpc/client/impl/client_internals.hpp
@@ -29,6 +29,7 @@ class ClientQosErrorsReporter;
 /// Contains all non-code-generated dependencies for creating a gRPC client
 struct ClientInternals final {
     std::string client_name;
+    std::string destination_prefix_in_metrics;
     std::string endpoint;
     Middlewares middlewares;
     ugrpc::impl::CompletionQueuePoolBase& completion_queues;
diff --git a/grpc/include/userver/ugrpc/impl/statistics.hpp b/grpc/include/userver/ugrpc/impl/statistics.hpp
@@ -108,7 +108,7 @@ void DumpMetric(utils::statistics::Writer& writer, const MethodStatisticsSnapsho
 void DumpMetricWithLabels(
     utils::statistics::Writer& writer,
     const MethodStatisticsSnapshot& stats,
-    std::optional<std::string_view> client_name,
+    std::optional<std::string_view> destination_prefix_in_metrics,
     std::string_view call_name,
     std::string_view service_name
 );
@@ -132,7 +132,7 @@ class ServiceStatistics final {
 
     void DumpAndCountTotal(
         utils::statistics::Writer& writer,
-        std::optional<std::string_view> client_name,
+        std::optional<std::string_view> destination_prefix_in_metrics,
         MethodStatisticsSnapshot& total
     ) const;
 
diff --git a/grpc/include/userver/ugrpc/impl/statistics_storage.hpp b/grpc/include/userver/ugrpc/impl/statistics_storage.hpp
@@ -28,10 +28,13 @@ class StatisticsStorage final {
 
     ServiceStatistics& GetServiceStatistics(
         const StaticServiceMetadata& metadata,
-        std::optional<std::string> client_name
+        std::optional<std::string> destination_prefix_in_metrics
     );
 
-    MethodStatistics& GetGenericStatistics(std::string_view call_name, std::optional<std::string_view> client_name);
+    MethodStatistics& GetGenericStatistics(
+        std::string_view call_name,
+        std::optional<std::string_view> destination_prefix_in_metrics
+    );
 
     std::uint64_t GetStartedRequests() const;
 
@@ -41,19 +44,19 @@ class StatisticsStorage final {
 
     struct ServiceKey {
         ServiceId service_id{};
-        std::optional<std::string> client_name;
+        std::optional<std::string> destination_prefix_in_metrics;
     };
 
     struct GenericKey {
         std::string call_name;
-        std::optional<std::string> client_name;
+        std::optional<std::string> destination_prefix_in_metrics;
     };
 
     struct GenericKeyView {
         GenericKey Dereference() const;
 
         std::string_view call_name;
-        std::optional<std::string_view> client_name;
+        std::optional<std::string_view> destination_prefix_in_metrics;
     };
 
     struct ServiceKeyComparer {
diff --git a/grpc/src/ugrpc/client/client_factory.cpp b/grpc/src/ugrpc/client/client_factory.cpp
@@ -60,8 +60,12 @@ impl::ClientInternals ClientFactory::MakeClientInternals(
     impl::ChannelFactory
         channel_factory{channel_task_processor_, std::move(channel_credentials), client_factory_settings_.auth_type};
 
+    std::string destination_prefix_in_metrics =
+        client_settings.destination_prefix_in_metrics.value_or(fmt::format("client({})", client_settings.client_name));
+
     return impl::ClientInternals{
         std::move(client_settings.client_name),
+        std::move(destination_prefix_in_metrics),
         std::move(client_settings.endpoint),
         std::move(middlewares),
         completion_queues_,
diff --git a/grpc/src/ugrpc/client/impl/client_data.cpp b/grpc/src/ugrpc/client/impl/client_data.cpp
@@ -31,7 +31,7 @@ ugrpc::impl::MethodStatistics& ClientData::GetStatistics(std::size_t method_id)
 }
 
 ugrpc::impl::MethodStatistics& ClientData::GetGenericStatistics(std::string_view call_name) const {
-    return internals_.statistics_storage.GetGenericStatistics(call_name, internals_.client_name);
+    return internals_.statistics_storage.GetGenericStatistics(call_name, internals_.destination_prefix_in_metrics);
 }
 
 const ugrpc::impl::StaticServiceMetadata& ClientData::GetMetadata() const {
@@ -44,7 +44,7 @@ const dynamic_config::Key<ClientQos>* ClientData::GetClientQos() const { return
 rcu::ReadablePtr<StubState> ClientData::GetStubState() const { return stub_state_.Read(); }
 
 ugrpc::impl::ServiceStatistics& ClientData::GetServiceStatistics() {
-    return internals_.statistics_storage.GetServiceStatistics(GetMetadata(), internals_.client_name);
+    return internals_.statistics_storage.GetServiceStatistics(GetMetadata(), internals_.destination_prefix_in_metrics);
 }
 
 }  // namespace ugrpc::client::impl
diff --git a/grpc/src/ugrpc/client/simple_client_component.cpp b/grpc/src/ugrpc/client/simple_client_component.cpp
@@ -36,6 +36,8 @@ ClientSettings SimpleClientComponentAny::MakeClientSettings(
     ClientSettings client_settings;
     client_settings.client_name = config["client-name"].As<std::string>(config.Name());
     client_settings.endpoint = config["endpoint"].As<std::string>();
+    client_settings
+        .destination_prefix_in_metrics = config["destination-prefix-in-metrics"].As<std::optional<std::string>>();
     client_settings.client_qos = client_qos;
     client_settings.dedicated_methods_config =
         config["dedicated-channel-counts"].As<DedicatedMethodsConfig>(client_settings.dedicated_methods_config);
diff --git a/grpc/src/ugrpc/client/simple_client_component.yaml b/grpc/src/ugrpc/client/simple_client_component.yaml
@@ -11,6 +11,12 @@ properties:
             Name of the gRPC server we talk to, for diagnostics.
 
             Default: <uses the component name>
+    destination-prefix-in-metrics:
+        type: string
+        description: |
+            Prefix for the full destination path in metrics: "destination_prefix_in_metrics/grpc_service/grpc_method".
+
+            Default: "client(client_name)"
     factory-component:
         type: string
         description: ClientFactoryComponent name to use for client creation
diff --git a/grpc/src/ugrpc/impl/statistics.cpp b/grpc/src/ugrpc/impl/statistics.cpp
@@ -149,7 +149,7 @@ void MethodStatisticsSnapshot::Add(const MethodStatisticsSnapshot& other) {
 void DumpMetricWithLabels(
     utils::statistics::Writer& writer,
     const MethodStatisticsSnapshot& stats,
-    std::optional<std::string_view> client_name,
+    std::optional<std::string_view> destination_prefix_in_metrics,
     std::string_view call_name,
     std::string_view service_name
 ) {
@@ -162,8 +162,8 @@ void DumpMetricWithLabels(
         {"grpc_destination", call_name},
     };
 
-    if (client_name) {
-        grpc_destination_full = utils::StrCat(*client_name, "/", call_name);
+    if (destination_prefix_in_metrics) {
+        grpc_destination_full = utils::StrCat(*destination_prefix_in_metrics, "/", call_name);
         labels.emplace_back("grpc_destination_full", grpc_destination_full);
     }
 
@@ -213,7 +213,7 @@ const StaticServiceMetadata& ServiceStatistics::GetMetadata() const { return met
 
 void ServiceStatistics::DumpAndCountTotal(
     utils::statistics::Writer& writer,
-    std::optional<std::string_view> client_name,
+    std::optional<std::string_view> destination_prefix_in_metrics,
     MethodStatisticsSnapshot& total
 ) const {
     for (const auto& [i, method_descriptor] : utils::enumerate(metadata_.methods)) {
@@ -222,7 +222,7 @@ void ServiceStatistics::DumpAndCountTotal(
         DumpMetricWithLabels(
             writer,
             snapshot,
-            client_name,
+            destination_prefix_in_metrics,
             method_descriptor.method_full_name,
             metadata_.service_full_name
         );
diff --git a/grpc/src/ugrpc/impl/statistics_storage.cpp b/grpc/src/ugrpc/impl/statistics_storage.cpp
@@ -35,12 +35,12 @@ StatisticsStorage::~StatisticsStorage() { statistics_holder_.Unregister(); }
 
 ServiceStatistics& StatisticsStorage::GetServiceStatistics(
     const StaticServiceMetadata& metadata,
-    std::optional<std::string> client_name
+    std::optional<std::string> destination_prefix_in_metrics
 ) {
     // We exploit the fact that 'service_full_name' always points to the same
     // static string for a given service.
     const ServiceId service_id = metadata.service_full_name.data();
-    ServiceKey service_key{service_id, std::move(client_name)};
+    ServiceKey service_key{service_id, std::move(destination_prefix_in_metrics)};
 
     {
         auto service_statistics = service_statistics_map_.SharedMutableLockUnsafe();
@@ -61,7 +61,7 @@ ServiceStatistics& StatisticsStorage::GetServiceStatistics(
 
 MethodStatistics& StatisticsStorage::GetGenericStatistics(
     std::string_view call_name,
-    std::optional<std::string_view> client_name
+    std::optional<std::string_view> destination_prefix_in_metrics
 ) {
     UASSERT_MSG(!call_name.empty(), "call_name must NOT be empty");
     UASSERT_MSG(call_name[0] != '/', utils::StrCat("call_name must NOT start with /, given: ", call_name));
@@ -70,7 +70,7 @@ MethodStatistics& StatisticsStorage::GetGenericStatistics(
         utils::StrCat("call_name must contain /, given: ", call_name)
     );
 
-    const GenericKeyView generic_key{call_name, client_name};
+    const GenericKeyView generic_key{call_name, destination_prefix_in_metrics};
 
     {
         auto generic_statistics = generic_statistics_map_.SharedMutableLockUnsafe();
@@ -96,7 +96,7 @@ void StatisticsStorage::ExtendStatistics(utils::statistics::Writer& writer) {
         {
             auto service_statistics_map = service_statistics_map_.SharedLock();
             for (const auto& [key, service_stats] : *service_statistics_map) {
-                service_stats.DumpAndCountTotal(by_destination, key.client_name, total);
+                service_stats.DumpAndCountTotal(by_destination, key.destination_prefix_in_metrics, total);
             }
         }
         {
@@ -114,7 +114,13 @@ void StatisticsStorage::ExtendStatistics(utils::statistics::Writer& writer) {
 
                 const MethodStatisticsSnapshot snapshot{method_stats};
                 total.Add(snapshot);
-                DumpMetricWithLabels(by_destination, snapshot, key.client_name, call_name, service_name);
+                DumpMetricWithLabels(
+                    by_destination,
+                    snapshot,
+                    key.destination_prefix_in_metrics,
+                    call_name,
+                    service_name
+                );
             }
         }
     }
@@ -128,7 +134,7 @@ StatisticsStorage::GenericKey  //
 StatisticsStorage::GenericKeyView::Dereference() const {
     return GenericKey{
         std::string{call_name},
-        client_name ? std::make_optional(std::string{*client_name}) : std::nullopt,
+        destination_prefix_in_metrics ? std::make_optional(std::string{*destination_prefix_in_metrics}) : std::nullopt,
     };
 }
 
diff --git a/scripts/docs/en/userver/grpc/grpc.md b/scripts/docs/en/userver/grpc/grpc.md

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ ugrpc::impl::MethodStatistics& ClientData::GetStatistics(std::size_t method_id)`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`ugrpc::impl::MethodStatistics& ClientData::GetGenericStatistics(std::string_view call_name) const {`
`34`		`- return internals_.statistics_storage.GetGenericStatistics(call_name, internals_.client_name);`
	`34`	`+ return internals_.statistics_storage.GetGenericStatistics(call_name, internals_.destination_prefix_in_metrics);`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`const ugrpc::impl::StaticServiceMetadata& ClientData::GetMetadata() const {`
`@@ -44,7 +44,7 @@ const dynamic_config::Key<ClientQos>* ClientData::GetClientQos() const { return`
`44`	`44`	`rcu::ReadablePtr<StubState> ClientData::GetStubState() const { return stub_state_.Read(); }`
`45`	`45`
`46`	`46`	`ugrpc::impl::ServiceStatistics& ClientData::GetServiceStatistics() {`
`47`		`- return internals_.statistics_storage.GetServiceStatistics(GetMetadata(), internals_.client_name);`
	`47`	`+ return internals_.statistics_storage.GetServiceStatistics(GetMetadata(), internals_.destination_prefix_in_metrics);`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`} // namespace ugrpc::client::impl`