Merge branch 'main' into main

Author: scottgerring

.github/workflows/fossa.yml

@@ -0,0 +1,20 @@
+name: FOSSA scanning
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  fossa:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - uses: fossas/fossa-action@93a52ecf7c3ac7eb40f5de77fd69b1a19524de94 # v1.5.0
+        with:
+          api-key: ${{secrets.FOSSA_API_KEY}}
+          team: OpenTelemetry

Cargo.toml

@@ -36,7 +36,7 @@ pin-project-lite = "0.2"
 prost = "0.13"
 prost-build = "0.13"
 prost-types = "0.13"
-rand = { version = "0.8", default-features = false }
+rand = { version = "0.9", default-features = false }
 reqwest = { version = "0.12", default-features = false }
 serde = { version = "1.0", default-features = false }
 serde_json = "1.0"
@@ -59,3 +59,6 @@ url = { version = "2.5", default-features = false }
 opentelemetry = { path = "opentelemetry" }
 opentelemetry_sdk = { path = "opentelemetry-sdk" }
 opentelemetry-stdout = { path = "opentelemetry-stdout" }
+
+[workspace.lints.clippy]
+all = { level = "warn", priority = 1 }

README.md

@@ -186,6 +186,7 @@ you're more than welcome to participate!
 ### Approvers
 
 * [Shaun Cox](https://github.com/shaun-cox)
+* [Scott Gerring](https://github.com/scottgerring)
 
 ### Emeritus
 

docs/design/logs.md

@@ -280,6 +280,22 @@ this crate.
 ## Performance
 
 // Call out things done specifically for performance
+// Rough draft
+
+1. `LogRecord` is stack allocated and not Boxed unless required by the component
+needing to store it beyond the logging call. (eg: BatchProcessor)
+2. LogRecords's Attribute storage is specially designed struct, that holds up to
+five attributes in stack.
+3. When passing `LogRecord`s to processor, a mutable ref is passed. This allows
+calling multiple processors one after another, without the need for cloning.
+4. `Logger` provides a `Enabled` check which can optimize performance when
+no-one is interested in the log. The check is passed from `Logger` to the
+processor, which may consult its exporter to make the decision. An example use
+case - an ETW or user-events exporter can check for the presence of listener and
+convey that decision back to logger, allowing appender to avoid even the cost of
+creating a `LogRecord` in the first place if there is no listener. This check is
+done for each log emission, and can react dynamically to changes in interest, by
+enabling/disabling ETW/user-event listener.
 
 ### Perf test - benchmarks
 
@@ -289,6 +305,23 @@ this crate.
 
 // Share ~~ numbers
 
+## Internal logs
+
+OTel itself is instrumented with `tracing` crate to emit internal logs about its
+operations. This is feature gated under "internal-logs", and is enabled by
+default for all components. The `opentelemetry` provide few helper macros
+`otel_warn` etc., which in turn invokes various `tracing` macros like `warn!`
+etc. The cargo package name will be set as `target` when using `tracing`. For
+example, logs from `opentelemetry-otlp` will have target set to
+"opentelemetry-otlp".
+
+The helper macros are part of public API, so can be used by anyone. But it is
+only meant for OTel components itself and anyone writing extensions like custom
+Exporters etc.
+
+// TODO: Document the principles followed when selecting severity for internal
+logs // TODO: Document how this can cause circular loop and plans to address it.
+
 ## Summary
 
 - OpenTelemetry Logs does not provide a user-facing logging API.

examples/metrics-advanced/src/main.rs

@@ -1,9 +1,7 @@
 use opentelemetry::global;
 use opentelemetry::Key;
 use opentelemetry::KeyValue;
-use opentelemetry_sdk::metrics::{
-    Aggregation, Instrument, PeriodicReader, SdkMeterProvider, Stream, Temporality,
-};
+use opentelemetry_sdk::metrics::{Aggregation, Instrument, SdkMeterProvider, Stream, Temporality};
 use opentelemetry_sdk::Resource;
 use std::error::Error;
 

examples/metrics-basic/src/main.rs

@@ -1,6 +1,5 @@
 use opentelemetry::{global, KeyValue};
-use opentelemetry_sdk::error::OTelSdkError;
-use opentelemetry_sdk::metrics::{PeriodicReader, SdkMeterProvider};
+use opentelemetry_sdk::metrics::SdkMeterProvider;
 use opentelemetry_sdk::Resource;
 use std::error::Error;
 use std::vec;

examples/tracing-jaeger/src/main.rs

@@ -1,9 +1,9 @@
 use opentelemetry::{
     global,
-    trace::{TraceContextExt, TraceError, Tracer},
+    trace::{TraceContextExt, Tracer},
     KeyValue,
 };
-use opentelemetry_sdk::trace::SdkTracerProvider;
+use opentelemetry_sdk::trace::{SdkTracerProvider, TraceError};
 use opentelemetry_sdk::Resource;
 
 use std::error::Error;

opentelemetry-appender-log/Cargo.toml

@@ -34,3 +34,6 @@ opentelemetry-stdout = { path = "../opentelemetry-stdout", features = ["logs"] }
 log = { workspace = true, features = ["kv_serde"] }
 tokio = { workspace = true }
 serde = { workspace = true, features = ["std", "derive"] }
+
+[lints]
+workspace = true

opentelemetry-appender-log/README.md

@@ -8,7 +8,7 @@ This crate contains a [Log Appender](https://github.com/open-telemetry/opentelem
 
 [![Crates.io: opentelemetry-appender-log](https://img.shields.io/crates/v/opentelemetry-appender-log.svg)](https://crates.io/crates/opentelemetry-appender-log)
 [![Documentation](https://docs.rs/opentelemetry-appender-log/badge.svg)](https://docs.rs/opentelemetry-appender-log)
-[![LICENSE](https://img.shields.io/crates/l/opentelemetry-appender-log)](./LICENSE)
+[![LICENSE](https://img.shields.io/crates/l/opentelemetry-appender-log)](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-appender-log/LICENSE)
 [![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain)
 [![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
 
@@ -29,4 +29,4 @@ of telemetry is intentionally left to other tools.
 
 ## Release Notes
 
-You can find the release notes (changelog) [here](./CHANGELOG.md).
+You can find the release notes (changelog) [here](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-appender-log/CHANGELOG.md).

opentelemetry-appender-tracing/CHANGELOG.md

@@ -5,6 +5,32 @@
 Fixes [1682](https://github.com/open-telemetry/opentelemetry-rust/issues/1682).
 "spec_unstable_logs_enabled" feature now do not suppress logs for other layers.
 
+The special treatment of the "message" field has been extended when recording
+string values. With this change, when a log is emitted with a field named
+"message" (and string value), its value is directly assigned to the LogRecord’s
+body rather than being stored as an attribute named "message". This offers a
+slight performance improvement over previous.
+
+For example, the below will now produce LogRecord with the message value
+populated as LogRecord's body:
+
+```rust
+error!(name: "my-event-name", target: "my-system", event_id = 20, user_name = "otel", user_email = "[email protected]", message = "This is an example message");
+```
+
+Previously, Body was only populated when the below style was used.
+
+```rust
+error!(name: "my-event-name", target: "my-system", event_id = 20, user_name = "otel", user_email = "[email protected]", "This is an example message");
+```
+
+This style, while slightly slower, should still be used when the value is not a
+simple string, but require format arguments as in the below example.
+
+```rust
+error!(name: "my-event-name", target: "my-system", event_id = 20, user_name = "otel", user_email = "[email protected]", "This is an example message with format arguments {} and {}", "foo", "bar");
+```
+
 ## 0.28.1
 
 Released 2025-Feb-12