From 4cf56db3473f8314aba86cc05817aaafde7a93fc Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Fri, 8 Nov 2024 15:18:32 -0800 Subject: [PATCH 1/6] update flag --- CONTRIBUTING.md | 2 +- opentelemetry-appender-log/Cargo.toml | 4 ++-- opentelemetry-appender-log/src/lib.rs | 10 +++++----- opentelemetry-appender-tracing/Cargo.toml | 4 ++-- opentelemetry-appender-tracing/src/layer.rs | 2 +- opentelemetry-sdk/Cargo.toml | 2 +- opentelemetry-sdk/src/export/logs/mod.rs | 4 ++-- opentelemetry-sdk/src/lib.rs | 2 +- opentelemetry-sdk/src/logs/log_emitter.rs | 4 ++-- opentelemetry-sdk/src/logs/log_processor.rs | 4 ++-- opentelemetry-stdout/Cargo.toml | 2 +- opentelemetry/Cargo.toml | 4 ++-- opentelemetry/src/lib.rs | 2 +- opentelemetry/src/logs/logger.rs | 4 ++-- opentelemetry/src/logs/noop.rs | 2 +- scripts/lint.sh | 2 +- stress/Cargo.toml | 4 ++-- 17 files changed, 29 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb6a38ca80..ae81dc5017 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -169,7 +169,7 @@ It's important to regularly review and remove the `otel_unstable` flag from the The potential features include: - Stable and non-experimental features that compliant to specification, and have a feature flag to minimize compilation size. Example: feature flags for signals (like `logs`, `traces`, `metrics`) and runtimes (`rt-tokio`, `rt-tokio-current-thread`, `rt-async-std`). -- Stable and non-experimental features, although not part of the specification, are crucial for enhancing the tracing/log crate's functionality or boosting performance. These features are also subject to discussion and approval by the OpenTelemetry Rust Maintainers. An example of such a feature is `logs_level_enabled`. +- Stable and non-experimental features, although not part of the specification, are crucial for enhancing the tracing/log crate's functionality or boosting performance. These features are also subject to discussion and approval by the OpenTelemetry Rust Maintainers. All such features should adhere to naming convention `_` diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml index cf7db1f483..202b40c3b6 100644 --- a/opentelemetry-appender-log/Cargo.toml +++ b/opentelemetry-appender-log/Cargo.toml @@ -21,14 +21,14 @@ opentelemetry-semantic-conventions = { path = "../opentelemetry-semantic-convent ] } [features] -logs_level_enabled = ["opentelemetry/logs_level_enabled"] +experimental_logs_level_enabled = ["opentelemetry/experimental_logs_level_enabled"] with-serde = ["log/kv_serde", "serde"] experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"] [dev-dependencies] opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [ "testing", - "logs_level_enabled", + "experimental_logs_level_enabled", ] } opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] } log = { workspace = true, features = ["kv_serde"] } diff --git a/opentelemetry-appender-log/src/lib.rs b/opentelemetry-appender-log/src/lib.rs index 5f562ede30..055974f798 100644 --- a/opentelemetry-appender-log/src/lib.rs +++ b/opentelemetry-appender-log/src/lib.rs @@ -89,7 +89,7 @@ //! //! This library provides the following Cargo features: //! -//! - `logs_level_enabled`: Allow users to control the log level. +//! - `experimental_logs_level_enabled`: Allow users to control the log level. //! - `with-serde`: Support complex values as attributes without stringifying them. //! //! [Logs Bridge API]: https://opentelemetry.io/docs/specs/otel/logs/bridge-api/ @@ -117,11 +117,11 @@ where L: Logger + Send + Sync, { fn enabled(&self, _metadata: &Metadata) -> bool { - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] return self .logger .event_enabled(severity_of_level(_metadata.level()), _metadata.target()); - #[cfg(not(feature = "logs_level_enabled"))] + #[cfg(not(feature = "experimental_logs_level_enabled"))] true } @@ -770,9 +770,9 @@ mod tests { // As a result of using `with_simple_exporter` while building the logger provider, // the processor used is a `SimpleLogProcessor` which has an implementation of `event_enabled` // that always returns true. - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); - #[cfg(not(feature = "logs_level_enabled"))] + #[cfg(not(feature = "experimental_logs_level_enabled"))] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); } diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml index 38e2cb21d9..4a25f5bcb0 100644 --- a/opentelemetry-appender-tracing/Cargo.toml +++ b/opentelemetry-appender-tracing/Cargo.toml @@ -33,10 +33,10 @@ pprof = { version = "0.13", features = ["flamegraph", "criterion"] } [features] experimental_metadata_attributes = ["dep:tracing-log"] -logs_level_enabled = ["opentelemetry/logs_level_enabled"] +logs_level_enabled = ["opentelemetry/experimental_logs_level_enabled"] [[bench]] name = "logs" harness = false -required-features = ["logs_level_enabled"] +required-features = ["experimental_logs_level_enabled"] diff --git a/opentelemetry-appender-tracing/src/layer.rs b/opentelemetry-appender-tracing/src/layer.rs index bbd897c8d1..b8e6ca4b5e 100644 --- a/opentelemetry-appender-tracing/src/layer.rs +++ b/opentelemetry-appender-tracing/src/layer.rs @@ -184,7 +184,7 @@ where self.logger.emit(log_record); } - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] fn event_enabled( &self, _event: &tracing_core::Event<'_>, diff --git a/opentelemetry-sdk/Cargo.toml b/opentelemetry-sdk/Cargo.toml index 1be4142432..e99f4611ee 100644 --- a/opentelemetry-sdk/Cargo.toml +++ b/opentelemetry-sdk/Cargo.toml @@ -46,7 +46,7 @@ default = ["trace", "metrics", "logs", "internal-logs"] trace = ["opentelemetry/trace", "rand", "async-trait", "percent-encoding"] jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url"] logs = ["opentelemetry/logs", "async-trait", "serde_json"] -logs_level_enabled = ["logs", "opentelemetry/logs_level_enabled"] +experimental_logs_level_enabled = ["logs", "opentelemetry/experimental_logs_level_enabled"] metrics = ["opentelemetry/metrics", "glob", "async-trait"] testing = ["opentelemetry/testing", "trace", "metrics", "logs", "rt-async-std", "rt-tokio", "rt-tokio-current-thread", "tokio/macros", "tokio/rt-multi-thread"] rt-tokio = ["tokio", "tokio-stream"] diff --git a/opentelemetry-sdk/src/export/logs/mod.rs b/opentelemetry-sdk/src/export/logs/mod.rs index 098c6b8427..50fbe1c5da 100644 --- a/opentelemetry-sdk/src/export/logs/mod.rs +++ b/opentelemetry-sdk/src/export/logs/mod.rs @@ -3,7 +3,7 @@ use crate::logs::LogRecord; use crate::logs::{LogError, LogResult}; use crate::Resource; use async_trait::async_trait; -#[cfg(feature = "logs_level_enabled")] +#[cfg(feature = "experimental_logs_level_enabled")] use opentelemetry::logs::Severity; use opentelemetry::InstrumentationScope; use std::fmt::Debug; @@ -85,7 +85,7 @@ pub trait LogExporter: Send + Sync + Debug { async fn export(&mut self, batch: LogBatch<'_>) -> LogResult<()>; /// Shuts down the exporter. fn shutdown(&mut self) {} - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] /// Chek if logs are enabled. fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-sdk/src/lib.rs b/opentelemetry-sdk/src/lib.rs index 6f351c2459..53494fab6b 100644 --- a/opentelemetry-sdk/src/lib.rs +++ b/opentelemetry-sdk/src/lib.rs @@ -89,7 +89,7 @@ //! //! For `logs` the following feature flags are available: //! -//! * `logs_level_enabled`: control the log level +//! * `experimental_logs_level_enabled`: control the log level //! //! Support for recording and exporting telemetry asynchronously and perform //! metrics aggregation can be added via the following flags: diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 600e02c49e..ae7d281c5c 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -3,7 +3,7 @@ use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource}; use crate::{logs::LogError, logs::LogResult}; use opentelemetry::{otel_debug, trace::TraceContextExt, Context, InstrumentationScope}; -#[cfg(feature = "logs_level_enabled")] +#[cfg(feature = "experimental_logs_level_enabled")] use opentelemetry::logs::Severity; use std::time::SystemTime; @@ -282,7 +282,7 @@ impl opentelemetry::logs::Logger for Logger { } } - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] fn event_enabled(&self, level: Severity, target: &str) -> bool { let provider = self.provider(); diff --git a/opentelemetry-sdk/src/logs/log_processor.rs b/opentelemetry-sdk/src/logs/log_processor.rs index 258c23c811..4e5758abdd 100644 --- a/opentelemetry-sdk/src/logs/log_processor.rs +++ b/opentelemetry-sdk/src/logs/log_processor.rs @@ -9,7 +9,7 @@ use futures_util::{ future::{self, Either}, {pin_mut, stream, StreamExt as _}, }; -#[cfg(feature = "logs_level_enabled")] +#[cfg(feature = "experimental_logs_level_enabled")] use opentelemetry::logs::Severity; use opentelemetry::{otel_debug, otel_error, otel_warn, InstrumentationScope}; @@ -61,7 +61,7 @@ pub trait LogProcessor: Send + Sync + Debug { /// After shutdown returns the log processor should stop processing any logs. /// It's up to the implementation on when to drop the LogProcessor. fn shutdown(&self) -> LogResult<()>; - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] /// Check if logging is enabled fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-stdout/Cargo.toml b/opentelemetry-stdout/Cargo.toml index fd155da0f5..4e201e2a03 100644 --- a/opentelemetry-stdout/Cargo.toml +++ b/opentelemetry-stdout/Cargo.toml @@ -23,7 +23,7 @@ rustdoc-args = ["--cfg", "docsrs"] default = ["trace", "metrics", "logs"] trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "futures-util"] metrics = ["async-trait", "opentelemetry/metrics", "opentelemetry_sdk/metrics"] -logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/logs_level_enabled"] +logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/experimental_logs_level_enabled"] populate-logs-event-name = [] [dependencies] diff --git a/opentelemetry/Cargo.toml b/opentelemetry/Cargo.toml index 0a4ef72242..a4bb8bb18e 100644 --- a/opentelemetry/Cargo.toml +++ b/opentelemetry/Cargo.toml @@ -37,12 +37,12 @@ trace = ["pin-project-lite"] metrics = [] testing = ["trace", "metrics"] logs = [] -logs_level_enabled = ["logs"] +experimental_logs_level_enabled = ["logs"] otel_unstable = [] internal-logs = ["tracing"] [dev-dependencies] -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["logs_level_enabled"]} # for documentation tests +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["experimental_logs_level_enabled"]} # for documentation tests criterion = { workspace = true } rand = { workspace = true } diff --git a/opentelemetry/src/lib.rs b/opentelemetry/src/lib.rs index f760aa1017..75d8c8b177 100644 --- a/opentelemetry/src/lib.rs +++ b/opentelemetry/src/lib.rs @@ -114,7 +114,7 @@ //! The default feature flags are ["trace", "metrics", "logs"] //! //! The following feature flags provides additional configuration for `logs`: -//! * `logs_level_enabled`: Allow users to control the log level +//! * `experimental_logs_level_enabled`: Allow users to control the log level //! //! The following feature flags enable APIs defined in OpenTelemetry specification that is in experimental phase: //! * `otel_unstable`: Includes unstable APIs. diff --git a/opentelemetry/src/logs/logger.rs b/opentelemetry/src/logs/logger.rs index 4f87f01731..c4949cdd8b 100644 --- a/opentelemetry/src/logs/logger.rs +++ b/opentelemetry/src/logs/logger.rs @@ -2,7 +2,7 @@ use std::borrow::Cow; use crate::{logs::LogRecord, InstrumentationScope}; -#[cfg(feature = "logs_level_enabled")] +#[cfg(feature = "experimental_logs_level_enabled")] use super::Severity; /// The interface for emitting [`LogRecord`]s. @@ -20,7 +20,7 @@ pub trait Logger { /// [`Context`]: crate::Context fn emit(&self, record: Self::LogRecord); - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] /// Check if the given log level is enabled. fn event_enabled(&self, level: Severity, target: &str) -> bool; } diff --git a/opentelemetry/src/logs/noop.rs b/opentelemetry/src/logs/noop.rs index ce94a379a3..1c6133aa03 100644 --- a/opentelemetry/src/logs/noop.rs +++ b/opentelemetry/src/logs/noop.rs @@ -78,7 +78,7 @@ impl Logger for NoopLogger { NoopLogRecord {} } fn emit(&self, _record: Self::LogRecord) {} - #[cfg(feature = "logs_level_enabled")] + #[cfg(feature = "experimental_logs_level_enabled")] fn event_enabled(&self, _level: super::Severity, _target: &str) -> bool { false } diff --git a/scripts/lint.sh b/scripts/lint.sh index 86bd383cc0..c73653fc33 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -28,7 +28,7 @@ if rustup component add clippy; then -Dwarnings done - cargo_feature opentelemetry "trace,metrics,logs,logs_level_enabled,testing" + cargo_feature opentelemetry "trace,metrics,logs,experimental_logs_level_enabled,testing" cargo_feature opentelemetry-otlp "default" cargo_feature opentelemetry-otlp "default,tls" diff --git a/stress/Cargo.toml b/stress/Cargo.toml index 0591cde7eb..993ffb01e0 100644 --- a/stress/Cargo.toml +++ b/stress/Cargo.toml @@ -43,8 +43,8 @@ doc = false ctrlc = "3.2.5" lazy_static = "1.4.0" num_cpus = "1.15.0" -opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "logs_level_enabled"] } -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "logs_level_enabled"] } +opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "experimental_logs_level_enabled"] } +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "experimental_logs_level_enabled"] } opentelemetry-appender-tracing = { path = "../opentelemetry-appender-tracing"} rand = { version = "0.8.4", features = ["small_rng"] } tracing = { workspace = true, features = ["std"]} From b62fd579d36ba8db7c16d3412ca680a4442ef69e Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Fri, 8 Nov 2024 15:28:04 -0800 Subject: [PATCH 2/6] update changelog --- opentelemetry-appender-log/CHANGELOG.md | 1 + opentelemetry-appender-tracing/CHANGELOG.md | 1 + opentelemetry-appender-tracing/Cargo.toml | 2 +- opentelemetry-sdk/CHANGELOG.md | 2 ++ opentelemetry/CHANGELOG.md | 2 ++ 5 files changed, 7 insertions(+), 1 deletion(-) diff --git a/opentelemetry-appender-log/CHANGELOG.md b/opentelemetry-appender-log/CHANGELOG.md index cb612f3dd7..8034862c42 100644 --- a/opentelemetry-appender-log/CHANGELOG.md +++ b/opentelemetry-appender-log/CHANGELOG.md @@ -4,6 +4,7 @@ - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) - [2193](https://github.com/open-telemetry/opentelemetry-rust/pull/2193) `opentelemetry-appender-log`: Output experimental code attributes +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-tracing/CHANGELOG.md b/opentelemetry-appender-tracing/CHANGELOG.md index 8684d8b69a..2cadc18382 100644 --- a/opentelemetry-appender-tracing/CHANGELOG.md +++ b/opentelemetry-appender-tracing/CHANGELOG.md @@ -3,6 +3,7 @@ ## vNext - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml index 4a25f5bcb0..2ad6964320 100644 --- a/opentelemetry-appender-tracing/Cargo.toml +++ b/opentelemetry-appender-tracing/Cargo.toml @@ -33,7 +33,7 @@ pprof = { version = "0.13", features = ["flamegraph", "criterion"] } [features] experimental_metadata_attributes = ["dep:tracing-log"] -logs_level_enabled = ["opentelemetry/experimental_logs_level_enabled"] +experimental_logs_level_enabled = ["opentelemetry/experimental_logs_level_enabled"] [[bench]] diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index af0e6e64cb..374d4c4a07 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -45,6 +45,8 @@ - Users calling public APIs that return these constructs (e.g, LoggerProvider::shutdown(), MeterProvider::force_flush()) should now import them from the SDK instead of the API. - Developers creating custom exporters should ensure they import these constructs from the SDK, not the API. + - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. + ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry/CHANGELOG.md b/opentelemetry/CHANGELOG.md index e6adb7a5d4..9a941655c2 100644 --- a/opentelemetry/CHANGELOG.md +++ b/opentelemetry/CHANGELOG.md @@ -47,6 +47,8 @@ let counter = meter.u64_counter("my_counter").build(); - Moved `MetricError` enum from `opentelemetry::metrics::MetricError` to `opentelemetry_sdk::metrics::MetricError` - Moved `MetricResult` type alias from `opentelemetry::metrics::MetricResult` to `opentelemetry_sdk::metrics::MetricResult` These changes shouldn't directly affect the users of OpenTelemetry crate, as these constructs are used in SDK and Exporters. If you are an author of an sdk component/plug-in, like an exporter etc. please use these types from sdk. Refer [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-sdk/CHANGELOG.md) for more details, under same version section. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. + ## v0.26.0 Released 2024-Sep-30 From 3d5670bf42a3e63e756ab36512c79e986a4d5fdd Mon Sep 17 00:00:00 2001 From: Lalit Date: Fri, 8 Nov 2024 17:36:45 -0800 Subject: [PATCH 3/6] rename to unstable_logs_level_enabled --- opentelemetry-appender-log/CHANGELOG.md | 2 +- opentelemetry-appender-log/Cargo.toml | 4 ++-- opentelemetry-appender-log/src/lib.rs | 10 +++++----- opentelemetry-appender-tracing/CHANGELOG.md | 2 +- opentelemetry-appender-tracing/Cargo.toml | 4 ++-- opentelemetry-appender-tracing/src/layer.rs | 2 +- opentelemetry-sdk/CHANGELOG.md | 2 +- opentelemetry-sdk/Cargo.toml | 2 +- opentelemetry-sdk/src/export/logs/mod.rs | 4 ++-- opentelemetry-sdk/src/lib.rs | 2 +- opentelemetry-sdk/src/logs/log_emitter.rs | 4 ++-- opentelemetry-sdk/src/logs/log_processor.rs | 4 ++-- opentelemetry-stdout/Cargo.toml | 2 +- opentelemetry/CHANGELOG.md | 2 +- opentelemetry/Cargo.toml | 4 ++-- opentelemetry/src/lib.rs | 2 +- opentelemetry/src/logs/logger.rs | 4 ++-- opentelemetry/src/logs/noop.rs | 2 +- scripts/lint.sh | 2 +- stress/Cargo.toml | 4 ++-- 20 files changed, 32 insertions(+), 32 deletions(-) diff --git a/opentelemetry-appender-log/CHANGELOG.md b/opentelemetry-appender-log/CHANGELOG.md index 8034862c42..17d0b61248 100644 --- a/opentelemetry-appender-log/CHANGELOG.md +++ b/opentelemetry-appender-log/CHANGELOG.md @@ -4,7 +4,7 @@ - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) - [2193](https://github.com/open-telemetry/opentelemetry-rust/pull/2193) `opentelemetry-appender-log`: Output experimental code attributes -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml index 202b40c3b6..b8779f7d2d 100644 --- a/opentelemetry-appender-log/Cargo.toml +++ b/opentelemetry-appender-log/Cargo.toml @@ -21,14 +21,14 @@ opentelemetry-semantic-conventions = { path = "../opentelemetry-semantic-convent ] } [features] -experimental_logs_level_enabled = ["opentelemetry/experimental_logs_level_enabled"] +unstable_logs_level_enabled = ["opentelemetry/unstable_logs_level_enabled"] with-serde = ["log/kv_serde", "serde"] experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"] [dev-dependencies] opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [ "testing", - "experimental_logs_level_enabled", + "unstable_logs_level_enabled", ] } opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] } log = { workspace = true, features = ["kv_serde"] } diff --git a/opentelemetry-appender-log/src/lib.rs b/opentelemetry-appender-log/src/lib.rs index 055974f798..a87626a05a 100644 --- a/opentelemetry-appender-log/src/lib.rs +++ b/opentelemetry-appender-log/src/lib.rs @@ -89,7 +89,7 @@ //! //! This library provides the following Cargo features: //! -//! - `experimental_logs_level_enabled`: Allow users to control the log level. +//! - `unstable_logs_level_enabled`: Allow users to control the log level. //! - `with-serde`: Support complex values as attributes without stringifying them. //! //! [Logs Bridge API]: https://opentelemetry.io/docs/specs/otel/logs/bridge-api/ @@ -117,11 +117,11 @@ where L: Logger + Send + Sync, { fn enabled(&self, _metadata: &Metadata) -> bool { - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] return self .logger .event_enabled(severity_of_level(_metadata.level()), _metadata.target()); - #[cfg(not(feature = "experimental_logs_level_enabled"))] + #[cfg(not(feature = "unstable_logs_level_enabled"))] true } @@ -770,9 +770,9 @@ mod tests { // As a result of using `with_simple_exporter` while building the logger provider, // the processor used is a `SimpleLogProcessor` which has an implementation of `event_enabled` // that always returns true. - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); - #[cfg(not(feature = "experimental_logs_level_enabled"))] + #[cfg(not(feature = "unstable_logs_level_enabled"))] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); } diff --git a/opentelemetry-appender-tracing/CHANGELOG.md b/opentelemetry-appender-tracing/CHANGELOG.md index 2cadc18382..6a46505ac6 100644 --- a/opentelemetry-appender-tracing/CHANGELOG.md +++ b/opentelemetry-appender-tracing/CHANGELOG.md @@ -3,7 +3,7 @@ ## vNext - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml index 2ad6964320..5e321accab 100644 --- a/opentelemetry-appender-tracing/Cargo.toml +++ b/opentelemetry-appender-tracing/Cargo.toml @@ -33,10 +33,10 @@ pprof = { version = "0.13", features = ["flamegraph", "criterion"] } [features] experimental_metadata_attributes = ["dep:tracing-log"] -experimental_logs_level_enabled = ["opentelemetry/experimental_logs_level_enabled"] +unstable_logs_level_enabled = ["opentelemetry/unstable_logs_level_enabled"] [[bench]] name = "logs" harness = false -required-features = ["experimental_logs_level_enabled"] +required-features = ["unstable_logs_level_enabled"] diff --git a/opentelemetry-appender-tracing/src/layer.rs b/opentelemetry-appender-tracing/src/layer.rs index b8e6ca4b5e..686fab766f 100644 --- a/opentelemetry-appender-tracing/src/layer.rs +++ b/opentelemetry-appender-tracing/src/layer.rs @@ -184,7 +184,7 @@ where self.logger.emit(log_record); } - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] fn event_enabled( &self, _event: &tracing_core::Event<'_>, diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index 0ed946b952..52b8f30d53 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -45,7 +45,7 @@ - Users calling public APIs that return these constructs (e.g, LoggerProvider::shutdown(), MeterProvider::force_flush()) should now import them from the SDK instead of the API. - Developers creating custom exporters should ensure they import these constructs from the SDK, not the API. - - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. + - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. - **BREAKING**: `Temporality` enum moved from `opentelemetry_sdk::metrics::data::Temporality` to `opentelemetry_sdk::metrics::Temporality`. diff --git a/opentelemetry-sdk/Cargo.toml b/opentelemetry-sdk/Cargo.toml index e99f4611ee..6736affb59 100644 --- a/opentelemetry-sdk/Cargo.toml +++ b/opentelemetry-sdk/Cargo.toml @@ -46,7 +46,7 @@ default = ["trace", "metrics", "logs", "internal-logs"] trace = ["opentelemetry/trace", "rand", "async-trait", "percent-encoding"] jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url"] logs = ["opentelemetry/logs", "async-trait", "serde_json"] -experimental_logs_level_enabled = ["logs", "opentelemetry/experimental_logs_level_enabled"] +unstable_logs_level_enabled = ["logs", "opentelemetry/unstable_logs_level_enabled"] metrics = ["opentelemetry/metrics", "glob", "async-trait"] testing = ["opentelemetry/testing", "trace", "metrics", "logs", "rt-async-std", "rt-tokio", "rt-tokio-current-thread", "tokio/macros", "tokio/rt-multi-thread"] rt-tokio = ["tokio", "tokio-stream"] diff --git a/opentelemetry-sdk/src/export/logs/mod.rs b/opentelemetry-sdk/src/export/logs/mod.rs index 50fbe1c5da..02ce4053a4 100644 --- a/opentelemetry-sdk/src/export/logs/mod.rs +++ b/opentelemetry-sdk/src/export/logs/mod.rs @@ -3,7 +3,7 @@ use crate::logs::LogRecord; use crate::logs::{LogError, LogResult}; use crate::Resource; use async_trait::async_trait; -#[cfg(feature = "experimental_logs_level_enabled")] +#[cfg(feature = "unstable_logs_level_enabled")] use opentelemetry::logs::Severity; use opentelemetry::InstrumentationScope; use std::fmt::Debug; @@ -85,7 +85,7 @@ pub trait LogExporter: Send + Sync + Debug { async fn export(&mut self, batch: LogBatch<'_>) -> LogResult<()>; /// Shuts down the exporter. fn shutdown(&mut self) {} - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] /// Chek if logs are enabled. fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-sdk/src/lib.rs b/opentelemetry-sdk/src/lib.rs index 53494fab6b..7f3d774d6b 100644 --- a/opentelemetry-sdk/src/lib.rs +++ b/opentelemetry-sdk/src/lib.rs @@ -89,7 +89,7 @@ //! //! For `logs` the following feature flags are available: //! -//! * `experimental_logs_level_enabled`: control the log level +//! * `unstable_logs_level_enabled`: control the log level //! //! Support for recording and exporting telemetry asynchronously and perform //! metrics aggregation can be added via the following flags: diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index ae7d281c5c..1b79f5fd8b 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -3,7 +3,7 @@ use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource}; use crate::{logs::LogError, logs::LogResult}; use opentelemetry::{otel_debug, trace::TraceContextExt, Context, InstrumentationScope}; -#[cfg(feature = "experimental_logs_level_enabled")] +#[cfg(feature = "unstable_logs_level_enabled")] use opentelemetry::logs::Severity; use std::time::SystemTime; @@ -282,7 +282,7 @@ impl opentelemetry::logs::Logger for Logger { } } - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] fn event_enabled(&self, level: Severity, target: &str) -> bool { let provider = self.provider(); diff --git a/opentelemetry-sdk/src/logs/log_processor.rs b/opentelemetry-sdk/src/logs/log_processor.rs index 4e5758abdd..4e769cb2ec 100644 --- a/opentelemetry-sdk/src/logs/log_processor.rs +++ b/opentelemetry-sdk/src/logs/log_processor.rs @@ -9,7 +9,7 @@ use futures_util::{ future::{self, Either}, {pin_mut, stream, StreamExt as _}, }; -#[cfg(feature = "experimental_logs_level_enabled")] +#[cfg(feature = "unstable_logs_level_enabled")] use opentelemetry::logs::Severity; use opentelemetry::{otel_debug, otel_error, otel_warn, InstrumentationScope}; @@ -61,7 +61,7 @@ pub trait LogProcessor: Send + Sync + Debug { /// After shutdown returns the log processor should stop processing any logs. /// It's up to the implementation on when to drop the LogProcessor. fn shutdown(&self) -> LogResult<()>; - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] /// Check if logging is enabled fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-stdout/Cargo.toml b/opentelemetry-stdout/Cargo.toml index 4e201e2a03..bc362da9a4 100644 --- a/opentelemetry-stdout/Cargo.toml +++ b/opentelemetry-stdout/Cargo.toml @@ -23,7 +23,7 @@ rustdoc-args = ["--cfg", "docsrs"] default = ["trace", "metrics", "logs"] trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "futures-util"] metrics = ["async-trait", "opentelemetry/metrics", "opentelemetry_sdk/metrics"] -logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/experimental_logs_level_enabled"] +logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/unstable_logs_level_enabled"] populate-logs-event-name = [] [dependencies] diff --git a/opentelemetry/CHANGELOG.md b/opentelemetry/CHANGELOG.md index 9a941655c2..63f024125f 100644 --- a/opentelemetry/CHANGELOG.md +++ b/opentelemetry/CHANGELOG.md @@ -47,7 +47,7 @@ let counter = meter.u64_counter("my_counter").build(); - Moved `MetricError` enum from `opentelemetry::metrics::MetricError` to `opentelemetry_sdk::metrics::MetricError` - Moved `MetricResult` type alias from `opentelemetry::metrics::MetricResult` to `opentelemetry_sdk::metrics::MetricResult` These changes shouldn't directly affect the users of OpenTelemetry crate, as these constructs are used in SDK and Exporters. If you are an author of an sdk component/plug-in, like an exporter etc. please use these types from sdk. Refer [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-sdk/CHANGELOG.md) for more details, under same version section. -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `experimental_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 diff --git a/opentelemetry/Cargo.toml b/opentelemetry/Cargo.toml index a4bb8bb18e..273142300f 100644 --- a/opentelemetry/Cargo.toml +++ b/opentelemetry/Cargo.toml @@ -37,12 +37,12 @@ trace = ["pin-project-lite"] metrics = [] testing = ["trace", "metrics"] logs = [] -experimental_logs_level_enabled = ["logs"] +unstable_logs_level_enabled = ["logs"] otel_unstable = [] internal-logs = ["tracing"] [dev-dependencies] -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["experimental_logs_level_enabled"]} # for documentation tests +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["unstable_logs_level_enabled"]} # for documentation tests criterion = { workspace = true } rand = { workspace = true } diff --git a/opentelemetry/src/lib.rs b/opentelemetry/src/lib.rs index 75d8c8b177..e3a6040e4b 100644 --- a/opentelemetry/src/lib.rs +++ b/opentelemetry/src/lib.rs @@ -114,7 +114,7 @@ //! The default feature flags are ["trace", "metrics", "logs"] //! //! The following feature flags provides additional configuration for `logs`: -//! * `experimental_logs_level_enabled`: Allow users to control the log level +//! * `unstable_logs_level_enabled`: Allow users to control the log level //! //! The following feature flags enable APIs defined in OpenTelemetry specification that is in experimental phase: //! * `otel_unstable`: Includes unstable APIs. diff --git a/opentelemetry/src/logs/logger.rs b/opentelemetry/src/logs/logger.rs index c4949cdd8b..084aec37ea 100644 --- a/opentelemetry/src/logs/logger.rs +++ b/opentelemetry/src/logs/logger.rs @@ -2,7 +2,7 @@ use std::borrow::Cow; use crate::{logs::LogRecord, InstrumentationScope}; -#[cfg(feature = "experimental_logs_level_enabled")] +#[cfg(feature = "unstable_logs_level_enabled")] use super::Severity; /// The interface for emitting [`LogRecord`]s. @@ -20,7 +20,7 @@ pub trait Logger { /// [`Context`]: crate::Context fn emit(&self, record: Self::LogRecord); - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] /// Check if the given log level is enabled. fn event_enabled(&self, level: Severity, target: &str) -> bool; } diff --git a/opentelemetry/src/logs/noop.rs b/opentelemetry/src/logs/noop.rs index 1c6133aa03..c5ba2b7642 100644 --- a/opentelemetry/src/logs/noop.rs +++ b/opentelemetry/src/logs/noop.rs @@ -78,7 +78,7 @@ impl Logger for NoopLogger { NoopLogRecord {} } fn emit(&self, _record: Self::LogRecord) {} - #[cfg(feature = "experimental_logs_level_enabled")] + #[cfg(feature = "unstable_logs_level_enabled")] fn event_enabled(&self, _level: super::Severity, _target: &str) -> bool { false } diff --git a/scripts/lint.sh b/scripts/lint.sh index c73653fc33..48263ebae3 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -28,7 +28,7 @@ if rustup component add clippy; then -Dwarnings done - cargo_feature opentelemetry "trace,metrics,logs,experimental_logs_level_enabled,testing" + cargo_feature opentelemetry "trace,metrics,logs,unstable_logs_level_enabled,testing" cargo_feature opentelemetry-otlp "default" cargo_feature opentelemetry-otlp "default,tls" diff --git a/stress/Cargo.toml b/stress/Cargo.toml index 993ffb01e0..bd8c4e3e53 100644 --- a/stress/Cargo.toml +++ b/stress/Cargo.toml @@ -43,8 +43,8 @@ doc = false ctrlc = "3.2.5" lazy_static = "1.4.0" num_cpus = "1.15.0" -opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "experimental_logs_level_enabled"] } -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "experimental_logs_level_enabled"] } +opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "unstable_logs_level_enabled"] } +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "unstable_logs_level_enabled"] } opentelemetry-appender-tracing = { path = "../opentelemetry-appender-tracing"} rand = { version = "0.8.4", features = ["small_rng"] } tracing = { workspace = true, features = ["std"]} From 64a7632c05df469aeef016033e93945d77906367 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Mon, 11 Nov 2024 12:08:08 -0800 Subject: [PATCH 4/6] rename flag to unstable_logs_enabled --- opentelemetry-appender-log/CHANGELOG.md | 2 +- opentelemetry-appender-log/Cargo.toml | 4 ++-- opentelemetry-appender-log/src/lib.rs | 10 +++++----- opentelemetry-appender-tracing/CHANGELOG.md | 2 +- opentelemetry-appender-tracing/Cargo.toml | 4 ++-- opentelemetry-appender-tracing/src/layer.rs | 2 +- opentelemetry-sdk/CHANGELOG.md | 2 +- opentelemetry-sdk/Cargo.toml | 2 +- opentelemetry-sdk/src/export/logs/mod.rs | 4 ++-- opentelemetry-sdk/src/lib.rs | 2 +- opentelemetry-sdk/src/logs/log_emitter.rs | 4 ++-- opentelemetry-sdk/src/logs/log_processor.rs | 4 ++-- opentelemetry-stdout/Cargo.toml | 2 +- opentelemetry/CHANGELOG.md | 2 +- opentelemetry/Cargo.toml | 4 ++-- opentelemetry/src/lib.rs | 2 +- opentelemetry/src/logs/logger.rs | 4 ++-- opentelemetry/src/logs/noop.rs | 2 +- scripts/lint.sh | 2 +- stress/Cargo.toml | 4 ++-- 20 files changed, 32 insertions(+), 32 deletions(-) diff --git a/opentelemetry-appender-log/CHANGELOG.md b/opentelemetry-appender-log/CHANGELOG.md index 17d0b61248..dc83e361c1 100644 --- a/opentelemetry-appender-log/CHANGELOG.md +++ b/opentelemetry-appender-log/CHANGELOG.md @@ -4,7 +4,7 @@ - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) - [2193](https://github.com/open-telemetry/opentelemetry-rust/pull/2193) `opentelemetry-appender-log`: Output experimental code attributes -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml index b8779f7d2d..ef757ab6e0 100644 --- a/opentelemetry-appender-log/Cargo.toml +++ b/opentelemetry-appender-log/Cargo.toml @@ -21,14 +21,14 @@ opentelemetry-semantic-conventions = { path = "../opentelemetry-semantic-convent ] } [features] -unstable_logs_level_enabled = ["opentelemetry/unstable_logs_level_enabled"] +unstable_logs_enabled = ["opentelemetry/unstable_logs_enabled"] with-serde = ["log/kv_serde", "serde"] experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"] [dev-dependencies] opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [ "testing", - "unstable_logs_level_enabled", + "unstable_logs_enabled", ] } opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] } log = { workspace = true, features = ["kv_serde"] } diff --git a/opentelemetry-appender-log/src/lib.rs b/opentelemetry-appender-log/src/lib.rs index a87626a05a..faf14b5b29 100644 --- a/opentelemetry-appender-log/src/lib.rs +++ b/opentelemetry-appender-log/src/lib.rs @@ -89,7 +89,7 @@ //! //! This library provides the following Cargo features: //! -//! - `unstable_logs_level_enabled`: Allow users to control the log level. +//! - `unstable_logs_enabled`: Allow users to control the log level. //! - `with-serde`: Support complex values as attributes without stringifying them. //! //! [Logs Bridge API]: https://opentelemetry.io/docs/specs/otel/logs/bridge-api/ @@ -117,11 +117,11 @@ where L: Logger + Send + Sync, { fn enabled(&self, _metadata: &Metadata) -> bool { - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] return self .logger .event_enabled(severity_of_level(_metadata.level()), _metadata.target()); - #[cfg(not(feature = "unstable_logs_level_enabled"))] + #[cfg(not(feature = "unstable_logs_enabled"))] true } @@ -770,9 +770,9 @@ mod tests { // As a result of using `with_simple_exporter` while building the logger provider, // the processor used is a `SimpleLogProcessor` which has an implementation of `event_enabled` // that always returns true. - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); - #[cfg(not(feature = "unstable_logs_level_enabled"))] + #[cfg(not(feature = "unstable_logs_enabled"))] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); } diff --git a/opentelemetry-appender-tracing/CHANGELOG.md b/opentelemetry-appender-tracing/CHANGELOG.md index 6a46505ac6..a84ad3d66a 100644 --- a/opentelemetry-appender-tracing/CHANGELOG.md +++ b/opentelemetry-appender-tracing/CHANGELOG.md @@ -3,7 +3,7 @@ ## vNext - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml index 5e321accab..08050fd0cc 100644 --- a/opentelemetry-appender-tracing/Cargo.toml +++ b/opentelemetry-appender-tracing/Cargo.toml @@ -33,10 +33,10 @@ pprof = { version = "0.13", features = ["flamegraph", "criterion"] } [features] experimental_metadata_attributes = ["dep:tracing-log"] -unstable_logs_level_enabled = ["opentelemetry/unstable_logs_level_enabled"] +unstable_logs_enabled = ["opentelemetry/unstable_logs_enabled"] [[bench]] name = "logs" harness = false -required-features = ["unstable_logs_level_enabled"] +required-features = ["unstable_logs_enabled"] diff --git a/opentelemetry-appender-tracing/src/layer.rs b/opentelemetry-appender-tracing/src/layer.rs index 686fab766f..129d4649e9 100644 --- a/opentelemetry-appender-tracing/src/layer.rs +++ b/opentelemetry-appender-tracing/src/layer.rs @@ -184,7 +184,7 @@ where self.logger.emit(log_record); } - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] fn event_enabled( &self, _event: &tracing_core::Event<'_>, diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index 52b8f30d53..46f8342c49 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -45,7 +45,7 @@ - Users calling public APIs that return these constructs (e.g, LoggerProvider::shutdown(), MeterProvider::force_flush()) should now import them from the SDK instead of the API. - Developers creating custom exporters should ensure they import these constructs from the SDK, not the API. - - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. + - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. - **BREAKING**: `Temporality` enum moved from `opentelemetry_sdk::metrics::data::Temporality` to `opentelemetry_sdk::metrics::Temporality`. diff --git a/opentelemetry-sdk/Cargo.toml b/opentelemetry-sdk/Cargo.toml index 6736affb59..5d56f2bb78 100644 --- a/opentelemetry-sdk/Cargo.toml +++ b/opentelemetry-sdk/Cargo.toml @@ -46,7 +46,7 @@ default = ["trace", "metrics", "logs", "internal-logs"] trace = ["opentelemetry/trace", "rand", "async-trait", "percent-encoding"] jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url"] logs = ["opentelemetry/logs", "async-trait", "serde_json"] -unstable_logs_level_enabled = ["logs", "opentelemetry/unstable_logs_level_enabled"] +unstable_logs_enabled = ["logs", "opentelemetry/unstable_logs_enabled"] metrics = ["opentelemetry/metrics", "glob", "async-trait"] testing = ["opentelemetry/testing", "trace", "metrics", "logs", "rt-async-std", "rt-tokio", "rt-tokio-current-thread", "tokio/macros", "tokio/rt-multi-thread"] rt-tokio = ["tokio", "tokio-stream"] diff --git a/opentelemetry-sdk/src/export/logs/mod.rs b/opentelemetry-sdk/src/export/logs/mod.rs index 02ce4053a4..ab604a9223 100644 --- a/opentelemetry-sdk/src/export/logs/mod.rs +++ b/opentelemetry-sdk/src/export/logs/mod.rs @@ -3,7 +3,7 @@ use crate::logs::LogRecord; use crate::logs::{LogError, LogResult}; use crate::Resource; use async_trait::async_trait; -#[cfg(feature = "unstable_logs_level_enabled")] +#[cfg(feature = "unstable_logs_enabled")] use opentelemetry::logs::Severity; use opentelemetry::InstrumentationScope; use std::fmt::Debug; @@ -85,7 +85,7 @@ pub trait LogExporter: Send + Sync + Debug { async fn export(&mut self, batch: LogBatch<'_>) -> LogResult<()>; /// Shuts down the exporter. fn shutdown(&mut self) {} - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] /// Chek if logs are enabled. fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-sdk/src/lib.rs b/opentelemetry-sdk/src/lib.rs index 7f3d774d6b..79e1018464 100644 --- a/opentelemetry-sdk/src/lib.rs +++ b/opentelemetry-sdk/src/lib.rs @@ -89,7 +89,7 @@ //! //! For `logs` the following feature flags are available: //! -//! * `unstable_logs_level_enabled`: control the log level +//! * `unstable_logs_enabled`: control the log level //! //! Support for recording and exporting telemetry asynchronously and perform //! metrics aggregation can be added via the following flags: diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 1b79f5fd8b..38f5578292 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -3,7 +3,7 @@ use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource}; use crate::{logs::LogError, logs::LogResult}; use opentelemetry::{otel_debug, trace::TraceContextExt, Context, InstrumentationScope}; -#[cfg(feature = "unstable_logs_level_enabled")] +#[cfg(feature = "unstable_logs_enabled")] use opentelemetry::logs::Severity; use std::time::SystemTime; @@ -282,7 +282,7 @@ impl opentelemetry::logs::Logger for Logger { } } - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] fn event_enabled(&self, level: Severity, target: &str) -> bool { let provider = self.provider(); diff --git a/opentelemetry-sdk/src/logs/log_processor.rs b/opentelemetry-sdk/src/logs/log_processor.rs index 4e769cb2ec..b5399d3604 100644 --- a/opentelemetry-sdk/src/logs/log_processor.rs +++ b/opentelemetry-sdk/src/logs/log_processor.rs @@ -9,7 +9,7 @@ use futures_util::{ future::{self, Either}, {pin_mut, stream, StreamExt as _}, }; -#[cfg(feature = "unstable_logs_level_enabled")] +#[cfg(feature = "unstable_logs_enabled")] use opentelemetry::logs::Severity; use opentelemetry::{otel_debug, otel_error, otel_warn, InstrumentationScope}; @@ -61,7 +61,7 @@ pub trait LogProcessor: Send + Sync + Debug { /// After shutdown returns the log processor should stop processing any logs. /// It's up to the implementation on when to drop the LogProcessor. fn shutdown(&self) -> LogResult<()>; - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] /// Check if logging is enabled fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-stdout/Cargo.toml b/opentelemetry-stdout/Cargo.toml index bc362da9a4..4b44388c02 100644 --- a/opentelemetry-stdout/Cargo.toml +++ b/opentelemetry-stdout/Cargo.toml @@ -23,7 +23,7 @@ rustdoc-args = ["--cfg", "docsrs"] default = ["trace", "metrics", "logs"] trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "futures-util"] metrics = ["async-trait", "opentelemetry/metrics", "opentelemetry_sdk/metrics"] -logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/unstable_logs_level_enabled"] +logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/unstable_logs_enabled"] populate-logs-event-name = [] [dependencies] diff --git a/opentelemetry/CHANGELOG.md b/opentelemetry/CHANGELOG.md index 63f024125f..1064872494 100644 --- a/opentelemetry/CHANGELOG.md +++ b/opentelemetry/CHANGELOG.md @@ -47,7 +47,7 @@ let counter = meter.u64_counter("my_counter").build(); - Moved `MetricError` enum from `opentelemetry::metrics::MetricError` to `opentelemetry_sdk::metrics::MetricError` - Moved `MetricResult` type alias from `opentelemetry::metrics::MetricResult` to `opentelemetry_sdk::metrics::MetricResult` These changes shouldn't directly affect the users of OpenTelemetry crate, as these constructs are used in SDK and Exporters. If you are an author of an sdk component/plug-in, like an exporter etc. please use these types from sdk. Refer [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-sdk/CHANGELOG.md) for more details, under same version section. -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_level_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 diff --git a/opentelemetry/Cargo.toml b/opentelemetry/Cargo.toml index 273142300f..faf00b0cd7 100644 --- a/opentelemetry/Cargo.toml +++ b/opentelemetry/Cargo.toml @@ -37,12 +37,12 @@ trace = ["pin-project-lite"] metrics = [] testing = ["trace", "metrics"] logs = [] -unstable_logs_level_enabled = ["logs"] +unstable_logs_enabled = ["logs"] otel_unstable = [] internal-logs = ["tracing"] [dev-dependencies] -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["unstable_logs_level_enabled"]} # for documentation tests +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["unstable_logs_enabled"]} # for documentation tests criterion = { workspace = true } rand = { workspace = true } diff --git a/opentelemetry/src/lib.rs b/opentelemetry/src/lib.rs index e3a6040e4b..1d402aeb91 100644 --- a/opentelemetry/src/lib.rs +++ b/opentelemetry/src/lib.rs @@ -114,7 +114,7 @@ //! The default feature flags are ["trace", "metrics", "logs"] //! //! The following feature flags provides additional configuration for `logs`: -//! * `unstable_logs_level_enabled`: Allow users to control the log level +//! * `unstable_logs_enabled`: Allow users to control the log level //! //! The following feature flags enable APIs defined in OpenTelemetry specification that is in experimental phase: //! * `otel_unstable`: Includes unstable APIs. diff --git a/opentelemetry/src/logs/logger.rs b/opentelemetry/src/logs/logger.rs index 084aec37ea..222b3aaa4b 100644 --- a/opentelemetry/src/logs/logger.rs +++ b/opentelemetry/src/logs/logger.rs @@ -2,7 +2,7 @@ use std::borrow::Cow; use crate::{logs::LogRecord, InstrumentationScope}; -#[cfg(feature = "unstable_logs_level_enabled")] +#[cfg(feature = "unstable_logs_enabled")] use super::Severity; /// The interface for emitting [`LogRecord`]s. @@ -20,7 +20,7 @@ pub trait Logger { /// [`Context`]: crate::Context fn emit(&self, record: Self::LogRecord); - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] /// Check if the given log level is enabled. fn event_enabled(&self, level: Severity, target: &str) -> bool; } diff --git a/opentelemetry/src/logs/noop.rs b/opentelemetry/src/logs/noop.rs index c5ba2b7642..f148a2d4c1 100644 --- a/opentelemetry/src/logs/noop.rs +++ b/opentelemetry/src/logs/noop.rs @@ -78,7 +78,7 @@ impl Logger for NoopLogger { NoopLogRecord {} } fn emit(&self, _record: Self::LogRecord) {} - #[cfg(feature = "unstable_logs_level_enabled")] + #[cfg(feature = "unstable_logs_enabled")] fn event_enabled(&self, _level: super::Severity, _target: &str) -> bool { false } diff --git a/scripts/lint.sh b/scripts/lint.sh index 48263ebae3..93d909bd15 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -28,7 +28,7 @@ if rustup component add clippy; then -Dwarnings done - cargo_feature opentelemetry "trace,metrics,logs,unstable_logs_level_enabled,testing" + cargo_feature opentelemetry "trace,metrics,logs,unstable_logs_enabled,testing" cargo_feature opentelemetry-otlp "default" cargo_feature opentelemetry-otlp "default,tls" diff --git a/stress/Cargo.toml b/stress/Cargo.toml index bd8c4e3e53..ea9cc6861f 100644 --- a/stress/Cargo.toml +++ b/stress/Cargo.toml @@ -43,8 +43,8 @@ doc = false ctrlc = "3.2.5" lazy_static = "1.4.0" num_cpus = "1.15.0" -opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "unstable_logs_level_enabled"] } -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "unstable_logs_level_enabled"] } +opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "unstable_logs_enabled"] } +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "unstable_logs_enabled"] } opentelemetry-appender-tracing = { path = "../opentelemetry-appender-tracing"} rand = { version = "0.8.4", features = ["small_rng"] } tracing = { workspace = true, features = ["std"]} From 8196606ccfdf347d8698651f033ca50f773e8f91 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Mon, 11 Nov 2024 12:09:50 -0800 Subject: [PATCH 5/6] rename to specs_unstable_logs_enabled --- opentelemetry-appender-log/CHANGELOG.md | 2 +- opentelemetry-appender-log/Cargo.toml | 4 ++-- opentelemetry-appender-log/src/lib.rs | 10 +++++----- opentelemetry-appender-tracing/CHANGELOG.md | 2 +- opentelemetry-appender-tracing/Cargo.toml | 4 ++-- opentelemetry-appender-tracing/src/layer.rs | 2 +- opentelemetry-sdk/CHANGELOG.md | 2 +- opentelemetry-sdk/Cargo.toml | 2 +- opentelemetry-sdk/src/export/logs/mod.rs | 4 ++-- opentelemetry-sdk/src/lib.rs | 2 +- opentelemetry-sdk/src/logs/log_emitter.rs | 4 ++-- opentelemetry-sdk/src/logs/log_processor.rs | 4 ++-- opentelemetry-stdout/Cargo.toml | 2 +- opentelemetry/CHANGELOG.md | 2 +- opentelemetry/Cargo.toml | 4 ++-- opentelemetry/src/lib.rs | 2 +- opentelemetry/src/logs/logger.rs | 4 ++-- opentelemetry/src/logs/noop.rs | 2 +- scripts/lint.sh | 2 +- stress/Cargo.toml | 4 ++-- 20 files changed, 32 insertions(+), 32 deletions(-) diff --git a/opentelemetry-appender-log/CHANGELOG.md b/opentelemetry-appender-log/CHANGELOG.md index dc83e361c1..2f3c687a5f 100644 --- a/opentelemetry-appender-log/CHANGELOG.md +++ b/opentelemetry-appender-log/CHANGELOG.md @@ -4,7 +4,7 @@ - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) - [2193](https://github.com/open-telemetry/opentelemetry-rust/pull/2193) `opentelemetry-appender-log`: Output experimental code attributes -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml index ef757ab6e0..b1029ceab5 100644 --- a/opentelemetry-appender-log/Cargo.toml +++ b/opentelemetry-appender-log/Cargo.toml @@ -21,14 +21,14 @@ opentelemetry-semantic-conventions = { path = "../opentelemetry-semantic-convent ] } [features] -unstable_logs_enabled = ["opentelemetry/unstable_logs_enabled"] +specs_unstable_logs_enabled = ["opentelemetry/specs_unstable_logs_enabled"] with-serde = ["log/kv_serde", "serde"] experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"] [dev-dependencies] opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [ "testing", - "unstable_logs_enabled", + "specs_unstable_logs_enabled", ] } opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] } log = { workspace = true, features = ["kv_serde"] } diff --git a/opentelemetry-appender-log/src/lib.rs b/opentelemetry-appender-log/src/lib.rs index faf14b5b29..25a5f8ed0f 100644 --- a/opentelemetry-appender-log/src/lib.rs +++ b/opentelemetry-appender-log/src/lib.rs @@ -89,7 +89,7 @@ //! //! This library provides the following Cargo features: //! -//! - `unstable_logs_enabled`: Allow users to control the log level. +//! - `specs_unstable_logs_enabled`: Allow users to control the log level. //! - `with-serde`: Support complex values as attributes without stringifying them. //! //! [Logs Bridge API]: https://opentelemetry.io/docs/specs/otel/logs/bridge-api/ @@ -117,11 +117,11 @@ where L: Logger + Send + Sync, { fn enabled(&self, _metadata: &Metadata) -> bool { - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] return self .logger .event_enabled(severity_of_level(_metadata.level()), _metadata.target()); - #[cfg(not(feature = "unstable_logs_enabled"))] + #[cfg(not(feature = "specs_unstable_logs_enabled"))] true } @@ -770,9 +770,9 @@ mod tests { // As a result of using `with_simple_exporter` while building the logger provider, // the processor used is a `SimpleLogProcessor` which has an implementation of `event_enabled` // that always returns true. - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); - #[cfg(not(feature = "unstable_logs_enabled"))] + #[cfg(not(feature = "specs_unstable_logs_enabled"))] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); } diff --git a/opentelemetry-appender-tracing/CHANGELOG.md b/opentelemetry-appender-tracing/CHANGELOG.md index a84ad3d66a..6e0d4e93dd 100644 --- a/opentelemetry-appender-tracing/CHANGELOG.md +++ b/opentelemetry-appender-tracing/CHANGELOG.md @@ -3,7 +3,7 @@ ## vNext - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml index 08050fd0cc..d746063b84 100644 --- a/opentelemetry-appender-tracing/Cargo.toml +++ b/opentelemetry-appender-tracing/Cargo.toml @@ -33,10 +33,10 @@ pprof = { version = "0.13", features = ["flamegraph", "criterion"] } [features] experimental_metadata_attributes = ["dep:tracing-log"] -unstable_logs_enabled = ["opentelemetry/unstable_logs_enabled"] +specs_unstable_logs_enabled = ["opentelemetry/specs_unstable_logs_enabled"] [[bench]] name = "logs" harness = false -required-features = ["unstable_logs_enabled"] +required-features = ["specs_unstable_logs_enabled"] diff --git a/opentelemetry-appender-tracing/src/layer.rs b/opentelemetry-appender-tracing/src/layer.rs index 129d4649e9..b74c84d6bf 100644 --- a/opentelemetry-appender-tracing/src/layer.rs +++ b/opentelemetry-appender-tracing/src/layer.rs @@ -184,7 +184,7 @@ where self.logger.emit(log_record); } - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] fn event_enabled( &self, _event: &tracing_core::Event<'_>, diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index 46f8342c49..ceb8c203a5 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -45,7 +45,7 @@ - Users calling public APIs that return these constructs (e.g, LoggerProvider::shutdown(), MeterProvider::force_flush()) should now import them from the SDK instead of the API. - Developers creating custom exporters should ensure they import these constructs from the SDK, not the API. - - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. + - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. - **BREAKING**: `Temporality` enum moved from `opentelemetry_sdk::metrics::data::Temporality` to `opentelemetry_sdk::metrics::Temporality`. diff --git a/opentelemetry-sdk/Cargo.toml b/opentelemetry-sdk/Cargo.toml index 5d56f2bb78..3c0ef7badd 100644 --- a/opentelemetry-sdk/Cargo.toml +++ b/opentelemetry-sdk/Cargo.toml @@ -46,7 +46,7 @@ default = ["trace", "metrics", "logs", "internal-logs"] trace = ["opentelemetry/trace", "rand", "async-trait", "percent-encoding"] jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url"] logs = ["opentelemetry/logs", "async-trait", "serde_json"] -unstable_logs_enabled = ["logs", "opentelemetry/unstable_logs_enabled"] +specs_unstable_logs_enabled = ["logs", "opentelemetry/specs_unstable_logs_enabled"] metrics = ["opentelemetry/metrics", "glob", "async-trait"] testing = ["opentelemetry/testing", "trace", "metrics", "logs", "rt-async-std", "rt-tokio", "rt-tokio-current-thread", "tokio/macros", "tokio/rt-multi-thread"] rt-tokio = ["tokio", "tokio-stream"] diff --git a/opentelemetry-sdk/src/export/logs/mod.rs b/opentelemetry-sdk/src/export/logs/mod.rs index ab604a9223..cf3f32aa76 100644 --- a/opentelemetry-sdk/src/export/logs/mod.rs +++ b/opentelemetry-sdk/src/export/logs/mod.rs @@ -3,7 +3,7 @@ use crate::logs::LogRecord; use crate::logs::{LogError, LogResult}; use crate::Resource; use async_trait::async_trait; -#[cfg(feature = "unstable_logs_enabled")] +#[cfg(feature = "specs_unstable_logs_enabled")] use opentelemetry::logs::Severity; use opentelemetry::InstrumentationScope; use std::fmt::Debug; @@ -85,7 +85,7 @@ pub trait LogExporter: Send + Sync + Debug { async fn export(&mut self, batch: LogBatch<'_>) -> LogResult<()>; /// Shuts down the exporter. fn shutdown(&mut self) {} - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] /// Chek if logs are enabled. fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-sdk/src/lib.rs b/opentelemetry-sdk/src/lib.rs index 79e1018464..84f6336592 100644 --- a/opentelemetry-sdk/src/lib.rs +++ b/opentelemetry-sdk/src/lib.rs @@ -89,7 +89,7 @@ //! //! For `logs` the following feature flags are available: //! -//! * `unstable_logs_enabled`: control the log level +//! * `specs_unstable_logs_enabled`: control the log level //! //! Support for recording and exporting telemetry asynchronously and perform //! metrics aggregation can be added via the following flags: diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index 38f5578292..f5067bc261 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -3,7 +3,7 @@ use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource}; use crate::{logs::LogError, logs::LogResult}; use opentelemetry::{otel_debug, trace::TraceContextExt, Context, InstrumentationScope}; -#[cfg(feature = "unstable_logs_enabled")] +#[cfg(feature = "specs_unstable_logs_enabled")] use opentelemetry::logs::Severity; use std::time::SystemTime; @@ -282,7 +282,7 @@ impl opentelemetry::logs::Logger for Logger { } } - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] fn event_enabled(&self, level: Severity, target: &str) -> bool { let provider = self.provider(); diff --git a/opentelemetry-sdk/src/logs/log_processor.rs b/opentelemetry-sdk/src/logs/log_processor.rs index b5399d3604..dccf0f2ffe 100644 --- a/opentelemetry-sdk/src/logs/log_processor.rs +++ b/opentelemetry-sdk/src/logs/log_processor.rs @@ -9,7 +9,7 @@ use futures_util::{ future::{self, Either}, {pin_mut, stream, StreamExt as _}, }; -#[cfg(feature = "unstable_logs_enabled")] +#[cfg(feature = "specs_unstable_logs_enabled")] use opentelemetry::logs::Severity; use opentelemetry::{otel_debug, otel_error, otel_warn, InstrumentationScope}; @@ -61,7 +61,7 @@ pub trait LogProcessor: Send + Sync + Debug { /// After shutdown returns the log processor should stop processing any logs. /// It's up to the implementation on when to drop the LogProcessor. fn shutdown(&self) -> LogResult<()>; - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] /// Check if logging is enabled fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-stdout/Cargo.toml b/opentelemetry-stdout/Cargo.toml index 4b44388c02..3eb2632bd2 100644 --- a/opentelemetry-stdout/Cargo.toml +++ b/opentelemetry-stdout/Cargo.toml @@ -23,7 +23,7 @@ rustdoc-args = ["--cfg", "docsrs"] default = ["trace", "metrics", "logs"] trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "futures-util"] metrics = ["async-trait", "opentelemetry/metrics", "opentelemetry_sdk/metrics"] -logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/unstable_logs_enabled"] +logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/specs_unstable_logs_enabled"] populate-logs-event-name = [] [dependencies] diff --git a/opentelemetry/CHANGELOG.md b/opentelemetry/CHANGELOG.md index 1064872494..57334b3d2f 100644 --- a/opentelemetry/CHANGELOG.md +++ b/opentelemetry/CHANGELOG.md @@ -47,7 +47,7 @@ let counter = meter.u64_counter("my_counter").build(); - Moved `MetricError` enum from `opentelemetry::metrics::MetricError` to `opentelemetry_sdk::metrics::MetricError` - Moved `MetricResult` type alias from `opentelemetry::metrics::MetricResult` to `opentelemetry_sdk::metrics::MetricResult` These changes shouldn't directly affect the users of OpenTelemetry crate, as these constructs are used in SDK and Exporters. If you are an author of an sdk component/plug-in, like an exporter etc. please use these types from sdk. Refer [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-sdk/CHANGELOG.md) for more details, under same version section. -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 diff --git a/opentelemetry/Cargo.toml b/opentelemetry/Cargo.toml index faf00b0cd7..b558b89a3e 100644 --- a/opentelemetry/Cargo.toml +++ b/opentelemetry/Cargo.toml @@ -37,12 +37,12 @@ trace = ["pin-project-lite"] metrics = [] testing = ["trace", "metrics"] logs = [] -unstable_logs_enabled = ["logs"] +specs_unstable_logs_enabled = ["logs"] otel_unstable = [] internal-logs = ["tracing"] [dev-dependencies] -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["unstable_logs_enabled"]} # for documentation tests +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["specs_unstable_logs_enabled"]} # for documentation tests criterion = { workspace = true } rand = { workspace = true } diff --git a/opentelemetry/src/lib.rs b/opentelemetry/src/lib.rs index 1d402aeb91..8c49e1376d 100644 --- a/opentelemetry/src/lib.rs +++ b/opentelemetry/src/lib.rs @@ -114,7 +114,7 @@ //! The default feature flags are ["trace", "metrics", "logs"] //! //! The following feature flags provides additional configuration for `logs`: -//! * `unstable_logs_enabled`: Allow users to control the log level +//! * `specs_unstable_logs_enabled`: Allow users to control the log level //! //! The following feature flags enable APIs defined in OpenTelemetry specification that is in experimental phase: //! * `otel_unstable`: Includes unstable APIs. diff --git a/opentelemetry/src/logs/logger.rs b/opentelemetry/src/logs/logger.rs index 222b3aaa4b..edfa732e5c 100644 --- a/opentelemetry/src/logs/logger.rs +++ b/opentelemetry/src/logs/logger.rs @@ -2,7 +2,7 @@ use std::borrow::Cow; use crate::{logs::LogRecord, InstrumentationScope}; -#[cfg(feature = "unstable_logs_enabled")] +#[cfg(feature = "specs_unstable_logs_enabled")] use super::Severity; /// The interface for emitting [`LogRecord`]s. @@ -20,7 +20,7 @@ pub trait Logger { /// [`Context`]: crate::Context fn emit(&self, record: Self::LogRecord); - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] /// Check if the given log level is enabled. fn event_enabled(&self, level: Severity, target: &str) -> bool; } diff --git a/opentelemetry/src/logs/noop.rs b/opentelemetry/src/logs/noop.rs index f148a2d4c1..5b34557861 100644 --- a/opentelemetry/src/logs/noop.rs +++ b/opentelemetry/src/logs/noop.rs @@ -78,7 +78,7 @@ impl Logger for NoopLogger { NoopLogRecord {} } fn emit(&self, _record: Self::LogRecord) {} - #[cfg(feature = "unstable_logs_enabled")] + #[cfg(feature = "specs_unstable_logs_enabled")] fn event_enabled(&self, _level: super::Severity, _target: &str) -> bool { false } diff --git a/scripts/lint.sh b/scripts/lint.sh index 93d909bd15..70298a7aba 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -28,7 +28,7 @@ if rustup component add clippy; then -Dwarnings done - cargo_feature opentelemetry "trace,metrics,logs,unstable_logs_enabled,testing" + cargo_feature opentelemetry "trace,metrics,logs,specs_unstable_logs_enabled,testing" cargo_feature opentelemetry-otlp "default" cargo_feature opentelemetry-otlp "default,tls" diff --git a/stress/Cargo.toml b/stress/Cargo.toml index ea9cc6861f..7c1bb624f8 100644 --- a/stress/Cargo.toml +++ b/stress/Cargo.toml @@ -43,8 +43,8 @@ doc = false ctrlc = "3.2.5" lazy_static = "1.4.0" num_cpus = "1.15.0" -opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "unstable_logs_enabled"] } -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "unstable_logs_enabled"] } +opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "specs_unstable_logs_enabled"] } +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "specs_unstable_logs_enabled"] } opentelemetry-appender-tracing = { path = "../opentelemetry-appender-tracing"} rand = { version = "0.8.4", features = ["small_rng"] } tracing = { workspace = true, features = ["std"]} From d7000f5082af8bac08be9272392377f73ed6d396 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Mon, 11 Nov 2024 12:28:58 -0800 Subject: [PATCH 6/6] rename to spec_unstable_logs_enabled --- opentelemetry-appender-log/CHANGELOG.md | 2 +- opentelemetry-appender-log/Cargo.toml | 4 ++-- opentelemetry-appender-log/src/lib.rs | 10 +++++----- opentelemetry-appender-tracing/CHANGELOG.md | 2 +- opentelemetry-appender-tracing/Cargo.toml | 4 ++-- opentelemetry-appender-tracing/src/layer.rs | 2 +- opentelemetry-sdk/CHANGELOG.md | 2 +- opentelemetry-sdk/Cargo.toml | 2 +- opentelemetry-sdk/src/export/logs/mod.rs | 4 ++-- opentelemetry-sdk/src/lib.rs | 2 +- opentelemetry-sdk/src/logs/log_emitter.rs | 4 ++-- opentelemetry-sdk/src/logs/log_processor.rs | 4 ++-- opentelemetry-stdout/Cargo.toml | 2 +- opentelemetry/CHANGELOG.md | 2 +- opentelemetry/Cargo.toml | 4 ++-- opentelemetry/src/lib.rs | 2 +- opentelemetry/src/logs/logger.rs | 4 ++-- opentelemetry/src/logs/noop.rs | 2 +- scripts/lint.sh | 2 +- stress/Cargo.toml | 4 ++-- 20 files changed, 32 insertions(+), 32 deletions(-) diff --git a/opentelemetry-appender-log/CHANGELOG.md b/opentelemetry-appender-log/CHANGELOG.md index 2f3c687a5f..7e44dfa341 100644 --- a/opentelemetry-appender-log/CHANGELOG.md +++ b/opentelemetry-appender-log/CHANGELOG.md @@ -4,7 +4,7 @@ - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) - [2193](https://github.com/open-telemetry/opentelemetry-rust/pull/2193) `opentelemetry-appender-log`: Output experimental code attributes -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `spec_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-log/Cargo.toml b/opentelemetry-appender-log/Cargo.toml index b1029ceab5..1e4efc7ffe 100644 --- a/opentelemetry-appender-log/Cargo.toml +++ b/opentelemetry-appender-log/Cargo.toml @@ -21,14 +21,14 @@ opentelemetry-semantic-conventions = { path = "../opentelemetry-semantic-convent ] } [features] -specs_unstable_logs_enabled = ["opentelemetry/specs_unstable_logs_enabled"] +spec_unstable_logs_enabled = ["opentelemetry/spec_unstable_logs_enabled"] with-serde = ["log/kv_serde", "serde"] experimental_metadata_attributes = ["dep:opentelemetry-semantic-conventions"] [dev-dependencies] opentelemetry_sdk = { path = "../opentelemetry-sdk", features = [ "testing", - "specs_unstable_logs_enabled", + "spec_unstable_logs_enabled", ] } opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] } log = { workspace = true, features = ["kv_serde"] } diff --git a/opentelemetry-appender-log/src/lib.rs b/opentelemetry-appender-log/src/lib.rs index 25a5f8ed0f..69f4eabeed 100644 --- a/opentelemetry-appender-log/src/lib.rs +++ b/opentelemetry-appender-log/src/lib.rs @@ -89,7 +89,7 @@ //! //! This library provides the following Cargo features: //! -//! - `specs_unstable_logs_enabled`: Allow users to control the log level. +//! - `spec_unstable_logs_enabled`: Allow users to control the log level. //! - `with-serde`: Support complex values as attributes without stringifying them. //! //! [Logs Bridge API]: https://opentelemetry.io/docs/specs/otel/logs/bridge-api/ @@ -117,11 +117,11 @@ where L: Logger + Send + Sync, { fn enabled(&self, _metadata: &Metadata) -> bool { - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] return self .logger .event_enabled(severity_of_level(_metadata.level()), _metadata.target()); - #[cfg(not(feature = "specs_unstable_logs_enabled"))] + #[cfg(not(feature = "spec_unstable_logs_enabled"))] true } @@ -770,9 +770,9 @@ mod tests { // As a result of using `with_simple_exporter` while building the logger provider, // the processor used is a `SimpleLogProcessor` which has an implementation of `event_enabled` // that always returns true. - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); - #[cfg(not(feature = "specs_unstable_logs_enabled"))] + #[cfg(not(feature = "spec_unstable_logs_enabled"))] assert!(otel_log_appender.enabled(&log::Metadata::builder().build())); } diff --git a/opentelemetry-appender-tracing/CHANGELOG.md b/opentelemetry-appender-tracing/CHANGELOG.md index 6e0d4e93dd..c74c340db0 100644 --- a/opentelemetry-appender-tracing/CHANGELOG.md +++ b/opentelemetry-appender-tracing/CHANGELOG.md @@ -3,7 +3,7 @@ ## vNext - Bump MSRV to 1.70 [#2179](https://github.com/open-telemetry/opentelemetry-rust/pull/2179) -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `spec_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 Released 2024-Sep-30 diff --git a/opentelemetry-appender-tracing/Cargo.toml b/opentelemetry-appender-tracing/Cargo.toml index d746063b84..77a80c4568 100644 --- a/opentelemetry-appender-tracing/Cargo.toml +++ b/opentelemetry-appender-tracing/Cargo.toml @@ -33,10 +33,10 @@ pprof = { version = "0.13", features = ["flamegraph", "criterion"] } [features] experimental_metadata_attributes = ["dep:tracing-log"] -specs_unstable_logs_enabled = ["opentelemetry/specs_unstable_logs_enabled"] +spec_unstable_logs_enabled = ["opentelemetry/spec_unstable_logs_enabled"] [[bench]] name = "logs" harness = false -required-features = ["specs_unstable_logs_enabled"] +required-features = ["spec_unstable_logs_enabled"] diff --git a/opentelemetry-appender-tracing/src/layer.rs b/opentelemetry-appender-tracing/src/layer.rs index b74c84d6bf..62b840108b 100644 --- a/opentelemetry-appender-tracing/src/layer.rs +++ b/opentelemetry-appender-tracing/src/layer.rs @@ -184,7 +184,7 @@ where self.logger.emit(log_record); } - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] fn event_enabled( &self, _event: &tracing_core::Event<'_>, diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md index ceb8c203a5..43a2218169 100644 --- a/opentelemetry-sdk/CHANGELOG.md +++ b/opentelemetry-sdk/CHANGELOG.md @@ -45,7 +45,7 @@ - Users calling public APIs that return these constructs (e.g, LoggerProvider::shutdown(), MeterProvider::force_flush()) should now import them from the SDK instead of the API. - Developers creating custom exporters should ensure they import these constructs from the SDK, not the API. - - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. + - [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `spec_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. - **BREAKING**: `Temporality` enum moved from `opentelemetry_sdk::metrics::data::Temporality` to `opentelemetry_sdk::metrics::Temporality`. diff --git a/opentelemetry-sdk/Cargo.toml b/opentelemetry-sdk/Cargo.toml index 3c0ef7badd..f73f9933dd 100644 --- a/opentelemetry-sdk/Cargo.toml +++ b/opentelemetry-sdk/Cargo.toml @@ -46,7 +46,7 @@ default = ["trace", "metrics", "logs", "internal-logs"] trace = ["opentelemetry/trace", "rand", "async-trait", "percent-encoding"] jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url"] logs = ["opentelemetry/logs", "async-trait", "serde_json"] -specs_unstable_logs_enabled = ["logs", "opentelemetry/specs_unstable_logs_enabled"] +spec_unstable_logs_enabled = ["logs", "opentelemetry/spec_unstable_logs_enabled"] metrics = ["opentelemetry/metrics", "glob", "async-trait"] testing = ["opentelemetry/testing", "trace", "metrics", "logs", "rt-async-std", "rt-tokio", "rt-tokio-current-thread", "tokio/macros", "tokio/rt-multi-thread"] rt-tokio = ["tokio", "tokio-stream"] diff --git a/opentelemetry-sdk/src/export/logs/mod.rs b/opentelemetry-sdk/src/export/logs/mod.rs index cf3f32aa76..a2b0c98729 100644 --- a/opentelemetry-sdk/src/export/logs/mod.rs +++ b/opentelemetry-sdk/src/export/logs/mod.rs @@ -3,7 +3,7 @@ use crate::logs::LogRecord; use crate::logs::{LogError, LogResult}; use crate::Resource; use async_trait::async_trait; -#[cfg(feature = "specs_unstable_logs_enabled")] +#[cfg(feature = "spec_unstable_logs_enabled")] use opentelemetry::logs::Severity; use opentelemetry::InstrumentationScope; use std::fmt::Debug; @@ -85,7 +85,7 @@ pub trait LogExporter: Send + Sync + Debug { async fn export(&mut self, batch: LogBatch<'_>) -> LogResult<()>; /// Shuts down the exporter. fn shutdown(&mut self) {} - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] /// Chek if logs are enabled. fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-sdk/src/lib.rs b/opentelemetry-sdk/src/lib.rs index 84f6336592..2c07f1c2ea 100644 --- a/opentelemetry-sdk/src/lib.rs +++ b/opentelemetry-sdk/src/lib.rs @@ -89,7 +89,7 @@ //! //! For `logs` the following feature flags are available: //! -//! * `specs_unstable_logs_enabled`: control the log level +//! * `spec_unstable_logs_enabled`: control the log level //! //! Support for recording and exporting telemetry asynchronously and perform //! metrics aggregation can be added via the following flags: diff --git a/opentelemetry-sdk/src/logs/log_emitter.rs b/opentelemetry-sdk/src/logs/log_emitter.rs index f5067bc261..0f4cbfc53c 100644 --- a/opentelemetry-sdk/src/logs/log_emitter.rs +++ b/opentelemetry-sdk/src/logs/log_emitter.rs @@ -3,7 +3,7 @@ use crate::{export::logs::LogExporter, runtime::RuntimeChannel, Resource}; use crate::{logs::LogError, logs::LogResult}; use opentelemetry::{otel_debug, trace::TraceContextExt, Context, InstrumentationScope}; -#[cfg(feature = "specs_unstable_logs_enabled")] +#[cfg(feature = "spec_unstable_logs_enabled")] use opentelemetry::logs::Severity; use std::time::SystemTime; @@ -282,7 +282,7 @@ impl opentelemetry::logs::Logger for Logger { } } - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] fn event_enabled(&self, level: Severity, target: &str) -> bool { let provider = self.provider(); diff --git a/opentelemetry-sdk/src/logs/log_processor.rs b/opentelemetry-sdk/src/logs/log_processor.rs index dccf0f2ffe..d4f5e53f40 100644 --- a/opentelemetry-sdk/src/logs/log_processor.rs +++ b/opentelemetry-sdk/src/logs/log_processor.rs @@ -9,7 +9,7 @@ use futures_util::{ future::{self, Either}, {pin_mut, stream, StreamExt as _}, }; -#[cfg(feature = "specs_unstable_logs_enabled")] +#[cfg(feature = "spec_unstable_logs_enabled")] use opentelemetry::logs::Severity; use opentelemetry::{otel_debug, otel_error, otel_warn, InstrumentationScope}; @@ -61,7 +61,7 @@ pub trait LogProcessor: Send + Sync + Debug { /// After shutdown returns the log processor should stop processing any logs. /// It's up to the implementation on when to drop the LogProcessor. fn shutdown(&self) -> LogResult<()>; - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] /// Check if logging is enabled fn event_enabled(&self, _level: Severity, _target: &str, _name: &str) -> bool { // By default, all logs are enabled diff --git a/opentelemetry-stdout/Cargo.toml b/opentelemetry-stdout/Cargo.toml index 3eb2632bd2..4495ceed5e 100644 --- a/opentelemetry-stdout/Cargo.toml +++ b/opentelemetry-stdout/Cargo.toml @@ -23,7 +23,7 @@ rustdoc-args = ["--cfg", "docsrs"] default = ["trace", "metrics", "logs"] trace = ["opentelemetry/trace", "opentelemetry_sdk/trace", "futures-util"] metrics = ["async-trait", "opentelemetry/metrics", "opentelemetry_sdk/metrics"] -logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/specs_unstable_logs_enabled"] +logs = ["opentelemetry/logs", "opentelemetry_sdk/logs", "async-trait", "thiserror", "opentelemetry_sdk/spec_unstable_logs_enabled"] populate-logs-event-name = [] [dependencies] diff --git a/opentelemetry/CHANGELOG.md b/opentelemetry/CHANGELOG.md index 57334b3d2f..aea3a5280d 100644 --- a/opentelemetry/CHANGELOG.md +++ b/opentelemetry/CHANGELOG.md @@ -47,7 +47,7 @@ let counter = meter.u64_counter("my_counter").build(); - Moved `MetricError` enum from `opentelemetry::metrics::MetricError` to `opentelemetry_sdk::metrics::MetricError` - Moved `MetricResult` type alias from `opentelemetry::metrics::MetricResult` to `opentelemetry_sdk::metrics::MetricResult` These changes shouldn't directly affect the users of OpenTelemetry crate, as these constructs are used in SDK and Exporters. If you are an author of an sdk component/plug-in, like an exporter etc. please use these types from sdk. Refer [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-sdk/CHANGELOG.md) for more details, under same version section. -- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `specs_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. +- **Breaking** [2291](https://github.com/open-telemetry/opentelemetry-rust/pull/2291) Rename `logs_level_enabled flag` to `spec_unstable_logs_enabled`. Please enable this updated flag if the feature is needed. This flag will be removed once the feature is stabilized in the specifications. ## v0.26.0 diff --git a/opentelemetry/Cargo.toml b/opentelemetry/Cargo.toml index b558b89a3e..8be1077f07 100644 --- a/opentelemetry/Cargo.toml +++ b/opentelemetry/Cargo.toml @@ -37,12 +37,12 @@ trace = ["pin-project-lite"] metrics = [] testing = ["trace", "metrics"] logs = [] -specs_unstable_logs_enabled = ["logs"] +spec_unstable_logs_enabled = ["logs"] otel_unstable = [] internal-logs = ["tracing"] [dev-dependencies] -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["specs_unstable_logs_enabled"]} # for documentation tests +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["spec_unstable_logs_enabled"]} # for documentation tests criterion = { workspace = true } rand = { workspace = true } diff --git a/opentelemetry/src/lib.rs b/opentelemetry/src/lib.rs index 8c49e1376d..77ff1974cc 100644 --- a/opentelemetry/src/lib.rs +++ b/opentelemetry/src/lib.rs @@ -114,7 +114,7 @@ //! The default feature flags are ["trace", "metrics", "logs"] //! //! The following feature flags provides additional configuration for `logs`: -//! * `specs_unstable_logs_enabled`: Allow users to control the log level +//! * `spec_unstable_logs_enabled`: Allow users to control the log level //! //! The following feature flags enable APIs defined in OpenTelemetry specification that is in experimental phase: //! * `otel_unstable`: Includes unstable APIs. diff --git a/opentelemetry/src/logs/logger.rs b/opentelemetry/src/logs/logger.rs index edfa732e5c..0561fef3f9 100644 --- a/opentelemetry/src/logs/logger.rs +++ b/opentelemetry/src/logs/logger.rs @@ -2,7 +2,7 @@ use std::borrow::Cow; use crate::{logs::LogRecord, InstrumentationScope}; -#[cfg(feature = "specs_unstable_logs_enabled")] +#[cfg(feature = "spec_unstable_logs_enabled")] use super::Severity; /// The interface for emitting [`LogRecord`]s. @@ -20,7 +20,7 @@ pub trait Logger { /// [`Context`]: crate::Context fn emit(&self, record: Self::LogRecord); - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] /// Check if the given log level is enabled. fn event_enabled(&self, level: Severity, target: &str) -> bool; } diff --git a/opentelemetry/src/logs/noop.rs b/opentelemetry/src/logs/noop.rs index 5b34557861..a9706fa5a4 100644 --- a/opentelemetry/src/logs/noop.rs +++ b/opentelemetry/src/logs/noop.rs @@ -78,7 +78,7 @@ impl Logger for NoopLogger { NoopLogRecord {} } fn emit(&self, _record: Self::LogRecord) {} - #[cfg(feature = "specs_unstable_logs_enabled")] + #[cfg(feature = "spec_unstable_logs_enabled")] fn event_enabled(&self, _level: super::Severity, _target: &str) -> bool { false } diff --git a/scripts/lint.sh b/scripts/lint.sh index 70298a7aba..cea26cd7e1 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -28,7 +28,7 @@ if rustup component add clippy; then -Dwarnings done - cargo_feature opentelemetry "trace,metrics,logs,specs_unstable_logs_enabled,testing" + cargo_feature opentelemetry "trace,metrics,logs,spec_unstable_logs_enabled,testing" cargo_feature opentelemetry-otlp "default" cargo_feature opentelemetry-otlp "default,tls" diff --git a/stress/Cargo.toml b/stress/Cargo.toml index 7c1bb624f8..90bb6e2889 100644 --- a/stress/Cargo.toml +++ b/stress/Cargo.toml @@ -43,8 +43,8 @@ doc = false ctrlc = "3.2.5" lazy_static = "1.4.0" num_cpus = "1.15.0" -opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "specs_unstable_logs_enabled"] } -opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "specs_unstable_logs_enabled"] } +opentelemetry = { path = "../opentelemetry", features = ["metrics", "logs", "trace", "spec_unstable_logs_enabled"] } +opentelemetry_sdk = { path = "../opentelemetry-sdk", features = ["metrics", "logs", "trace", "spec_unstable_logs_enabled"] } opentelemetry-appender-tracing = { path = "../opentelemetry-appender-tracing"} rand = { version = "0.8.4", features = ["small_rng"] } tracing = { workspace = true, features = ["std"]}