Implement https:/open-telemetry/opentelemetry-specification/pull/2452

CHANGELOG.md

@@ -15,7 +15,6 @@ Increment the:
 
 ## [Unreleased]
 
-* [SDK] Async Batch Span/Log processor with max async support ([#1306](https:/open-telemetry/opentelemetry-cpp/pull/1306))
 * [EXPORTER] OTLP http exporter allow concurrency session ([#1209](https:/open-telemetry/opentelemetry-cpp/pull/1209))
 * [EXT] `curl::HttpClient` use `curl_multi_handle` instead of creating a thread
  for every request and it's able to reuse connections now. ([#1317](https:/open-telemetry/opentelemetry-cpp/pull/1317))

exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_exporter.h

@@ -35,6 +35,10 @@ struct ElasticsearchExporterOptions
  // Whether to print the status of the exporter in the console
  bool console_debug_;
 
+# ifdef ENABLE_ASYNC_EXPORT
+ bool asynchronous_mode_ = false;
+# endif
+
  /**
  * Constructor for the ElasticsearchExporterOptions. By default, the endpoint is
  * localhost:9200/logs with a timeout of 30 seconds and disabled console debugging
@@ -49,12 +53,19 @@ struct ElasticsearchExporterOptions
  int port = 9200,
  std::string index = "logs",
  int response_timeout = 30,
- bool console_debug = false)
- : host_{host},
- port_{port},
- index_{index},
- response_timeout_{response_timeout},
- console_debug_{console_debug}
+ bool console_debug = false
+# ifdef ENABLE_ASYNC_EXPORT
+ ,
+ bool asynchronous_mode = false
+# endif
+ )
+ : host_{host}, port_{port}, index_{index}, response_timeout_{response_timeout}, console_debug_
+ {
+ console_debug
+ }
+# ifdef ENABLE_ASYNC_EXPORT
+ , asynchronous_mode_ { asynchronous_mode }
+# endif
  {}
 };
 
@@ -89,19 +100,6 @@ class ElasticsearchLogExporter final : public opentelemetry::sdk::logs::LogExpor
  const opentelemetry::nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>>
  &records) noexcept override;
 
-# ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a vector of log records to the Elasticsearch instance asynchronously.
- * @param records A list of log records to send to Elasticsearch.
- * @param result_callback callback function accepting ExportResult as argument
- */
- void Export(
- const opentelemetry::nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>>
- &records,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
- override;
-# endif
-
  /**
  * Shutdown this exporter.
  * @param timeout The maximum time to wait for the shutdown method to return

exporters/elasticsearch/src/es_log_exporter.cc

@@ -246,6 +246,32 @@ sdk::common::ExportResult ElasticsearchLogExporter::Export(
  std::vector<uint8_t> body_vec(body.begin(), body.end());
  request->SetBody(body_vec);
 
+# ifdef ENABLE_ASYNC_EXPORT
+ if (options_.asynchronous_mode_)
+ {
+ // Send the request
+ std::size_t span_count = records.size();
+ auto handler = std::make_shared<AsyncResponseHandler>(
+ session,
+ [span_count](opentelemetry::sdk::common::ExportResult result) {
+ if (result != opentelemetry::sdk::common::ExportResult::kSuccess)
+ {
+ OTEL_INTERNAL_LOG_ERROR("[ES Trace Exporter] ERROR: Export "
+ << span_count
+ << " trace span(s) error: " << static_cast<int>(result));
+ }
+ else
+ {
+ OTEL_INTERNAL_LOG_DEBUG("[ES Trace Exporter] DEBUG: Export "
+ << span_count << " trace span(s) success");
+ }
+ return true;
+ },
+ options_.console_debug_);
+ session->SendRequest(handler);
+ return sdk::common::ExportResult::kSuccess;
+ }
+# endif
  // Send the request
  auto handler = std::make_shared<ResponseHandler>(options_.console_debug_);
  session->SendRequest(handler);
@@ -283,53 +309,6 @@ sdk::common::ExportResult ElasticsearchLogExporter::Export(
  return sdk::common::ExportResult::kSuccess;
 }
 
-# ifdef ENABLE_ASYNC_EXPORT
-void ElasticsearchLogExporter::Export(
- const opentelemetry::nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>>
- &records,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
-{
- // Return failure if this exporter has been shutdown
- if (isShutdown())
- {
- OTEL_INTERNAL_LOG_ERROR("[ES Log Exporter] Exporting "
- << records.size() << " log(s) failed, exporter is shutdown");
- return;
- }
-
- // Create a connection to the ElasticSearch instance
- auto session = http_client_->CreateSession(options_.host_ + std::to_string(options_.port_));
- auto request = session->CreateRequest();
-
- // Populate the request with headers and methods
- request->SetUri(options_.index_ + "/_bulk?pretty");
- request->SetMethod(http_client::Method::Post);
- request->AddHeader("Content-Type", "application/json");
- request->SetTimeoutMs(std::chrono::milliseconds(1000 * options_.response_timeout_));
-
- // Create the request body
- std::string body = "";
- for (auto &record : records)
- {
- // Append {"index":{}} before JSON body, which tells Elasticsearch to write to index specified
- // in URI
- body += "{\"index\" : {}}\n";
-
- // Add the context of the Recordable
- auto json_record = std::unique_ptr<ElasticSearchRecordable>(
- static_cast<ElasticSearchRecordable *>(record.release()));
- body += json_record->GetJSON().dump() + "\n";
- }
- std::vector<uint8_t> body_vec(body.begin(), body.end());
- request->SetBody(body_vec);
-
- // Send the request
- auto handler = std::make_shared<AsyncResponseHandler>(session, std::move(result_callback),
- options_.console_debug_);
- session->SendRequest(handler);
-}
-# endif
-
 bool ElasticsearchLogExporter::Shutdown(std::chrono::microseconds timeout) noexcept
 {
  const std::lock_guard<opentelemetry::common::SpinLockMutex> locked(lock_);

exporters/jaeger/include/opentelemetry/exporters/jaeger/jaeger_exporter.h

@@ -61,17 +61,6 @@ class JaegerExporter final : public opentelemetry::sdk::trace::SpanExporter
  const nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>> &spans) noexcept
  override;
 
-#ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a batch of span recordables asynchronously.
- * @param spans a span of unique pointers to span recordables
- * @param result_callback callback function accepting ExportResult as argument
- */
- void Export(const nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)>
- &&result_callback) noexcept override;
-#endif
-
  /**
  * Shutdown the exporter.
  * @param timeout an option timeout, default to max.

exporters/jaeger/src/jaeger_exporter.cc

@@ -70,17 +70,6 @@ sdk_common::ExportResult JaegerExporter::Export(
  return sdk_common::ExportResult::kSuccess;
 }
 
-#ifdef ENABLE_ASYNC_EXPORT
-void JaegerExporter::Export(
- const nostd::span<std::unique_ptr<sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
-{
- OTEL_INTERNAL_LOG_WARN(" async not supported. Making sync interface call");
- auto status = Export(spans);
- result_callback(status);
-}
-#endif
-
 void JaegerExporter::InitializeEndpoint()
 {
  if (options_.transport_format == TransportFormat::kThriftUdpCompact)

exporters/memory/include/opentelemetry/exporters/memory/in_memory_span_exporter.h

@@ -64,22 +64,6 @@ class InMemorySpanExporter final : public opentelemetry::sdk::trace::SpanExporte
  return sdk::common::ExportResult::kSuccess;
  }
 
-#ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a batch of span recordables asynchronously.
- * @param spans a span of unique pointers to span recordables
- * @param result_callback callback function accepting ExportResult as argument
- */
- void Export(const nostd::span<std::unique_ptr<sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)>
- &&result_callback) noexcept override
- {
- OTEL_INTERNAL_LOG_WARN(" async not supported. Making sync interface call");
- auto status = Export(spans);
- result_callback(status);
- }
-#endif
-
  /**
  * @param timeout an optional value containing the timeout of the exporter
  * note: passing custom timeout values is not currently supported for this exporter

exporters/ostream/include/opentelemetry/exporters/ostream/log_exporter.h

@@ -39,15 +39,6 @@ class OStreamLogExporter final : public opentelemetry::sdk::logs::LogExporter
  const opentelemetry::nostd::span<std::unique_ptr<sdk::logs::Recordable>> &records) noexcept
  override;
 
-# ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a span of logs sent from the processor asynchronously.
- */
- void Export(
- const opentelemetry::nostd::span<std::unique_ptr<sdk::logs::Recordable>> &records,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept;
-# endif
-
  /**
  * Marks the OStream Log Exporter as shut down.
  */

exporters/ostream/include/opentelemetry/exporters/ostream/span_exporter.h

@@ -38,14 +38,6 @@ class OStreamSpanExporter final : public opentelemetry::sdk::trace::SpanExporter
  const opentelemetry::nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>>
  &spans) noexcept override;
 
-#ifdef ENABLE_ASYNC_EXPORT
- void Export(
- const opentelemetry::nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>>
- &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
- override;
-#endif
-
  bool Shutdown(
  std::chrono::microseconds timeout = std::chrono::microseconds::max()) noexcept override;
 

exporters/ostream/src/log_exporter.cc

@@ -102,17 +102,6 @@ sdk::common::ExportResult OStreamLogExporter::Export(
  return sdk::common::ExportResult::kSuccess;
 }
 
-# ifdef ENABLE_ASYNC_EXPORT
-void OStreamLogExporter::Export(
- const opentelemetry::nostd::span<std::unique_ptr<sdk::logs::Recordable>> &records,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
-{
- // Do not have async support
- auto result = Export(records);
- result_callback(result);
-}
-# endif
-
 bool OStreamLogExporter::Shutdown(std::chrono::microseconds) noexcept
 {
  const std::lock_guard<opentelemetry::common::SpinLockMutex> locked(lock_);

exporters/ostream/src/span_exporter.cc

@@ -98,16 +98,6 @@ sdk::common::ExportResult OStreamSpanExporter::Export(
  return sdk::common::ExportResult::kSuccess;
 }
 
-#ifdef ENABLE_ASYNC_EXPORT
-void OStreamSpanExporter::Export(
- const opentelemetry::nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
-{
- auto result = Export(spans);
- result_callback(result);
-}
-#endif
-
 bool OStreamSpanExporter::Shutdown(std::chrono::microseconds timeout) noexcept
 {
  const std::lock_guard<opentelemetry::common::SpinLockMutex> locked(lock_);

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

@@ -52,17 +52,6 @@ class OtlpGrpcExporter final : public opentelemetry::sdk::trace::SpanExporter
  sdk::common::ExportResult Export(
  const nostd::span<std::unique_ptr<sdk::trace::Recordable>> &spans) noexcept override;
 
-#ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a batch of span recordables asynchronously.
- * @param spans a span of unique pointers to span recordables
- * @param result_callback callback function accepting ExportResult as argument
- */
- virtual void Export(const nostd::span<std::unique_ptr<sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)>
- &&result_callback) noexcept override;
-#endif
-
  /**
  * Shut down the exporter.
  * @param timeout an optional timeout, the default timeout of 0 means that no

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_log_exporter.h

@@ -55,18 +55,6 @@ class OtlpGrpcLogExporter : public opentelemetry::sdk::logs::LogExporter
  const nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>> &records) noexcept
  override;
 
-# ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a vector of log records asynchronously.
- * @param records A list of log records.
- * @param result_callback callback function accepting ExportResult as argument
- */
- virtual void Export(
- const nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>> &records,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
- override;
-# endif
-
  /**
  * Shutdown this exporter.
  * @param timeout The maximum time to wait for the shutdown method to return.

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_http_client.h

@@ -150,6 +150,12 @@ class OtlpHttpClient
  */
  void ReleaseSession(const opentelemetry::ext::http::client::Session &session) noexcept;
 
+ /**
+ * Get options of current OTLP http client.
+ * @return options of current OTLP http client.
+ */
+ inline const OtlpHttpClientOptions &GetOptions() const noexcept { return options_; }
+
 private:
  struct HttpSessionData
  {

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_http_exporter.h

@@ -92,18 +92,6 @@ class OtlpHttpExporter final : public opentelemetry::sdk::trace::SpanExporter
  const nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>> &spans) noexcept
  override;
 
-#ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a batch of span recordables asynchronously.
- * @param spans a span of unique pointers to span recordables
- * @param result_callback callback function accepting ExportResult as argument
- */
- virtual void Export(
- const nostd::span<std::unique_ptr<opentelemetry::sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
- override;
-#endif
-
  /**
  * Shut down the exporter.
  * @param timeout an optional timeout, the default timeout of 0 means that no

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_http_log_exporter.h

@@ -93,18 +93,6 @@ class OtlpHttpLogExporter final : public opentelemetry::sdk::logs::LogExporter
  const nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>> &records) noexcept
  override;
 
-# ifdef ENABLE_ASYNC_EXPORT
- /**
- * Exports a vector of log records asynchronously.
- * @param records A list of log records.
- * @param result_callback callback function accepting ExportResult as argument
- */
- virtual void Export(
- const nostd::span<std::unique_ptr<opentelemetry::sdk::logs::Recordable>> &records,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
- override;
-# endif
-
  /**
  * Shutdown this exporter.
  * @param timeout The maximum time to wait for the shutdown method to return

exporters/otlp/src/otlp_grpc_exporter.cc

@@ -143,18 +143,6 @@ sdk::common::ExportResult OtlpGrpcExporter::Export(
  return sdk::common::ExportResult::kSuccess;
 }
 
-#ifdef ENABLE_ASYNC_EXPORT
-void OtlpGrpcExporter::Export(
- const nostd::span<std::unique_ptr<sdk::trace::Recordable>> &spans,
- std::function<bool(opentelemetry::sdk::common::ExportResult)> &&result_callback) noexcept
-{
- OTEL_INTERNAL_LOG_WARN(
- "[OTLP TRACE GRPC Exporter] async not supported. Making sync interface call");
- auto status = Export(spans);
- result_callback(status);
-}
-#endif
-
 bool OtlpGrpcExporter::Shutdown(std::chrono::microseconds timeout) noexcept
 {
  const std::lock_guard<opentelemetry::common::SpinLockMutex> locked(lock_);