feat grpc: publish logging functions for google::protobuf::Message and grpc::Status

commit_hash:622fdaa5419b3e8e551175cab67b6867ff9420ff

Author: mvkab

.mapping.json

@@ -2202,6 +2202,7 @@
   "grpc/include/userver/ugrpc/impl/statistics_storage.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/impl/statistics_storage.hpp",
   "grpc/include/userver/ugrpc/impl/to_string.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/impl/to_string.hpp",
   "grpc/include/userver/ugrpc/proto_json.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/proto_json.hpp",
+  "grpc/include/userver/ugrpc/protobuf_logging.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/protobuf_logging.hpp",
   "grpc/include/userver/ugrpc/protobuf_visit.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/protobuf_visit.hpp",
   "grpc/include/userver/ugrpc/server/call_context.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/server/call_context.hpp",
   "grpc/include/userver/ugrpc/server/component_list.hpp":"taxi/uservices/userver/grpc/include/userver/ugrpc/server/component_list.hpp",
@@ -2324,8 +2325,6 @@
   "grpc/src/ugrpc/impl/logging.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/logging.cpp",
   "grpc/src/ugrpc/impl/logging.hpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/logging.hpp",
   "grpc/src/ugrpc/impl/protobuf_collector.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/protobuf_collector.cpp",
-  "grpc/src/ugrpc/impl/protobuf_utils.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/protobuf_utils.cpp",
-  "grpc/src/ugrpc/impl/protobuf_utils.hpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/protobuf_utils.hpp",
   "grpc/src/ugrpc/impl/queue_runner.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/queue_runner.cpp",
   "grpc/src/ugrpc/impl/rpc_metadata.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/rpc_metadata.cpp",
   "grpc/src/ugrpc/impl/rpc_metadata.hpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/rpc_metadata.hpp",
@@ -2334,6 +2333,7 @@
   "grpc/src/ugrpc/impl/statistics_scope.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/statistics_scope.cpp",
   "grpc/src/ugrpc/impl/statistics_storage.cpp":"taxi/uservices/userver/grpc/src/ugrpc/impl/statistics_storage.cpp",
   "grpc/src/ugrpc/proto_json.cpp":"taxi/uservices/userver/grpc/src/ugrpc/proto_json.cpp",
+  "grpc/src/ugrpc/protobuf_logging.cpp":"taxi/uservices/userver/grpc/src/ugrpc/protobuf_logging.cpp",
   "grpc/src/ugrpc/protobuf_visit.cpp":"taxi/uservices/userver/grpc/src/ugrpc/protobuf_visit.cpp",
   "grpc/src/ugrpc/server/call_context.cpp":"taxi/uservices/userver/grpc/src/ugrpc/server/call_context.cpp",
   "grpc/src/ugrpc/server/component_list.cpp":"taxi/uservices/userver/grpc/src/ugrpc/server/component_list.cpp",
@@ -2403,6 +2403,7 @@
   "grpc/tests/metadata_test.cpp":"taxi/uservices/userver/grpc/tests/metadata_test.cpp",
   "grpc/tests/proto_json.cpp":"taxi/uservices/userver/grpc/tests/proto_json.cpp",
   "grpc/tests/protobuf_collector_test.cpp":"taxi/uservices/userver/grpc/tests/protobuf_collector_test.cpp",
+  "grpc/tests/protobuf_logging_test.cpp":"taxi/uservices/userver/grpc/tests/protobuf_logging_test.cpp",
   "grpc/tests/protobuf_utils_test.cpp":"taxi/uservices/userver/grpc/tests/protobuf_utils_test.cpp",
   "grpc/tests/protobuf_visit_test.cpp":"taxi/uservices/userver/grpc/tests/protobuf_visit_test.cpp",
   "grpc/tests/retry_test.cpp":"taxi/uservices/userver/grpc/tests/retry_test.cpp",

grpc/benchmarks/logging.cpp

@@ -1,9 +1,8 @@
 #include <benchmark/benchmark.h>
 
+#include <userver/ugrpc/protobuf_logging.hpp>
 #include <userver/utils/log.hpp>
 
-#include <ugrpc/impl/protobuf_utils.hpp>
-
 #include <tests/logging.pb.h>
 
 USERVER_NAMESPACE_BEGIN
