Add status code to OTLP grpc trace log (open-telemetry#1792)

yxue · Dec 5, 2022 · dd16d60 · dd16d60
1 parent b29a326
commit dd16d60
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 5 deletions.
diff --git a/exporters/otlp/BUILD b/exporters/otlp/BUILD
@@ -46,6 +46,23 @@ cc_library(
     ],
 )
 
+cc_library(
+    name = "otlp_grpc_utils",
+    srcs = [
+        "src/otlp_grpc_utils.cc",
+    ],
+    hdrs = [
+        "include/opentelemetry/exporters/otlp/otlp_grpc_utils.h",
+    ],
+    strip_include_prefix = "include",
+    tags = ["otlp"],
+    deps = [
+        "//api",
+        "//sdk:headers",
+        "@com_github_grpc_grpc//:grpc++",
+    ],
+)
+
 cc_library(
     name = "otlp_grpc_client",
     srcs = [
@@ -82,6 +99,7 @@ cc_library(
         "include/opentelemetry/exporters/otlp/otlp_grpc_exporter.h",
         "include/opentelemetry/exporters/otlp/otlp_grpc_exporter_factory.h",
         "include/opentelemetry/exporters/otlp/otlp_grpc_exporter_options.h",
+        "include/opentelemetry/exporters/otlp/otlp_grpc_utils.h",
         "include/opentelemetry/exporters/otlp/protobuf_include_prefix.h",
         "include/opentelemetry/exporters/otlp/protobuf_include_suffix.h",
     ],
@@ -93,6 +111,7 @@ cc_library(
     deps = [
         ":otlp_recordable",
         ":otlp_grpc_client",
+        ":otlp_grpc_utils",
         "//ext:headers",
         "//sdk/src/trace",
 

diff --git a/exporters/otlp/CMakeLists.txt b/exporters/otlp/CMakeLists.txt
@@ -2,7 +2,7 @@ add_library(
   opentelemetry_otlp_recordable
   src/otlp_log_recordable.cc src/otlp_recordable.cc
   src/otlp_populate_attribute_utils.cc src/otlp_recordable_utils.cc
-  src/otlp_metric_utils.cc)
+  src/otlp_metric_utils.cc src/otlp_grpc_utils.cc)
 set_target_properties(opentelemetry_otlp_recordable PROPERTIES EXPORT_NAME
                                                                otlp_recordable)
 

diff --git a/exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_utils.h b/exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_utils.h
@@ -0,0 +1,25 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <grpcpp/grpcpp.h>
+
+#include "opentelemetry/sdk/version/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+
+namespace exporter
+{
+namespace otlp
+{
+namespace grpc_utils
+{
+
+const char *grpc_status_code_to_string(::grpc::StatusCode status_code);
+
+}  // namespace grpc_utils
+}  // namespace otlp
+}  // namespace exporter
+
+OPENTELEMETRY_END_NAMESPACE
diff --git a/exporters/otlp/src/otlp_grpc_exporter.cc b/exporters/otlp/src/otlp_grpc_exporter.cc
@@ -11,7 +11,7 @@
 #include "opentelemetry/exporters/otlp/otlp_recordable_utils.h"
 #include "opentelemetry/sdk_config.h"
 
-#include <grpcpp/grpcpp.h>
+#include "opentelemetry/exporters/otlp/otlp_grpc_utils.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace exporter
@@ -64,9 +64,9 @@ sdk::common::ExportResult OtlpGrpcExporter::Export(
 
   if (!status.ok())
   {
-
-    OTEL_INTERNAL_LOG_ERROR(
-        "[OTLP TRACE GRPC Exporter] Export() failed: " << status.error_message());
+    OTEL_INTERNAL_LOG_ERROR("[OTLP TRACE GRPC Exporter] Export() failed with status_code: \""
+                            << grpc_utils::grpc_status_code_to_string(status.error_code())
+                            << "\" error_message: \"" << status.error_message() << "\"");
     return sdk::common::ExportResult::kFailure;
   }
   return sdk::common::ExportResult::kSuccess;

diff --git a/exporters/otlp/src/otlp_grpc_utils.cc b/exporters/otlp/src/otlp_grpc_utils.cc
@@ -0,0 +1,62 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#include "opentelemetry/exporters/otlp/otlp_grpc_utils.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+
+namespace exporter
+{
+namespace otlp
+{
+namespace grpc_utils
+{
+
+const char *grpc_status_code_to_string(::grpc::StatusCode status_code)
+{
+  switch (status_code)
+  {
+    case GRPC_STATUS_OK:
+      return "OK";
+    case GRPC_STATUS_CANCELLED:
+      return "CANCELLED";
+    case GRPC_STATUS_UNKNOWN:
+      return "UNKNOWN";
+    case GRPC_STATUS_INVALID_ARGUMENT:
+      return "INVALID_ARGUMENT";
+    case GRPC_STATUS_DEADLINE_EXCEEDED:
+      return "DEADLINE_EXCEEDED";
+    case GRPC_STATUS_NOT_FOUND:
+      return "NOT_FOUND";
+    case GRPC_STATUS_ALREADY_EXISTS:
+      return "ALREADY_EXISTS";
+    case GRPC_STATUS_PERMISSION_DENIED:
+      return "PERMISSION_DENIED";
+    case GRPC_STATUS_UNAUTHENTICATED:
+      return "UNAUTHENTICATED";
+    case GRPC_STATUS_RESOURCE_EXHAUSTED:
+      return "RESOURCE_EXHAUSTED";
+    case GRPC_STATUS_FAILED_PRECONDITION:
+      return "FAILED_PRECONDITION";
+    case GRPC_STATUS_ABORTED:
+      return "ABORTED";
+    case GRPC_STATUS_OUT_OF_RANGE:
+      return "OUT_OF_RANGE";
+    case GRPC_STATUS_UNIMPLEMENTED:
+      return "UNIMPLEMENTED";
+    case GRPC_STATUS_INTERNAL:
+      return "INTERNAL";
+    case GRPC_STATUS_UNAVAILABLE:
+      return "UNAVAILABLE";
+    case GRPC_STATUS_DATA_LOSS:
+      return "DATA_LOSS";
+    default:
+      return "UNKNOWN";
+  }
+}
+
+}  // namespace grpc_utils
+}  // namespace otlp
+}  // namespace exporter
+
+OPENTELEMETRY_END_NAMESPACE