From 1ac42b6d7ca48802212181c207dc2109570d7b5c Mon Sep 17 00:00:00 2001 From: Marc Alff Date: Tue, 26 Sep 2023 14:47:32 +0200 Subject: [PATCH] Cleanup, changelog. --- CHANGELOG.md | 12 ++++++++++++ api/include/opentelemetry/metrics/meter_provider.h | 13 ++++++------- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 38a077e7d8..713e99ec5c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,18 @@ Increment the: [#2324](https://github.com/open-telemetry/opentelemetry-cpp/pull/2324) * [EXPORTER] Handle attribute key collisions caused by sanitation [#2324](https://github.com/open-telemetry/opentelemetry-cpp/pull/2326) +* [API] Add InstrumentationScope attributes in MeterProvider::GetMeter() + [#2224](https://github.com/open-telemetry/opentelemetry-cpp/pull/2224) + +Important changes: + +* [API] Add InstrumentationScope attributes in MeterProvider::GetMeter() + [#2224](https://github.com/open-telemetry/opentelemetry-cpp/pull/2224) + * MeterProvider::GetMeter() now accepts InstrumentationScope attributes. + * Because this is an `ABI` breaking change, the fix is only available + with the `CMake` option `WITH_ABI_VERSION_2=ON`. + * When building with `CMake` option `WITH_ABI_VERSION_1=ON` (by default) + the `ABI` is unchanged, and the fix is not available. ## [1.11.0] 2023-08-21 diff --git a/api/include/opentelemetry/metrics/meter_provider.h b/api/include/opentelemetry/metrics/meter_provider.h index 9612604ad1..152e543d36 100644 --- a/api/include/opentelemetry/metrics/meter_provider.h +++ b/api/include/opentelemetry/metrics/meter_provider.h @@ -32,9 +32,9 @@ class MeterProvider * @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 + * @param[in] version Instrumentation scope version + * @param[in] schema_url Instrumentation scope schema URL + * @param[in] attributes Instrumentation scope attributes (optional, may be nullptr) */ virtual nostd::shared_ptr GetMeter( nostd::string_view name, @@ -48,9 +48,8 @@ class MeterProvider * @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 + * @param[in] version Instrumentation scope version, optional + * @param[in] schema_url Instrumentation scope schema URL, optional */ nostd::shared_ptr GetMeter(nostd::string_view name, nostd::string_view version = "", @@ -96,7 +95,7 @@ class MeterProvider * @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 + * @param[in] attributes Instrumentation scope attributes container */ template ::value> * = nullptr>