@@ -53,7 +52,7 @@ void BenchCustomLimit(benchmark::State& state) {
     // NOLINTNEXTLINE(clang-analyzer-deadcode.DeadStores)
     for (auto _ : state) {
         {
-            auto log = impl::ToLimitedDebugString(kMessage, 1024);
+            auto log = ugrpc::ToLimitedDebugString(kMessage, 1024);
             benchmark::DoNotOptimize(log);
         }
     }

grpc/include/userver/ugrpc/protobuf_logging.hpp

@@ -0,0 +1,91 @@
+#pragma once
+
+/// @file
+/// @brief Public API for protobuf logging utilities.
+
+#include <fmt/format.h>
+#include <google/protobuf/message.h>
+#include <grpcpp/support/status.h>
+
+USERVER_NAMESPACE_BEGIN
+
+namespace ugrpc {
+
+inline constexpr std::size_t kDefaultDebugStringLimit = 1024;
+
+/// @brief Convert protobuf message to limited debug string for logging.
+///
+/// Differences from built-in `DebugString`:
+/// - Fields marked with `[debug_redact]` option are hidden (`DebugString` only does so since Protobuf v30).
+/// - When the character limit is reached, serialization stops immediately (`DebugString` still wastes CPU on
+/// serializing the entire message regardless).
+///
+/// @param message The protobuf message to convert.
+/// @param limit Maximum size of the resulting string.
+/// Avoid setting this to very large values as it may cause OOM (Out of Memory) issues.
+/// @returns String representation of the message, truncated if necessary.
+///
+/// @warning This is a debug representation of protobuf that is unstable and should only be used for diagnostics.
+/// The order of keys in maps is unstable; the format itself can change even within a single run.
+/// You CANNOT parse back from this debug text representation.
+/// You CANNOT use it for equality match with reference values in gtest.
+std::string ToLimitedDebugString(const google::protobuf::Message& message, std::size_t limit);
+
+/// @brief Convert protobuf message to unlimited debug string for logging.
+///
+/// Differences from built-in `DebugString`:
+/// - Fields marked with `[debug_redact]` option are hidden (`DebugString` only does so since Protobuf v30).
+///
+/// @param message The protobuf message to convert.
+/// @returns String representation of the message.
+///
+/// @warning This is a debug representation of protobuf that is unstable and should only be used for diagnostics.
+/// The order of keys in maps is unstable; the format itself can change even within a single run.
+/// You CANNOT parse back from this debug text representation.
+/// You CANNOT use it for equality match with reference values in gtest.
+std::string ToUnlimitedDebugString(const google::protobuf::Message& message);
+
+/// @brief Get error details from `grpc::Status` for logging with size limit.
+/// @param status The `grpc::Status` to extract details from.
+/// @param max_size Maximum size of the resulting string.
+/// Avoid setting this to very large values as it may cause OOM (Out of Memory) issues.
+/// @returns String representation of error details, truncated if necessary.
+///
+/// @warning This is a debug representation of protobuf that is unstable and should only be used for diagnostics.
+/// The order of keys in maps is unstable; the format itself can change even within a single run.
+/// You CANNOT parse back from this debug text representation.
+/// You CANNOT use it for equality match with reference values in gtest.
+std::string ToLimitedDebugString(const grpc::Status& status, std::size_t max_size = kDefaultDebugStringLimit);
+
+/// @brief Get error details from `grpc::Status` for logging without size limit.
+/// @param status The `grpc::Status` to extract details from.
+/// @returns String representation of error details.
+///
+/// @warning This is a debug representation of protobuf that is unstable and should only be used for diagnostics.
+/// The order of keys in maps is unstable; the format itself can change even within a single run.
+/// You CANNOT parse back from this debug text representation.
+/// You CANNOT use it for equality match with reference values in gtest.
+std::string ToUnlimitedDebugString(const grpc::Status& status);
+
+}  // namespace ugrpc
+
+USERVER_NAMESPACE_END
+
+namespace fmt {
+
+/// @brief `fmt::format` support for protobuf messages
+template <typename T>
+struct formatter<T, typename std::enable_if_t<std::is_base_of_v<google::protobuf::Message, std::decay_t<T>>, char>> {
+    constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }
+
+    template <typename FormatContext>
+    auto format(const T& message, FormatContext& ctx) const {
+        return fmt::format_to(
+            ctx.out(),
+            "{}",
+            USERVER_NAMESPACE::ugrpc::ToLimitedDebugString(message, USERVER_NAMESPACE::ugrpc::kDefaultDebugStringLimit)
+        );
+    }
+};
+
+}  // namespace fmt

grpc/src/ugrpc/client/middlewares/log/middleware.cpp

@@ -3,6 +3,7 @@
 #include <userver/logging/level.hpp>
 #include <userver/logging/log_extra.hpp>
 #include <userver/tracing/tags.hpp>
+#include <userver/ugrpc/protobuf_logging.hpp>
 #include <userver/ugrpc/status_codes.hpp>
 
 #include <ugrpc/impl/logging.hpp>
