Merge branch 'main' into cpp-project

CHANGELOG.md

@@ -21,11 +21,25 @@ Increment the:
 * [API] Remove include_trace_context
   [#2194](https://github.com/open-telemetry/opentelemetry-cpp/pull/2194)
 
+* [API] Remove Meters
+  [#2205](https://github.com/open-telemetry/opentelemetry-cpp/pull/2205)
+
 * [SDK] MeterProvider should own MeterContext, not share it
   [#2218](https://github.com/open-telemetry/opentelemetry-cpp/pull/2218)
 
+* [SDK] TracerProvider should own TracerContext, not share it
+  [#2221](https://github.com/open-telemetry/opentelemetry-cpp/pull/2221)
+
 Important changes:
 
+* [API] Remove Meters
+  [#2205](https://github.com/open-telemetry/opentelemetry-cpp/pull/2205)
+  * The CMake option `WITH_REMOVE_METER_PREVIEW` was added.
+  * This option is experimental, and may change in the future.
+  * Enabling it is an ABI breaking change.
+
+Breaking changes:
+
 * [REMOVAL] Remove the jaeger exporter
   [#2031](https://github.com/open-telemetry/opentelemetry-cpp/pull/2031)
   * The CMake `WITH_JAEGER` option has been removed
@@ -37,6 +51,14 @@ Important changes:
     `MeterContext`, instead of a `shared_ptr`.
   * Please adjust SDK configuration code accordingly.
 
+* [SDK] TracerProvider should own TracerContext, not share it
+  [#2221](https://github.com/open-telemetry/opentelemetry-cpp/pull/2221)
+  * The `TracerProvider` constructor now takes a `unique_ptr` on
+    `TracerContext`, instead of a `shared_ptr`.
+  * The `LoggerProvider` constructor now takes a `unique_ptr` on
+    `LoggerContext`, instead of a `shared_ptr`.
+  * Please adjust SDK configuration code accordingly.
+
 ## [1.9.1] 2023-05-26
 
 * [DEPRECATION] Drop C++11 support

CMakeLists.txt

@@ -197,6 +197,14 @@ option(WITH_OPENTRACING "Whether to include the Opentracing shim" OFF)
 option(OTELCPP_VERSIONED_LIBS "Whether to generate the versioned shared libs"
        OFF)
 
+#
+# This option is experimental, subject to change in the spec:
+#
+# * https://github.com/open-telemetry/opentelemetry-specification/issues/2232
+#
+option(WITH_REMOVE_METER_PREVIEW
+       "EXPERIMENTAL, ABI BREAKING: Allow to remove a meter" OFF)
+
 if(OTELCPP_VERSIONED_LIBS AND NOT BUILD_SHARED_LIBS)
   message(FATAL_ERROR "OTELCPP_VERSIONED_LIBS=ON requires BUILD_SHARED_LIBS=ON")
 endif()

api/CMakeLists.txt

@@ -98,6 +98,11 @@ if(WITH_ASYNC_EXPORT_PREVIEW)
   target_compile_definitions(opentelemetry_api INTERFACE ENABLE_ASYNC_EXPORT)
 endif()
 
+if(WITH_REMOVE_METER_PREVIEW)
+  target_compile_definitions(opentelemetry_api
+                             INTERFACE ENABLE_REMOVE_METER_PREVIEW)
+endif()
+
 # A better place should be in sdk, not api
 if(WITH_OTLP_HTTP_SSL_PREVIEW)
   target_compile_definitions(opentelemetry_api

api/include/opentelemetry/metrics/meter_provider.h

@@ -29,6 +29,11 @@ class MeterProvider
   virtual nostd::shared_ptr<Meter> GetMeter(nostd::string_view library_name,
                                             nostd::string_view library_version = "",
                                             nostd::string_view schema_url      = "") noexcept = 0;
+#ifdef ENABLE_REMOVE_METER_PREVIEW
+  virtual void RemoveMeter(nostd::string_view library_name,
+                           nostd::string_view library_version = "",
+                           nostd::string_view schema_url      = "") noexcept = 0;
+#endif
 };
 }  // namespace metrics
 OPENTELEMETRY_END_NAMESPACE

api/include/opentelemetry/metrics/noop.h

@@ -203,6 +203,13 @@ class NoopMeterProvider final : public MeterProvider
     return meter_;
   }
 
+#ifdef ENABLE_REMOVE_METER_PREVIEW
+  void RemoveMeter(nostd::string_view /* name */,
+                   nostd::string_view /* version */,
+                   nostd::string_view /* schema_url */) noexcept override
+  {}
+#endif
+
 private:
   nostd::shared_ptr<Meter> meter_;
 };

ci/do_ci.sh

@@ -106,6 +106,7 @@ elif [[ "$1" == "cmake.maintainer.sync.test" ]]; then
         -DWITH_OTLP_HTTP=ON \
         -DWITH_OTLP_HTTP_SSL_PREVIEW=ON \
         -DWITH_OTLP_HTTP_SSL_TLS_PREVIEW=ON \
+        -DWITH_REMOVE_METER_PREVIEW=ON \
         -DWITH_PROMETHEUS=ON \
         -DWITH_EXAMPLES=ON \
         -DWITH_EXAMPLES_HTTP=ON \
@@ -129,6 +130,7 @@ elif [[ "$1" == "cmake.maintainer.async.test" ]]; then
         -DWITH_OTLP_HTTP=ON \
         -DWITH_OTLP_HTTP_SSL_PREVIEW=ON \
         -DWITH_OTLP_HTTP_SSL_TLS_PREVIEW=ON \
+        -DWITH_REMOVE_METER_PREVIEW=ON \
         -DWITH_PROMETHEUS=ON \
         -DWITH_EXAMPLES=ON \
         -DWITH_EXAMPLES_HTTP=ON \
@@ -153,6 +155,7 @@ elif [[ "$1" == "cmake.maintainer.cpp11.async.test" ]]; then
         -DWITH_OTLP_HTTP=ON \
         -DWITH_OTLP_HTTP_SSL_PREVIEW=ON \
         -DWITH_OTLP_HTTP_SSL_TLS_PREVIEW=ON \
+        -DWITH_REMOVE_METER_PREVIEW=ON \
         -DWITH_PROMETHEUS=ON \
         -DWITH_EXAMPLES=ON \
         -DWITH_EXAMPLES_HTTP=ON \

examples/grpc/tracer_common.h

@@ -80,10 +80,10 @@ void InitTracer()
   std::vector<std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor>> processors;
   processors.push_back(std::move(processor));
   // Default is an always-on sampler.
-  std::shared_ptr<opentelemetry::sdk::trace::TracerContext> context =
+  std::unique_ptr<opentelemetry::sdk::trace::TracerContext> context =
       opentelemetry::sdk::trace::TracerContextFactory::Create(std::move(processors));
   std::shared_ptr<opentelemetry::trace::TracerProvider> provider =
-      opentelemetry::sdk::trace::TracerProviderFactory::Create(context);
+      opentelemetry::sdk::trace::TracerProviderFactory::Create(std::move(context));
   // Set the global trace provider
   opentelemetry::trace::Provider::SetTracerProvider(provider);
 

examples/http/tracer_common.h

@@ -70,10 +70,10 @@ void InitTracer()
   std::vector<std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor>> processors;
   processors.push_back(std::move(processor));
   // Default is an always-on sampler.
-  std::shared_ptr<opentelemetry::sdk::trace::TracerContext> context =
+  std::unique_ptr<opentelemetry::sdk::trace::TracerContext> context =
       opentelemetry::sdk::trace::TracerContextFactory::Create(std::move(processors));
   std::shared_ptr<opentelemetry::trace::TracerProvider> provider =
-      opentelemetry::sdk::trace::TracerProviderFactory::Create(context);
+      opentelemetry::sdk::trace::TracerProviderFactory::Create(std::move(context));
   // Set the global trace provider
   opentelemetry::trace::Provider::SetTracerProvider(provider);
 

exporters/otlp/test/otlp_grpc_log_record_exporter_test.cc

@@ -154,7 +154,7 @@ TEST_F(OtlpGrpcLogRecordExporterTestPeer, ExportIntegrationTest)
   std::unique_ptr<proto::collector::trace::v1::TraceService::StubInterface> trace_stub_interface(
       trace_mock_stub);
 
-  auto trace_provider = opentelemetry::nostd::shared_ptr<opentelemetry::v1::trace::TracerProvider>(
+  auto trace_provider = opentelemetry::nostd::shared_ptr<opentelemetry::trace::TracerProvider>(
       opentelemetry::sdk::trace::TracerProviderFactory::Create(
           opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(
               GetExporter(trace_stub_interface))));
@@ -174,7 +174,7 @@ TEST_F(OtlpGrpcLogRecordExporterTestPeer, ExportIntegrationTest)
 
     auto logger = provider->GetLogger("test", "opentelelemtry_library", "", schema_url,
                                       {{"scope_key1", "scope_value"}, {"scope_key2", 2}});
-    std::unordered_map<std::string, opentelemetry::v1::common::AttributeValue> attributes;
+    std::unordered_map<std::string, opentelemetry::common::AttributeValue> attributes;
     attributes["service.name"]     = "unit_test_service";
     attributes["tenant.id"]        = "test_user";
     attributes["bool_value"]       = true;
@@ -197,7 +197,7 @@ TEST_F(OtlpGrpcLogRecordExporterTestPeer, ExportIntegrationTest)
   opentelemetry::trace::Provider::SetTracerProvider(
       opentelemetry::nostd::shared_ptr<opentelemetry::trace::TracerProvider>(
           new opentelemetry::trace::NoopTracerProvider()));
-  trace_provider = opentelemetry::nostd::shared_ptr<opentelemetry::v1::trace::TracerProvider>();
+  trace_provider = opentelemetry::nostd::shared_ptr<opentelemetry::trace::TracerProvider>();
 }
 
 }  // namespace otlp

ext/test/w3c_tracecontext_test/main.cc

@@ -55,9 +55,10 @@ void initTracer()
       new trace_sdk::SimpleSpanProcessor(std::move(exporter)));
   std::vector<std::unique_ptr<trace_sdk::SpanProcessor>> processors;
   processors.push_back(std::move(processor));
-  auto context = std::make_shared<trace_sdk::TracerContext>(std::move(processors));
-  auto provider =
-      nostd::shared_ptr<trace_api::TracerProvider>(new trace_sdk::TracerProvider(context));
+  auto context = std::unique_ptr<trace_sdk::TracerContext>(
+      new trace_sdk::TracerContext(std::move(processors)));
+  auto provider = nostd::shared_ptr<trace_api::TracerProvider>(
+      new trace_sdk::TracerProvider(std::move(context)));
   // Set the global trace provider
   trace_api::Provider::SetTracerProvider(provider);
 }

sdk/include/opentelemetry/sdk/logs/logger_context.h

@@ -9,6 +9,7 @@
 #  include <memory>
 #  include <vector>
 
+#  include "opentelemetry/sdk/logs/processor.h"
 #  include "opentelemetry/sdk/resource/resource.h"
 #  include "opentelemetry/version.h"
 
@@ -17,7 +18,6 @@ namespace sdk
 {
 namespace logs
 {
-class LogRecordProcessor;
 
 /**
  * A class which stores the LoggerContext context.
@@ -40,10 +40,10 @@ class LoggerContext
                              opentelemetry::sdk::resource::Resource::Create({})) noexcept;
 
   /**
-   * Attaches a log processor to list of configured processors to this tracer context.
+   * Attaches a log processor to list of configured processors to this logger context.
    * Processor once attached can't be removed.
    * @param processor The new log processor for this tracer. This must not be
-   * a nullptr. Ownership is given to the `TracerContext`.
+   * a nullptr. Ownership is given to the `LoggerContext`.
    *
    * Note: This method is not thread safe.
    */

sdk/include/opentelemetry/sdk/logs/logger_provider.h

@@ -56,9 +56,9 @@ class LoggerProvider final : public opentelemetry::logs::LoggerProvider
 
   /**
    * Initialize a new logger provider with a specified context
-   * @param context The shared logger configuration/pipeline for this provider.
+   * @param context The owned logger configuration/pipeline for this provider.
    */
-  explicit LoggerProvider(std::shared_ptr<sdk::logs::LoggerContext> context) noexcept;
+  explicit LoggerProvider(std::unique_ptr<LoggerContext> context) noexcept;
 
   ~LoggerProvider() override;
 
@@ -106,7 +106,7 @@ class LoggerProvider final : public opentelemetry::logs::LoggerProvider
 private:
   // order of declaration is important here - loggers should destroy only after context.
   std::vector<std::shared_ptr<opentelemetry::sdk::logs::Logger>> loggers_;
-  std::shared_ptr<sdk::logs::LoggerContext> context_;
+  std::shared_ptr<LoggerContext> context_;
   std::mutex lock_;
 };
 }  // namespace logs

sdk/include/opentelemetry/sdk/logs/logger_provider_factory.h

@@ -64,7 +64,7 @@ class OPENTELEMETRY_EXPORT LoggerProviderFactory
    * Create a LoggerProvider.
    */
   static std::unique_ptr<opentelemetry::logs::LoggerProvider> Create(
-      std::shared_ptr<sdk::logs::LoggerContext> context);
+      std::unique_ptr<LoggerContext> context);
 };
 
 }  // namespace logs

