[API] Add InstrumentationScope attributes in MeterProvider::GetMeter()

.github/workflows/ci.yml

@@ -193,6 +193,38 @@ jobs:
  run: |
  (cd ./functional/otlp; ./run_test.sh)
 
+ cmake_clang_maintainer_abiv2_test:
+ name: CMake clang 14 (maintainer mode, abiv2)
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ submodules: 'recursive'
+ - name: setup
+ env:
+ CC: /usr/bin/clang-14
+ CXX: /usr/bin/clang++-14
+ PROTOBUF_VERSION: 21.12
+ run: |
+ sudo -E ./ci/setup_cmake.sh
+ sudo -E ./ci/setup_ci_environment.sh
+ sudo -E ./ci/install_protobuf.sh
+ - name: run cmake clang (maintainer mode, abiv2)
+ env:
+ CC: /usr/bin/clang-14
+ CXX: /usr/bin/clang++-14
+ run: |
+ ./ci/do_ci.sh cmake.maintainer.abiv2.test
+ - name: generate test cert
+ env:
+ CFSSL_VERSION: 1.6.3
+ run: |
+ sudo -E ./tools/setup-cfssl.sh
+ (cd ./functional/cert; ./generate_cert.sh)
+ - name: run func test
+ run: |
+ (cd ./functional/otlp; ./run_test.sh)
+
  cmake_msvc_maintainer_test:
  name: CMake msvc (maintainer mode)
  runs-on: windows-latest

api/include/opentelemetry/metrics/meter_provider.h

@@ -3,8 +3,11 @@
 
 #pragma once
 
+#include "opentelemetry/common/key_value_iterable.h"
+#include "opentelemetry/common/key_value_iterable_view.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/nostd/string_view.h"
+#include "opentelemetry/nostd/type_traits.h"
 #include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
