From ff18452596b27876b263add74fc85907bf117c56 Mon Sep 17 00:00:00 2001 From: David Pitoniak Date: Sat, 26 Oct 2024 10:35:28 -0400 Subject: [PATCH] chore: update CHANGELOG with breaking changes --- opentelemetry-otlp/CHANGELOG.md | 4 ++++ opentelemetry-sdk/CHANGELOG.md | 13 ++++++++++--- opentelemetry-stdout/CHANGELOG.md | 9 +++++++-- 3 files changed, 21 insertions(+), 5 deletions(-) diff --git a/opentelemetry-otlp/CHANGELOG.md b/opentelemetry-otlp/CHANGELOG.md index fd5b782993..fce91cbb61 100644 --- a/opentelemetry-otlp/CHANGELOG.md +++ b/opentelemetry-otlp/CHANGELOG.md @@ -48,6 +48,10 @@ Released 2024-Sep-30 .build()?, ).build(); ``` + - **Renamed** + - ([#2255](https://github.com/open-telemetry/opentelemetry-rust/pull/2255)): de-pluralize Metric types. + - `MetricsExporter` -> `MetricExporter` + - `MetricsExporterBuilder` -> `MetricExporterBuilder` ## v0.25.0 diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index 0841dc708c..32c2c5a9fb 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -5,10 +5,17 @@ - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) - Implement `LogRecord::set_trace_context` for `LogRecord`. Respect any trace context set on a `LogRecord` when emitting through a `Logger`. - Improved `LoggerProvider` shutdown handling to prevent redundant shutdown calls when `drop` is invoked. [#2195](https://github.com/open-telemetry/opentelemetry-rust/pull/2195) -- **BREAKING**: [#2217](https://github.com/open-telemetry/opentelemetry-rust/pull/2217) - - **Replaced**: Removed `{Delta,Cumulative}TemporalitySelector::new()` in favor of directly using `Temporality` enum to simplify the configuration of MetricsExporterBuilder with different temporalities. - When creating new metric instruments, SDK would return a no-op instrument if the validation fails. [#2166](https://github.com/open-telemetry/opentelemetry-rust/pull/2166) -- **Breaking change for Metrics users:** The `init` method used to create instruments has been renamed to `build`. +- **BREAKING for Metrics users**: + - **Replaced** + - ([#2217](https://github.com/open-telemetry/opentelemetry-rust/pull/2217)): Removed `{Delta,Cumulative}TemporalitySelector::new()` in favor of directly using `Temporality` enum to simplify the configuration of MetricsExporterBuilder with different temporalities. + - **Renamed** + - ([#2232](https://github.com/open-telemetry/opentelemetry-rust/pull/2232)) + - The `init` method used to create instruments has been renamed to `build`. + - ([#]()): de-pluralize Metric types. + - `PushMetricsExporter` -> `PushMetricExporter` + - `InMemoryMetricsExporter` -> `InMemoryMetricExporter` + - `InMemoryMetricsExporterBuilder` -> `InMemoryMetricExporterBuilder` Before: ```rust diff --git a/opentelemetry-stdout/CHANGELOG.md b/opentelemetry-stdout/CHANGELOG.md index 1277024718..0305afac9b 100644 --- a/opentelemetry-stdout/CHANGELOG.md +++ b/opentelemetry-stdout/CHANGELOG.md @@ -3,8 +3,9 @@ ## vNext - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) -- **BREAKING**: [#2217](https://github.com/open-telemetry/opentelemetry-rust/pull/2217) - - **Replaced**: The `MetricsExporterBuilder` interface is modified from `with_temporality_selector` to `with_temporality` example can be seen below: +- **BREAKING** + - **Replaced** + - ([#2217](https://github.com/open-telemetry/opentelemetry-rust/pull/2217)): The `MetricsExporterBuilder` interface is modified from `with_temporality_selector` to `with_temporality` example can be seen below: Previous Signature: ```rust MetricsExporterBuilder::default().with_temporality_selector(DeltaTemporalitySelector::new()) @@ -13,6 +14,10 @@ ```rust MetricsExporterBuilder::default().with_temporality(Temporality::Delta) ``` + - **Renamed** + - ([#2255](https://github.com/open-telemetry/opentelemetry-rust/pull/2255)): de-pluralize Metric types. + - `MetricsExporter` -> `MetricExporter` + - `MetricsExporterBuilder` -> `MetricExporterBuilder` ## v0.26.0 Released 2024-Sep-30