sdk/include/opentelemetry/sdk/metrics/meter_context.h

@@ -115,6 +115,10 @@ class MeterContext : public std::enable_shared_from_this<MeterContext>
    */
   void AddMeter(std::shared_ptr<Meter> meter);
 
+  void RemoveMeter(nostd::string_view name,
+                   nostd::string_view version,
+                   nostd::string_view schema_url);
+
   /**
    * Force all active Collectors to flush any buffered meter data
    * within the given timeout.

sdk/include/opentelemetry/sdk/metrics/meter_provider.h

@@ -53,6 +53,12 @@ class MeterProvider final : public opentelemetry::metrics::MeterProvider
       nostd::string_view version    = "",
       nostd::string_view schema_url = "") noexcept override;
 
+#ifdef ENABLE_REMOVE_METER_PREVIEW
+  void RemoveMeter(nostd::string_view name,
+                   nostd::string_view version,
+                   nostd::string_view schema_url) noexcept override;
+#endif
+
   /**
    * Obtain the resource associated with this meter provider.
    * @return The resource for this meter provider.

sdk/include/opentelemetry/sdk/trace/tracer_provider.h

@@ -57,9 +57,9 @@ class TracerProvider final : public opentelemetry::trace::TracerProvider
 
   /**
    * Initialize a new tracer provider with a specified context
-   * @param context The shared tracer configuration/pipeline for this provider.
+   * @param context The owned tracer configuration/pipeline for this provider.
    */
