Merge branch 'master' into lcian/ref/log-default-logs

Author: lcian

CHANGELOG.md

@@ -7,7 +7,7 @@
 - feat(log): support combined LogFilters and RecordMappings ([#914](https://github.com/getsentry/sentry-rust/pull/914)) by @lcian
   - `sentry::integrations::log::LogFilter` has been changed to a `bitflags` struct.
   - It's now possible to map a `log` record to multiple items in Sentry by combining multiple log filters in the filter, e.g. `log::Level::ERROR => LogFilter::Event | LogFilter::Log`.
-  - It's also possible to use `sentry::integrations::log::RecordMapping::Combined` to map a `log` record to multiple items in Sentry.
+  - If using a custom `mapper` instead, it's possible to return a `Vec<sentry::integrations::log::RecordMapping>` to map a `log` record to multiple items in Sentry. 
 
 ### Behavioral changes
 

Cargo.lock

@@ -19,7 +19,7 @@ logs = ["sentry-core/logs"]
 [dependencies]
 sentry-core = { version = "0.43.0", path = "../sentry-core" }
 log = { version = "0.4.8", features = ["std", "kv"] }
-bitflags = "2.0.0"
+bitflags = "2.9.4"
 
 [dev-dependencies]
 sentry = { path = "../sentry", default-features = false, features = ["test"] }

sentry-log/Cargo.toml

@@ -53,13 +53,32 @@
 //! use sentry_log::LogFilter;
 //!
 //! let logger = sentry_log::SentryLogger::new().filter(|md| match md.level() {
-//!     log::Level::Error => LogFilter::Event | LogFilter::Log,
+//!     log::Level::Error => LogFilter::Event,
 //!     log::Level::Warn => LogFilter::Breadcrumb | LogFilter::Log,
 //!     _ => LogFilter::Ignore,
 //! });
 //! ```
 //!
-//! If you're using a custom record mapper instead of a filter, use `RecordMapping::Combined`.
+//! If you're using a custom record mapper instead of a filter, you can return a `Vec<RecordMapping>`
+//! from your mapper function to send multiple items to Sentry from a single log record:
+//!
+//! ```
+//! use sentry_log::{RecordMapping, SentryLogger, event_from_record, breadcrumb_from_record};
+//!
+//! let logger = SentryLogger::new().mapper(|record| {
+//!     match record.level() {
+//!         log::Level::Error => {
+//!             // Send both an event and a breadcrumb for errors
+//!             vec![
+//!                 RecordMapping::Event(event_from_record(record)),
+//!                 RecordMapping::Breadcrumb(breadcrumb_from_record(record)),
+//!             ]
+//!         }
+//!         log::Level::Warn => RecordMapping::Breadcrumb(breadcrumb_from_record(record)).into(),
+//!         _ => RecordMapping::Ignore.into(),
+//!     }
+//! });
+//! ```
 
 #![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]

sentry-log/src/lib.rs

@@ -63,6 +63,12 @@ impl From<Vec<RecordMapping>> for CombinedRecordMapping {
     }
 }
 
+impl From<RecordMapping> for Vec<RecordMapping> {
+    fn from(mapping: RecordMapping) -> Self {
+        vec![mapping]
+    }
+}
+
 /// The default log filter.
 ///
 /// By default, an exception event is captured for `error`, a breadcrumb for
@@ -106,7 +112,7 @@ pub struct SentryLogger<L: log::Log> {
     dest: L,
     filter: Box<dyn Fn(&log::Metadata<'_>) -> LogFilter + Send + Sync>,
     #[allow(clippy::type_complexity)]
-    mapper: Option<Box<dyn Fn(&Record<'_>) -> RecordMapping + Send + Sync>>,
+    mapper: Option<Box<dyn Fn(&Record<'_>) -> Vec<RecordMapping> + Send + Sync>>,
 }
 
 impl Default for SentryLogger<NoopLogger> {
@@ -152,13 +158,15 @@ impl<L: log::Log> SentryLogger<L> {
     /// Sets a custom mapper function.
     ///
     /// The mapper is responsible for creating either breadcrumbs or events
-    /// from [`Record`]s.
+    /// from [`Record`]s. It can return either a single [`RecordMapping`] or
+    /// a `Vec<RecordMapping>` to send multiple items to Sentry from one log record.
     #[must_use]
-    pub fn mapper<M>(mut self, mapper: M) -> Self
+    pub fn mapper<M, T>(mut self, mapper: M) -> Self
     where
-        M: Fn(&Record<'_>) -> RecordMapping + Send + Sync + 'static,
+        M: Fn(&Record<'_>) -> T + Send + Sync + 'static,
+        T: Into<Vec<RecordMapping>>,
     {
-        self.mapper = Some(Box::new(mapper));
+        self.mapper = Some(Box::new(move |record| mapper(record).into()));
         self
     }
 }
@@ -169,7 +177,7 @@ impl<L: log::Log> log::Log for SentryLogger<L> {
     }
 
     fn log(&self, record: &log::Record<'_>) {
-        let items: RecordMapping = match &self.mapper {
+        let items = match &self.mapper {
             Some(mapper) => mapper(record),
             None => {
                 let filter = (self.filter)(record.metadata());
@@ -187,13 +195,12 @@ impl<L: log::Log> log::Log for SentryLogger<L> {
                 if filter.contains(LogFilter::Log) {
                     items.push(RecordMapping::Log(log_from_record(record)));
                 }
-                RecordMapping::Combined(CombinedRecordMapping(items))
+                items
             }
         };
-        let items = CombinedRecordMapping::from(items);
 
-        for item in items.0 {
-            match item {
+        for mapping in items {
+            match mapping {
                 RecordMapping::Ignore => {}
                 RecordMapping::Breadcrumb(breadcrumb) => sentry_core::add_breadcrumb(breadcrumb),
                 RecordMapping::Event(event) => {
@@ -203,11 +210,6 @@ impl<L: log::Log> log::Log for SentryLogger<L> {
                 RecordMapping::Log(log) => {
                     sentry_core::Hub::with_active(|hub| hub.capture_log(log))
                 }
-                RecordMapping::Combined(_) => {
-                    sentry_core::sentry_debug!(
-                        "[SentryLogger] found nested CombinedEventMapping, ignoring"
-                    )
-                }
             }
         }
 

sentry-log/src/logger.rs

@@ -29,7 +29,7 @@ tracing-subscriber = { version = "0.3.20", default-features = false, features =
     "std",
 ] }
 sentry-backtrace = { version = "0.43.0", path = "../sentry-backtrace", optional = true }
-bitflags = "2.0.0"
+bitflags = "2.9.4"
 
 [dev-dependencies]
 log = "0.4"