@@ -20,15 +23,111 @@ class MeterProvider
 {
 public:
  virtual ~MeterProvider() = default;
+
+#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+
+ /**
+ * Gets or creates a named Meter instance (ABI).
+ *
+ * @since ABI_VERSION 2
+ *
+ * @param[in] name Meter instrumentation scope
+ * @param[in] version Instrumentation scope version, optional
+ * @param[in] schema_url Instrumentation scope schema URL, optional
+ * @param[in] attributes Instrumentation scope attributes, optional
+ */
+ virtual nostd::shared_ptr<Meter> DoGetMeter(
+ nostd::string_view name,
+ nostd::string_view version,
+ nostd::string_view schema_url,
+ const common::KeyValueIterable *attributes) noexcept = 0;
+
+ /**
+ * Gets or creates a named Meter instance (API helper).
+ *
+ * @since ABI_VERSION 2
+ *
+ * @param[in] name Meter instrumentation scope
+ * @param[in] version Instrumentation scope version
+ * @param[in] schema_url Instrumentation scope schema URL
+ * @param[in] attributes Instrumentation scope attributes
+ */
+ nostd::shared_ptr<Meter> GetMeter(nostd::string_view name,
+ nostd::string_view version = "",
+ nostd::string_view schema_url = "",
+ const common::KeyValueIterable *attributes = nullptr)
+ {
+ return DoGetMeter(name, version, schema_url, attributes);
+ }
+
+ /**
+ * Gets or creates a named Meter instance (API helper).
+ *
+ * @since ABI_VERSION 2
+ *
+ * @param[in] name Meter instrumentation scope
+ * @param[in] version Instrumentation scope version
+ * @param[in] schema_url Instrumentation scope schema URL
+ * @param[in] attributes Instrumentation scope attributes
+ */
+ nostd::shared_ptr<Meter> GetMeter(
+ nostd::string_view name,
+ nostd::string_view version,
+ nostd::string_view schema_url,
+ std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>> attributes)
+ {
+ /* Build a container from std::initializer_list. */
+ nostd::span<const std::pair<nostd::string_view, common::AttributeValue>> attributes_span{
+ attributes.begin(), attributes.end()};
+
+ /* Build a view on the container. */
+ common::KeyValueIterableView<
+ nostd::span<const std::pair<nostd::string_view, common::AttributeValue>>>
+ iterable_attributes{attributes_span};
+
+ /* Add attributes using the view. */
+ return DoGetMeter(name, version, schema_url, &iterable_attributes);
+ }
+
+ /**
+ * Gets or creates a named Meter instance (API helper).
+ *
+ * @since ABI_VERSION 2
+ *
+ * @param[in] name Meter instrumentation scope
+ * @param[in] version Instrumentation scope version
+ * @param[in] schema_url Instrumentation scope schema URL
+ * @param[in] attributes Instrumentation scope attributes
+ */
+ template <class T,
+ nostd::enable_if_t<common::detail::is_key_value_iterable<T>::value> * = nullptr>
+ nostd::shared_ptr<Meter> GetMeter(nostd::string_view name,
+ nostd::string_view version,
+ nostd::string_view schema_url,
+ const T &attributes)
+ {
+ /* Build a view on the container. */
+ common::KeyValueIterableView<T> iterable_attributes(attributes);
+
+ /* Add attributes using the view. */
+ return DoGetMeter(name, version, schema_url, &iterable_attributes);
+ }
+
+#else
  /**
- * Gets or creates a named Meter instance.
+ * Gets or creates a named Meter instance (ABI)
  *
- * Optionally a version can be passed to create a named and versioned Meter
- * instance.
+ * @since ABI_VERSION 1
+ *
+ * @param[in] name Meter instrumentation scope
+ * @param[in] version Instrumentation scope version, optional
+ * @param[in] schema_url Instrumentation scope schema URL, optional
  */
- virtual nostd::shared_ptr<Meter> GetMeter(nostd::string_view library_name,
- nostd::string_view library_version = "",
- nostd::string_view schema_url = "") noexcept = 0;
+ virtual nostd::shared_ptr<Meter> GetMeter(nostd::string_view name,
+ nostd::string_view version = "",
+ nostd::string_view schema_url = "") noexcept = 0;
+#endif
+
 #ifdef ENABLE_REMOVE_METER_PREVIEW
  virtual void RemoveMeter(nostd::string_view library_name,
  nostd::string_view library_version = "",

api/include/opentelemetry/metrics/noop.h

@@ -196,12 +196,23 @@ class NoopMeterProvider final : public MeterProvider
 public:
  NoopMeterProvider() : meter_{nostd::shared_ptr<Meter>(new NoopMeter)} {}
 
- nostd::shared_ptr<Meter> GetMeter(nostd::string_view /* library_name */,
- nostd::string_view /* library_version */,
+#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+ nostd::shared_ptr<Meter> DoGetMeter(
+ nostd::string_view /* name */,
+ nostd::string_view /* version */,
+ nostd::string_view /* schema_url */,
+ const common::KeyValueIterable * /* attributes */) noexcept override
+ {
+ return meter_;
+ }
+#else
+ nostd::shared_ptr<Meter> GetMeter(nostd::string_view /* name */,
+ nostd::string_view /* version */,
  nostd::string_view /* schema_url */) noexcept override
  {
  return meter_;
  }
+#endif
 
 #ifdef ENABLE_REMOVE_METER_PREVIEW
  void RemoveMeter(nostd::string_view /* name */,

ci/do_ci.sh

@@ -174,6 +174,31 @@ elif [[ "$1" == "cmake.maintainer.cpp11.async.test" ]]; then
  make -k -j $(nproc)
  make test
  exit 0
+elif [[ "$1" == "cmake.maintainer.abiv2.test" ]]; then
+ cd "${BUILD_DIR}"
+ rm -rf *
+ cmake ${CMAKE_OPTIONS[@]} \
+ -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 \
+ -DWITH_ZIPKIN=ON \
+ -DBUILD_W3CTRACECONTEXT_TEST=ON \
+ -DWITH_ELASTICSEARCH=ON \
+ -DWITH_METRICS_EXEMPLAR_PREVIEW=ON \
+ -DWITH_ASYNC_EXPORT_PREVIEW=OFF \
+ -DOTELCPP_MAINTAINER_MODE=ON \
+ -DWITH_NO_DEPRECATED_CODE=ON \
+ -DWITH_ABI_VERSION_1=OFF \
+ -DWITH_ABI_VERSION_2=ON \
+ ${IWYU} \
+ "${SRC_DIR}"
+ eval "$MAKE_COMMAND"
+ make test
+ exit 0
 elif [[ "$1" == "cmake.with_async_export.test" ]]; then
  cd "${BUILD_DIR}"
  rm -rf *

sdk/include/opentelemetry/sdk/common/attribute_utils.h

@@ -105,10 +105,10 @@ struct AttributeConverter
 class AttributeMap : public std::unordered_map<std::string, OwnedAttributeValue>
 {
 public:
- // Contruct empty attribute map
+ // Construct empty attribute map
  AttributeMap() : std::unordered_map<std::string, OwnedAttributeValue>() {}
 
- // Contruct attribute map and populate with attributes
+ // Construct attribute map and populate with attributes
  AttributeMap(const opentelemetry::common::KeyValueIterable &attributes) : AttributeMap()
  {
  attributes.ForEachKeyValue(
@@ -118,6 +118,19 @@ class AttributeMap : public std::unordered_map<std::string, OwnedAttributeValue>
  });
  }
 
+ // Construct attribute map and populate with optional attributes
+ AttributeMap(const opentelemetry::common::KeyValueIterable *attributes) : AttributeMap()
+ {
+ if (attributes != nullptr)
+ {
+ attributes->ForEachKeyValue(
+ [&](nostd::string_view key, opentelemetry::common::AttributeValue value) noexcept {
+ SetAttribute(key, value);
+ return true;
+ });
+ }
+ }
+
  // Construct map from initializer list by applying `SetAttribute` transform for every attribute
  AttributeMap(
  std::initializer_list<std::pair<nostd::string_view, opentelemetry::common::AttributeValue>>

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

@@ -48,10 +48,18 @@ class MeterProvider final : public opentelemetry::metrics::MeterProvider
  */
  explicit MeterProvider(std::unique_ptr<MeterContext> context) noexcept;
 
+#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+ nostd::shared_ptr<opentelemetry::metrics::Meter> DoGetMeter(
+ nostd::string_view name,
+ nostd::string_view version,
+ nostd::string_view schema_url,
+ const opentelemetry::common::KeyValueIterable *attributes) noexcept override;
+#else
  nostd::shared_ptr<opentelemetry::metrics::Meter> GetMeter(
  nostd::string_view name,
  nostd::string_view version = "",
  nostd::string_view schema_url = "") noexcept override;
+#endif
 
 #ifdef ENABLE_REMOVE_METER_PREVIEW
  void RemoveMeter(nostd::string_view name,

sdk/src/metrics/meter_provider.cc

@@ -32,11 +32,23 @@ MeterProvider::MeterProvider(std::unique_ptr<ViewRegistry> views,
  OTEL_INTERNAL_LOG_DEBUG("[MeterProvider] MeterProvider created.");
 }
 
+#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+nostd::shared_ptr<metrics_api::Meter> MeterProvider::DoGetMeter(
+ nostd::string_view name,
+ nostd::string_view version,
+ nostd::string_view schema_url,
+ const opentelemetry::common::KeyValueIterable *attributes) noexcept
+#else
 nostd::shared_ptr<metrics_api::Meter> MeterProvider::GetMeter(
  nostd::string_view name,
  nostd::string_view version,
  nostd::string_view schema_url) noexcept
+#endif
 {
+#if OPENTELEMETRY_ABI_VERSION_NO < 2
+ const opentelemetry::common::KeyValueIterable *attributes = nullptr;
+#endif
+
  if (name.data() == nullptr || name == "")
  {
  OTEL_INTERNAL_LOG_WARN("[MeterProvider::GetMeter] Library name is empty.");
@@ -53,8 +65,12 @@ nostd::shared_ptr<metrics_api::Meter> MeterProvider::GetMeter(
  return nostd::shared_ptr<metrics_api::Meter>{meter};
  }
  }
- auto lib = instrumentationscope::InstrumentationScope::Create(name, version, schema_url);
- auto meter = std::shared_ptr<Meter>(new Meter(context_, std::move(lib)));
+
+ instrumentationscope::InstrumentationScopeAttributes attrs_map(attributes);
+ auto scope =
+ instrumentationscope::InstrumentationScope::Create(name, version, schema_url, attrs_map);
+
+ auto meter = std::shared_ptr<Meter>(new Meter(context_, std::move(scope)));
  context_->AddMeter(meter);
  return nostd::shared_ptr<metrics_api::Meter>{meter};
 }

sdk/test/metrics/meter_provider_sdk_test.cc

@@ -59,6 +59,70 @@ TEST(MeterProvider, GetMeter)
  mp1.Shutdown();
 }
 
+#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+TEST(MeterProvider, GetMeterAbiv2)
+{
+ MeterProvider mp;
+
+ auto m1 = mp.GetMeter("name1", "version1", "url1");
+
+ auto m2 = mp.GetMeter("name2", "version2", "url2", nullptr);
+
+ auto m3 = mp.GetMeter("name3", "version3", "url3", {{"accept_single_attr", true}});
+
+ std::pair<opentelemetry::nostd::string_view, opentelemetry::common::AttributeValue> attr4 = {
+ "accept_single_attr", true};
+
+ auto m4 = mp.GetMeter("name4", "version4", "url4", {attr4});
+
+ auto m5 = mp.GetMeter("name5", "version5", "url5", {{"foo", "1"}, {"bar", "2"}});
+
+ std::initializer_list<
+ std::pair<opentelemetry::nostd::string_view, opentelemetry::common::AttributeValue>>
+ attrs6 = {{"foo", "1"}, {"bar", "2"}};
+
+ auto m6 = mp.GetMeter("name6", "version6", "url6", attrs6);
+
+ typedef std::pair<opentelemetry::nostd::string_view, opentelemetry::common::AttributeValue> KV;
+
+ std::initializer_list<KV> attrs7 = {{"foo", "1"}, {"bar", "2"}};
+ auto m7 = mp.GetMeter("name7", "version7", "url7", attrs7);
+
+ auto m8 = mp.GetMeter("name8", "version8", "url8",
+ {{"a", "string"},
+ {"b", false},
+ {"c", 314159},
+ {"d", (unsigned int)314159},
+ {"e", (int32_t)-20},
+ {"f", (uint32_t)20},
+ {"g", (int64_t)-20},
+ {"h", (uint64_t)20},
+ {"i", 3.1},
+ {"j", "string"}});
+
+ std::map<std::string, opentelemetry::common::AttributeValue> attr9{
+ {"a", "string"}, {"b", false}, {"c", 314159}, {"d", (unsigned int)314159},
+ {"e", (int32_t)-20}, {"f", (uint32_t)20}, {"g", (int64_t)-20}, {"h", (uint64_t)20},
+ {"i", 3.1}, {"j", "string"}};
+
+ auto m9 = mp.GetMeter("name9", "version9", "url9", attr9);
+
+ ASSERT_NE(nullptr, m1);
+ ASSERT_NE(nullptr, m2);
+ ASSERT_NE(nullptr, m3);
+ ASSERT_NE(nullptr, m4);
+ ASSERT_NE(nullptr, m5);
+ ASSERT_NE(nullptr, m6);
+ ASSERT_NE(nullptr, m7);
+ ASSERT_NE(nullptr, m8);
+ ASSERT_NE(nullptr, m9);
+
+ // cleanup properly without crash
+ mp.ForceFlush();
+ mp.Shutdown();
+}
+#endif /* OPENTELEMETRY_ABI_VERSION_NO >= 2 */
+
 #ifdef ENABLE_REMOVE_METER_PREVIEW
 TEST(MeterProvider, RemoveMeter)
 {