-  explicit TracerProvider(std::shared_ptr<TracerContext> context) noexcept;
+  explicit TracerProvider(std::unique_ptr<TracerContext> context) noexcept;
 
   ~TracerProvider() override;
 

sdk/include/opentelemetry/sdk/trace/tracer_provider_factory.h

@@ -78,7 +78,7 @@ class OPENTELEMETRY_EXPORT TracerProviderFactory
   /* Create with a tracer context. */
 
   static std::unique_ptr<opentelemetry::trace::TracerProvider> Create(
-      std::shared_ptr<TracerContext> context);
+      std::unique_ptr<TracerContext> context);
 };
 
 }  // namespace trace

sdk/src/logs/logger_provider.cc

@@ -24,29 +24,27 @@ LoggerProvider::LoggerProvider(std::unique_ptr<LogRecordProcessor> &&processor,
 {
   std::vector<std::unique_ptr<LogRecordProcessor>> processors;
   processors.emplace_back(std::move(processor));
-  context_ = std::make_shared<sdk::logs::LoggerContext>(std::move(processors), std::move(resource));
+  context_ = std::make_shared<LoggerContext>(std::move(processors), std::move(resource));
   OTEL_INTERNAL_LOG_DEBUG("[LoggerProvider] LoggerProvider created.");
 }
 
 LoggerProvider::LoggerProvider(std::vector<std::unique_ptr<LogRecordProcessor>> &&processors,
                                opentelemetry::sdk::resource::Resource resource) noexcept
-    : context_{
-          std::make_shared<sdk::logs::LoggerContext>(std::move(processors), std::move(resource))}
+    : context_{std::make_shared<LoggerContext>(std::move(processors), std::move(resource))}
 {}
 
 LoggerProvider::LoggerProvider() noexcept
-    : context_{std::make_shared<sdk::logs::LoggerContext>(
-          std::vector<std::unique_ptr<LogRecordProcessor>>{})}
+    : context_{std::make_shared<LoggerContext>(std::vector<std::unique_ptr<LogRecordProcessor>>{})}
 {}
 
-LoggerProvider::LoggerProvider(std::shared_ptr<sdk::logs::LoggerContext> context) noexcept
-    : context_{context}
+LoggerProvider::LoggerProvider(std::unique_ptr<LoggerContext> context) noexcept
+    : context_(std::move(context))
 {}
 
 LoggerProvider::~LoggerProvider()
 {
   // Logger hold the shared pointer to the context. So we can not use destructor of LoggerContext to
-  // Shutdown and flush all pending recordables when we hasve more than one loggers.These
+  // Shutdown and flush all pending recordables when we have more than one loggers. These
   // recordables may use the raw pointer of instrumentation_scope_ in Logger
   if (context_)
   {

sdk/src/logs/logger_provider_factory.cc

@@ -4,6 +4,7 @@
 #ifdef ENABLE_LOGS_PREVIEW
 
 #  include "opentelemetry/sdk/logs/logger_provider_factory.h"
+#  include "opentelemetry/sdk/logs/logger_context.h"
 #  include "opentelemetry/sdk/logs/logger_provider.h"
 #  include "opentelemetry/sdk/resource/resource.h"
 
@@ -46,9 +47,10 @@ std::unique_ptr<opentelemetry::logs::LoggerProvider> LoggerProviderFactory::Crea
 }
 
 std::unique_ptr<opentelemetry::logs::LoggerProvider> LoggerProviderFactory::Create(
-    std::shared_ptr<sdk::logs::LoggerContext> context)
+    std::unique_ptr<LoggerContext> context)
 {
-  std::unique_ptr<opentelemetry::logs::LoggerProvider> provider(new LoggerProvider(context));
+  std::unique_ptr<opentelemetry::logs::LoggerProvider> provider(
+      new LoggerProvider(std::move(context)));
   return provider;
 }
 

sdk/src/metrics/meter_context.cc

@@ -3,6 +3,7 @@
 
 #include "opentelemetry/sdk/metrics/meter_context.h"
 #include "opentelemetry/sdk/common/global_log_handler.h"
+#include "opentelemetry/sdk/metrics/meter.h"
 #include "opentelemetry/sdk/metrics/metric_reader.h"
 #include "opentelemetry/sdk/metrics/state/metric_collector.h"
 #include "opentelemetry/sdk_config.h"
@@ -79,6 +80,32 @@ void MeterContext::AddMeter(std::shared_ptr<Meter> meter)
   meters_.push_back(meter);
 }
 
+void MeterContext::RemoveMeter(nostd::string_view name,
+                               nostd::string_view version,
+                               nostd::string_view schema_url)
+{
+  std::lock_guard<opentelemetry::common::SpinLockMutex> guard(meter_lock_);
+
+  std::vector<std::shared_ptr<Meter>> filtered_meters;
+
+  for (auto &meter : meters_)
+  {
+    auto scope = meter->GetInstrumentationScope();
+    if (scope->equal(name, version, schema_url))
+    {
+      OTEL_INTERNAL_LOG_INFO("[MeterContext::RemoveMeter] removing meter name <"
+                             << name << ">, version <" << version << ">, URL <" << schema_url
+                             << ">");
+    }
+    else
+    {
+      filtered_meters.push_back(meter);
+    }
+  }
+
+  meters_.swap(filtered_meters);
+}
+
 bool MeterContext::Shutdown() noexcept
 {
   bool result = true;