Allow to share gRPC clients between OTLP exporters.

Author: owent

exporters/otlp/BUILD

@@ -42,11 +42,13 @@ cc_library(
     name = "otlp_grpc_client",
     srcs = [
         "src/otlp_grpc_client.cc",
+        "src/otlp_grpc_client_factory.cc",
         "src/otlp_grpc_utils.cc",
     ],
     hdrs = [
         "include/opentelemetry/exporters/otlp/otlp_environment.h",
         "include/opentelemetry/exporters/otlp/otlp_grpc_client.h",
+        "include/opentelemetry/exporters/otlp/otlp_grpc_client_factory.h",
         "include/opentelemetry/exporters/otlp/otlp_grpc_client_options.h",
         "include/opentelemetry/exporters/otlp/otlp_grpc_utils.h",
         "include/opentelemetry/exporters/otlp/protobuf_include_prefix.h",

exporters/otlp/CMakeLists.txt

@@ -23,8 +23,10 @@ target_link_libraries(opentelemetry_otlp_recordable
 
 if(WITH_OTLP_GRPC)
   find_package(gRPC REQUIRED)
-  add_library(opentelemetry_exporter_otlp_grpc_client src/otlp_grpc_client.cc
-                                                      src/otlp_grpc_utils.cc)
+  add_library(
+    opentelemetry_exporter_otlp_grpc_client
+    src/otlp_grpc_client.cc src/otlp_grpc_client_factory.cc
+    src/otlp_grpc_utils.cc)
   set_target_properties(opentelemetry_exporter_otlp_grpc_client
                         PROPERTIES EXPORT_NAME otlp_grpc_client)
   set_target_version(opentelemetry_exporter_otlp_grpc_client)

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_client.h

@@ -28,10 +28,27 @@ namespace exporter
 namespace otlp
 {
 
+class OtlpGrpcClient;
 struct OtlpGrpcClientOptions;
 
 #ifdef ENABLE_ASYNC_EXPORT
 struct OtlpGrpcClientAsyncData;
+
+class OtlpGrpcClientReferenceGuard
+{
+public:
+  OtlpGrpcClientReferenceGuard() noexcept;
+  ~OtlpGrpcClientReferenceGuard() noexcept;
+
+  OtlpGrpcClientReferenceGuard(const OtlpGrpcClientReferenceGuard &)            = delete;
+  OtlpGrpcClientReferenceGuard(OtlpGrpcClientReferenceGuard &&)                 = delete;
+  OtlpGrpcClientReferenceGuard &operator=(const OtlpGrpcClientReferenceGuard &) = delete;
+  OtlpGrpcClientReferenceGuard &operator=(OtlpGrpcClientReferenceGuard &&)      = delete;
+
+private:
+  friend class OtlpGrpcClient;
+  std::atomic<bool> has_value_;
+};
 #endif
 
 /**
@@ -96,6 +113,17 @@ class OtlpGrpcClient
 
 #ifdef ENABLE_ASYNC_EXPORT
 
+  void AddReference(OtlpGrpcClientReferenceGuard &guard,
+                    const OtlpGrpcClientOptions &options) noexcept;
+
+  /**
+   * Reomve reference fro a guard object
+   *
+   * @param guard guard object to remove reference from
+   * @return true if there is no more reference to this gRPC client
+   */
+  bool RemoveReference(OtlpGrpcClientReferenceGuard &guard) noexcept;
+
   /**
    * Async export
    * @param options Options used to message to create gRPC context and stub(if necessary)
@@ -167,10 +195,13 @@ class OtlpGrpcClient
    * timeout is applied.
    * @return return the status of this operation
    */
-  bool Shutdown(std::chrono::microseconds timeout = std::chrono::microseconds(0)) noexcept;
+  bool Shutdown(OtlpGrpcClientReferenceGuard &guard,
+                std::chrono::microseconds timeout = std::chrono::microseconds(0)) noexcept;
 
   std::shared_ptr<OtlpGrpcClientAsyncData> MutableAsyncData(const OtlpGrpcClientOptions &options);
 
+  bool IsShutdown() const noexcept;
+
 private:
   // Stores if this gRPC client had its Shutdown() method called
   std::atomic<bool> is_shutdown_;

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_client_factory.h

@@ -0,0 +1,39 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <memory>
+
+#include "opentelemetry/nostd/shared_ptr.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace exporter
+{
+namespace otlp
+{
+
+#ifdef ENABLE_ASYNC_EXPORT
+class OtlpGrpcClientReferenceGuard;
+#endif
+class OtlpGrpcClient;
+
+/**
+ * Factory class for OtlpGrpcClient.
+ */
+class OPENTELEMETRY_EXPORT OtlpGrpcClientFactory
+{
+public:
+  /**
+   * Create an OtlpGrpcClient using all default options.
+   */
+  static nostd::shared_ptr<OtlpGrpcClient> Create();
+
+#ifdef ENABLE_ASYNC_EXPORT
+  static nostd::shared_ptr<OtlpGrpcClientReferenceGuard> CreateReferenceGuard();
+#endif
+};
+
+}  // namespace otlp
+}  // namespace exporter
+OPENTELEMETRY_END_NAMESPACE

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_exporter.h

@@ -6,12 +6,17 @@
 #include <atomic>
 #include <chrono>
 
+// clang-format off
 #include "opentelemetry/exporters/otlp/protobuf_include_prefix.h"
+// clang-format on
 
 #include "opentelemetry/proto/collector/trace/v1/trace_service.grpc.pb.h"
 
+// clang-format off
 #include "opentelemetry/exporters/otlp/protobuf_include_suffix.h"
+// clang-format on
 
+#include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/trace/exporter.h"
 
 #include "opentelemetry/exporters/otlp/otlp_environment.h"
@@ -23,6 +28,9 @@ namespace exporter
 namespace otlp
 {
 
+#ifdef ENABLE_ASYNC_EXPORT
+class OtlpGrpcClientReferenceGuard;
+#endif
 class OtlpGrpcClient;
 
 /**
@@ -36,11 +44,24 @@ class OtlpGrpcExporter final : public opentelemetry::sdk::trace::SpanExporter
    */
   OtlpGrpcExporter();
 
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Create an OtlpGrpcExporter using specified OtlpGrpcClient.
+   *
+   * @param options options to create exporter
+   * @param client the gRPC client to use
+   */
+  OtlpGrpcExporter(const OtlpGrpcExporterOptions &options,
+                   nostd::shared_ptr<OtlpGrpcClient> client);
+#endif
+
   /**
    * Create an OtlpGrpcExporter using the given options.
    */
   explicit OtlpGrpcExporter(const OtlpGrpcExporterOptions &options);
 
+  ~OtlpGrpcExporter() override;
+
   /**
    * Create a span recordable.
    * @return a newly initialized Recordable object
@@ -71,27 +92,49 @@ class OtlpGrpcExporter final : public opentelemetry::sdk::trace::SpanExporter
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
 
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Get the Client object
+   *
+   * @return return binded gRPC client
+   */
+  const nostd::shared_ptr<OtlpGrpcClient> &GetClient() const noexcept;
+#endif
+
 private:
   // The configuration options associated with this exporter.
   const OtlpGrpcExporterOptions options_;
 
 #ifdef ENABLE_ASYNC_EXPORT
-  std::shared_ptr<OtlpGrpcClient> client_;
+  nostd::shared_ptr<OtlpGrpcClient> client_;
+  nostd::shared_ptr<OtlpGrpcClientReferenceGuard> client_reference_guard_;
 #endif
 
   // For testing
   friend class OtlpGrpcExporterTestPeer;
   friend class OtlpGrpcLogRecordExporterTestPeer;
 
   // Store service stub internally. Useful for testing.
-  std::unique_ptr<proto::collector::trace::v1::TraceService::StubInterface> trace_service_stub_;
+  nostd::shared_ptr<proto::collector::trace::v1::TraceService::StubInterface> trace_service_stub_;
 
   /**
    * Create an OtlpGrpcExporter using the specified service stub.
    * Only tests can call this constructor directly.
    * @param stub the service stub to be used for exporting
    */
   OtlpGrpcExporter(std::unique_ptr<proto::collector::trace::v1::TraceService::StubInterface> stub);
+
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Create an OtlpGrpcExporter using the specified service stub and gRPC client.
+   * Only tests can call this constructor directly.
+   * @param stub the service stub to be used for exporting
+   * @param client the gRPC client to use
+   */
+  OtlpGrpcExporter(std::unique_ptr<proto::collector::trace::v1::TraceService::StubInterface> stub,
+                   nostd::shared_ptr<OtlpGrpcClient> client);
+#endif
+
   std::atomic<bool> is_shutdown_{false};
   bool isShutdown() const noexcept;
 };

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_exporter_factory.h

@@ -6,6 +6,7 @@
 #include <memory>
 
 #include "opentelemetry/exporters/otlp/otlp_grpc_exporter_options.h"
+#include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/trace/exporter.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
@@ -14,6 +15,8 @@ namespace exporter
 namespace otlp
 {
 
+class OtlpGrpcClient;
+
 /**
  * Factory class for OtlpGrpcExporter.
  */
@@ -30,6 +33,15 @@ class OPENTELEMETRY_EXPORT OtlpGrpcExporterFactory
    */
   static std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> Create(
       const OtlpGrpcExporterOptions &options);
+
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Create an OtlpGrpcExporter using the given options and gRPC client.
+   */
+  static std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> Create(
+      const OtlpGrpcExporterOptions &options,
+      nostd::shared_ptr<OtlpGrpcClient> client);
+#endif
 };
 
 }  // namespace otlp

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_log_record_exporter.h

@@ -4,15 +4,18 @@
 #pragma once
 
 // clang-format off
-
 #include "opentelemetry/exporters/otlp/protobuf_include_prefix.h"
+// clang-format on
+
 #include "opentelemetry/proto/collector/logs/v1/logs_service.grpc.pb.h"
-#include "opentelemetry/exporters/otlp/protobuf_include_suffix.h"
 
+// clang-format off
+#include "opentelemetry/exporters/otlp/protobuf_include_suffix.h"
 // clang-format on
 
 #include "opentelemetry/exporters/otlp/otlp_environment.h"
 #include "opentelemetry/exporters/otlp/otlp_grpc_log_record_exporter_options.h"
+#include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/logs/exporter.h"
 
 #include <atomic>
@@ -23,6 +26,9 @@ namespace exporter
 namespace otlp
 {
 
+#ifdef ENABLE_ASYNC_EXPORT
+class OtlpGrpcClientReferenceGuard;
+#endif
 class OtlpGrpcClient;
 
 /**
@@ -36,12 +42,25 @@ class OtlpGrpcLogRecordExporter : public opentelemetry::sdk::logs::LogRecordExpo
    */
   OtlpGrpcLogRecordExporter();
 
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Create an OtlpGrpcLogRecordExporter using specified OtlpGrpcClient.
+   *
+   * @param options options to create exporter
+   * @param client the gRPC client to use
+   */
+  OtlpGrpcLogRecordExporter(const OtlpGrpcLogRecordExporterOptions &options,
+                            nostd::shared_ptr<OtlpGrpcClient> client);
+#endif
+
   /**
    * Create an OtlpGrpcLogRecordExporter with user specified options.
    * @param options An object containing the user's configuration options.
    */
   OtlpGrpcLogRecordExporter(const OtlpGrpcLogRecordExporterOptions &options);
 
+  ~OtlpGrpcLogRecordExporter() override;
+
   /**
    * Creates a recordable that stores the data in protobuf.
    * @return a newly initialized Recordable object.
@@ -72,19 +91,29 @@ class OtlpGrpcLogRecordExporter : public opentelemetry::sdk::logs::LogRecordExpo
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
 
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Get the Client object
+   *
+   * @return return binded gRPC client
+   */
+  const nostd::shared_ptr<OtlpGrpcClient> &GetClient() const noexcept;
+#endif
+
 private:
   // Configuration options for the exporter
   const OtlpGrpcLogRecordExporterOptions options_;
 
 #ifdef ENABLE_ASYNC_EXPORT
-  std::shared_ptr<OtlpGrpcClient> client_;
+  nostd::shared_ptr<OtlpGrpcClient> client_;
+  nostd::shared_ptr<OtlpGrpcClientReferenceGuard> client_reference_guard_;
 #endif
 
   // For testing
   friend class OtlpGrpcLogRecordExporterTestPeer;
 
   // Store service stub internally. Useful for testing.
-  std::unique_ptr<proto::collector::logs::v1::LogsService::StubInterface> log_service_stub_;
+  nostd::shared_ptr<proto::collector::logs::v1::LogsService::StubInterface> log_service_stub_;
 
   /**
    * Create an OtlpGrpcLogRecordExporter using the specified service stub.
@@ -93,6 +122,18 @@ class OtlpGrpcLogRecordExporter : public opentelemetry::sdk::logs::LogRecordExpo
    */
   OtlpGrpcLogRecordExporter(
       std::unique_ptr<proto::collector::logs::v1::LogsService::StubInterface> stub);
+#ifdef ENABLE_ASYNC_EXPORT
+  /**
+   * Create an OtlpGrpcLogRecordExporter using the specified service stub and gRPC client.
+   * Only tests can call this constructor directly.
+   * @param stub the service stub to be used for exporting
+   * @param client the gRPC client to use
+   */
+  OtlpGrpcLogRecordExporter(
+      std::unique_ptr<proto::collector::logs::v1::LogsService::StubInterface> stub,
+      nostd::shared_ptr<OtlpGrpcClient> client);
+#endif
+
   std::atomic<bool> is_shutdown_{false};
   bool isShutdown() const noexcept;
 };