@@ -17,7 +18,7 @@ std::string GetMessageForLogging(const google::protobuf::Message& message, const
     if (!logging::ShouldLog(settings.msg_log_level)) {
         return "";
     }
-    return ugrpc::impl::GetMessageForLogging(message, settings.max_msg_size);
+    return ugrpc::ToLimitedDebugString(message, settings.max_msg_size);
 }
 
 class SpanLogger {
@@ -91,7 +92,7 @@ void Middleware::PostFinish(MiddlewareCallContext& context, const grpc::Status&
             logger.Log(settings_.msg_log_level, "gRPC response stream finished", logging::LogExtra{});
         }
     } else {
-        auto error_details = ugrpc::impl::GetErrorDetailsForLogging(status);
+        auto error_details = ugrpc::ToUnlimitedDebugString(status);
         logging::LogExtra extra{
             {ugrpc::impl::kTypeTag, "error_status"},
             {ugrpc::impl::kCodeTag, ugrpc::ToString(status.error_code())},

grpc/src/ugrpc/impl/logging.cpp

@@ -1,14 +1,5 @@
 #include <ugrpc/impl/logging.hpp>
 
-#include <fmt/format.h>
-
-#include <userver/logging/log.hpp>
-
-#include <userver/ugrpc/status_codes.hpp>
-#include <userver/ugrpc/status_utils.hpp>
-
-#include <ugrpc/impl/protobuf_utils.hpp>
-
 USERVER_NAMESPACE_BEGIN
 
 namespace ugrpc::impl {
@@ -19,28 +10,6 @@ const std::string kComponentTag{"grpc_component"};
 const std::string kMessageMarshalledLenTag{"grpc_message_marshalled_len"};
 const std::string kTypeTag{"grpc_type"};
 
-std::string GetMessageForLogging(const google::protobuf::Message& message, std::size_t max_size) {
-    return ugrpc::impl::ToLimitedDebugString(message, max_size);
-}
-
-std::string GetErrorDetailsForLogging(const grpc::Status& status) {
-    if (status.ok()) {
-        return "";
-    }
-
-    const auto gstatus = ugrpc::ToGoogleRpcStatus(status);
-    return gstatus.has_value()
-               ? fmt::format(
-                     "code: {}, error message: {}\nerror details:\n{}",
-                     ugrpc::ToString(status.error_code()),
-                     status.error_message(),
-                     ugrpc::GetGStatusLimitedMessage(*gstatus)
-                 )
-               : fmt::format(
-                     "code: {}, error message: {}", ugrpc::ToString(status.error_code()), status.error_message()
-                 );
-}
-
 }  // namespace ugrpc::impl
 
 USERVER_NAMESPACE_END

grpc/src/ugrpc/impl/logging.hpp

@@ -1,10 +1,6 @@
 #pragma once
-
 #include <string>
 
-#include <google/protobuf/message.h>
-#include <grpcpp/support/status.h>
-
 USERVER_NAMESPACE_BEGIN
 
 namespace ugrpc::impl {
@@ -15,10 +11,6 @@ extern const std::string kComponentTag;
 extern const std::string kMessageMarshalledLenTag;
 extern const std::string kTypeTag;
 
-std::string GetMessageForLogging(const google::protobuf::Message& message, std::size_t max_size);
-
-std::string GetErrorDetailsForLogging(const grpc::Status& status);
-
 }  // namespace ugrpc::impl
 
 USERVER_NAMESPACE_END

grpc/src/ugrpc/impl/protobuf_utils.hpp

@@ -1,16 +1,12 @@
-#include <ugrpc/impl/protobuf_utils.hpp>
-
-#include <exception>
-#include <memory>
-#include <unordered_set>
+#include <userver/ugrpc/protobuf_logging.hpp>
 
 #include <google/protobuf/descriptor.pb.h>
-#include <google/protobuf/io/zero_copy_stream_impl_lite.h>
 #include <google/protobuf/text_format.h>
-#include <grpcpp/support/config.h>
 #include <boost/container/small_vector.hpp>
 
 #include <userver/compiler/thread_local.hpp>
+#include <userver/ugrpc/status_codes.hpp>
+#include <userver/ugrpc/status_utils.hpp>
 #include <userver/utils/assert.hpp>
 #include <userver/utils/numeric_cast.hpp>
 
@@ -189,31 +185,89 @@ compiler::ThreadLocal kDebugStringPrinter = [] { return DebugStringPrinter{}; };
 
 }  // namespace
 
+void Print(const google::protobuf::Message& message, google::protobuf::io::ZeroCopyOutputStream& output_stream) {
+    auto printer = kDebugStringPrinter.Use();
+    printer->RegisterDebugRedactPrinters(*message.GetDescriptor());
+    printer->Print(message, output_stream);
+}
+
+}  // namespace ugrpc::impl
+
+namespace ugrpc {
+
 std::string ToLimitedDebugString(const google::protobuf::Message& message, std::size_t limit) {
     boost::container::small_vector<char, 1024> output_buffer{limit, boost::container::default_init};
     google::protobuf::io::ArrayOutputStream output_stream{output_buffer.data(), utils::numeric_cast<int>(limit)};
 
-    auto printer = kDebugStringPrinter.Use();
+    auto printer = impl::kDebugStringPrinter.Use();
     printer->RegisterDebugRedactPrinters(*message.GetDescriptor());
 
 #if defined(ARCADIA_ROOT) || GOOGLE_PROTOBUF_VERSION >= 6031002
     // Throw `LimitReachedException` on limit reached to stop printing immediately, otherwise TextFormat will continue
     // to walk the whole message and apply noop printing.
-    LimitingOutputStream limiting_output_stream{output_stream};
+    impl::LimitingOutputStream limiting_output_stream{output_stream};
     try {
-        printer->Print(message, limiting_output_stream);
-    } catch (const LimitingOutputStream::LimitReachedException& /*ex*/) {
+        impl::Print(message, limiting_output_stream);
+    } catch (const impl::LimitingOutputStream::LimitReachedException& /*ex*/) {
         // Buffer limit has been reached.
     }
 #else
     // For old protobuf, we cannot apply hard limits when printing messages, because its TextFormat is not
     // exception-safe. https://github.com/protocolbuffers/protobuf/commit/be875d0aaf37dbe6948717ea621278e75e89c9c7
-    printer->Print(message, output_stream);
+    impl::Print(message, output_stream);
 #endif
+    std::string returned_str = std::string{output_buffer.data(), static_cast<std::size_t>(output_stream.ByteCount())};
+    if (returned_str.empty() && limit >= 7) return "<EMPTY>";
+    return returned_str;
+}
 
-    return std::string{output_buffer.data(), static_cast<std::size_t>(output_stream.ByteCount())};
+std::string ToUnlimitedDebugString(const google::protobuf::Message& message) {
+    grpc::string result;
+    google::protobuf::io::StringOutputStream output_stream(&result);
+    impl::Print(message, output_stream);
+    std::string returned_str = std::string(result);
+    if (returned_str.empty()) return "<EMPTY>";
+    return returned_str;
 }
 
-}  // namespace ugrpc::impl
+std::string ToLimitedDebugString(const grpc::Status& status, std::size_t max_size) {
+    if (status.ok()) {
+        return "OK";
+    }
+
+    const auto gstatus = ugrpc::ToGoogleRpcStatus(status);
+    if (gstatus.has_value()) {
+        const std::string details_string = ugrpc::ToLimitedDebugString(*gstatus, max_size);
+        return fmt::format(
+            "code: {}, error message: {}\nerror details:\n{}",
+            ugrpc::ToString(status.error_code()),
+            status.error_message(),
+            details_string
+        );
+    } else {
+        return fmt::format("code: {}, error message: {}", ugrpc::ToString(status.error_code()), status.error_message());
+    }
+}
+
+std::string ToUnlimitedDebugString(const grpc::Status& status) {
+    if (status.ok()) {
+        return "OK";
+    }
+
+    const auto gstatus = ugrpc::ToGoogleRpcStatus(status);
+    if (gstatus.has_value()) {
+        const std::string details_string = ugrpc::ToUnlimitedDebugString(*gstatus);
+        return fmt::format(
+            "code: {}, error message: {}\nerror details:\n{}",
+            ugrpc::ToString(status.error_code()),
+            status.error_message(),
+            details_string
+        );
+    } else {
+        return fmt::format("code: {}, error message: {}", ugrpc::ToString(status.error_code()), status.error_message());
+    }
+}
+
+}  // namespace ugrpc
 
 USERVER_NAMESPACE_END

grpc/src/ugrpc/impl/protobuf_utils.cpp renamed to grpc/src/ugrpc/protobuf_logging.cpp

@@ -7,9 +7,8 @@
 #include <userver/utils/assert.hpp>
 #include <userver/utils/impl/internal_tag.hpp>
 
-#include <ugrpc/impl/protobuf_utils.hpp>
 #include <userver/ugrpc/impl/protobuf_collector.hpp>
-#include <userver/ugrpc/protobuf_visit.hpp>
+#include <userver/ugrpc/protobuf_logging.hpp>
 
 USERVER_NAMESPACE_BEGIN