Skip to content

Commit 38be4d9

Browse files
authored
Nit leftovers from previous PR (#2537)
1 parent 3042aa0 commit 38be4d9

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed

opentelemetry-sdk/CHANGELOG.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
- *Feature*: Add `ResourceBuilder` for an easy way to create new `Resource`s
1818
- *Breaking*: Remove `Resource::{new,empty,from_detectors,new_with_defaults,from_schema_url,merge,default}` from public api. To create Resources you should only use `Resource::builder()` or `Resource::builder_empty()`. See [#2322](https://github.com/open-telemetry/opentelemetry-rust/pull/2322) for a migration guide.
1919
Example Usage:
20+
2021
```rust
2122
// old
2223
Resource::default().with_attributes([
@@ -30,6 +31,7 @@
3031
.with_attribute(KeyValue::new("key", "value"))
3132
.build();
3233
```
34+
3335
- *Breaking* The LogExporter::export() method no longer requires a mutable reference to self.:
3436
Before:
3537
async fn export(&mut self, _batch: LogBatch<'_>) -> LogResult<()>
@@ -61,15 +63,18 @@
6163
1. *Default Implementation, requires no async runtime* (**Recommended**) The
6264
new default implementation does not require a runtime argument. Replace the
6365
builder method accordingly:
64-
- *Before:*
65-
```rust
66-
let reader = opentelemetry_sdk::metrics::PeriodicReader::builder(exporter, runtime::Tokio).build();
67-
```
68-
- *After:*
69-
```rust
70-
let reader = opentelemetry_sdk::metrics::PeriodicReader::builder(exporter).build();
66+
*Before:*
67+
68+
```rust
69+
let reader = opentelemetry_sdk::metrics::PeriodicReader::builder(exporter, runtime::Tokio).build();
7170
```
7271

72+
*After:*
73+
74+
```rust
75+
let reader = opentelemetry_sdk::metrics::PeriodicReader::builder(exporter).build();
76+
```
77+
7378
The new PeriodicReader can be used with OTLP Exporter, and supports
7479
following exporter features:
7580
- `grpc-tonic`: This requires `MeterProvider` to be created within a tokio
@@ -250,11 +255,11 @@ metadata, a feature introduced in version 0.1.40. [#2418](https://github.com/ope
250255
equal signs (`"="`). [#2120](https://github.com/open-telemetry/opentelemetry-rust/pull/2120)
251256

252257
- **Breaking** Introduced `experimental_async_runtime` feature for runtime-specific traits.
253-
- Runtime-specific features (`rt-tokio`, `rt-tokio-current-thread`, and `rt-async-std`)
258+
- Runtime-specific features (`rt-tokio`, `rt-tokio-current-thread`, and `rt-async-std`)
254259
now depend on the `experimental_async_runtime` feature.
255-
- For most users, no action is required. Enabling runtime features such as `rt-tokio`, `rt-tokio-current-thread`,
260+
- For most users, no action is required. Enabling runtime features such as `rt-tokio`, `rt-tokio-current-thread`,
256261
or `rt-async-std` will automatically enable the `experimental_async_runtime` feature.
257-
- If you're implementing a custom runtime, you must explicitly enable the experimental_async_runtime` feature in your
262+
- If you're implementing a custom runtime, you must explicitly enable the experimental_async_runtime` feature in your
258263
Cargo.toml and implement the required `Runtime` traits.
259264

260265
- Removed Metrics Cardinality Limit feature. This was originally introduced in
@@ -263,12 +268,11 @@ hardcoded limit of 2000 and no ability to change it. This feature will be
263268
re-introduced in a future date, along with the ability to change the cardinality
264269
limit.
265270

266-
- Refactor modules. This is *Breaking* change, if you author custom
267-
LogExporter,LogProcessor.
271+
- *Breaking (Affects custom LogExporter, LogProcessor authors only)*: Rename namespaces
268272
before:
269273
`opentelemetry_sdk::export::logs::{ExportResult, LogBatch, LogExporter};`
270274
now:
271-
`opentelemetry_sdk::logs::{ExportResult, LogBatch, LogExporter}`
275+
`opentelemetry_sdk::logs::{ExportResult, LogBatch, LogExporter};`
272276

273277
## 0.27.1
274278

@@ -278,6 +282,7 @@ Released 2024-Nov-27
278282
- `trace::Config` methods are moving onto `TracerProvider` Builder to be consistent with other signals. See https://github.com/open-telemetry/opentelemetry-rust/pull/2303 for migration guide.
279283
`trace::Config` is scheduled to be removed from public API in `v0.28.0`.
280284
example:
285+
281286
```rust
282287
// old
283288
let tracer_provider: TracerProvider = TracerProvider::builder()
@@ -289,6 +294,7 @@ Released 2024-Nov-27
289294
.with_resource(Resource::empty())
290295
.build();
291296
```
297+
292298
- `logs::LogData` struct is deprecated, and scheduled to be removed from public API in `v0.28.0`.
293299
- Bug fix: Empty Meter names are retained as-is instead of replacing with
294300
"rust.opentelemetry.io/sdk/meter"

opentelemetry-sdk/src/logs/log_emitter.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use super::{BatchLogProcessor, LogProcessor, LogRecord, SimpleLogProcessor, TraceContext};
2+
use crate::logs::{LogError, LogExporter, LogResult};
23
use crate::Resource;
3-
use crate::{logs::LogError, logs::LogExporter, logs::LogResult};
44
use opentelemetry::{otel_debug, otel_info, trace::TraceContextExt, Context, InstrumentationScope};
55

66
#[cfg(feature = "spec_unstable_logs_enabled")]

opentelemetry-sdk/src/logs/log_processor.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,8 @@ pub trait LogProcessor: Send + Sync + Debug {
120120
/// ### Using a SimpleLogProcessor
121121
///
122122
/// ```rust
123-
/// use opentelemetry_sdk::logs::{SimpleLogProcessor, LoggerProvider};
123+
/// use opentelemetry_sdk::logs::{SimpleLogProcessor, LoggerProvider, LogExporter};
124124
/// use opentelemetry::global;
125-
/// use opentelemetry_sdk::logs::LogExporter;
126125
/// use opentelemetry_sdk::testing::logs::InMemoryLogExporter;
127126
///
128127
/// let exporter = InMemoryLogExporter::default(); // Replace with an actual exporter

0 commit comments

Comments
 (0)