sentry_log/
converters.rs

1use sentry_core::protocol::{Event, Value};
2#[cfg(feature = "logs")]
3use sentry_core::protocol::{Log, LogAttribute, LogLevel};
4use sentry_core::{Breadcrumb, Level};
5use std::collections::BTreeMap;
6#[cfg(feature = "logs")]
7use std::time::SystemTime;
8
9/// Converts a [`log::Level`] to a Sentry [`Level`], used for [`Event`] and [`Breadcrumb`].
10pub fn convert_log_level(level: log::Level) -> Level {
11    match level {
12        log::Level::Error => Level::Error,
13        log::Level::Warn => Level::Warning,
14        log::Level::Info => Level::Info,
15        log::Level::Debug | log::Level::Trace => Level::Debug,
16    }
17}
18
19/// Converts a [`log::Level`] to a Sentry [`LogLevel`], used for [`Log`].
20#[cfg(feature = "logs")]
21pub fn convert_log_level_to_sentry_log_level(level: log::Level) -> LogLevel {
22    match level {
23        log::Level::Error => LogLevel::Error,
24        log::Level::Warn => LogLevel::Warn,
25        log::Level::Info => LogLevel::Info,
26        log::Level::Debug => LogLevel::Debug,
27        log::Level::Trace => LogLevel::Trace,
28    }
29}
30
31/// Visitor to extract key-value pairs from log records
32#[derive(Default)]
33struct AttributeVisitor {
34    json_values: BTreeMap<String, Value>,
35}
36
37impl AttributeVisitor {
38    fn record<T: Into<Value>>(&mut self, key: &str, value: T) {
39        self.json_values.insert(key.to_owned(), value.into());
40    }
41}
42
43impl log::kv::VisitSource<'_> for AttributeVisitor {
44    fn visit_pair(
45        &mut self,
46        key: log::kv::Key,
47        value: log::kv::Value,
48    ) -> Result<(), log::kv::Error> {
49        let key = key.as_str();
50
51        if let Some(value) = value.to_borrowed_str() {
52            self.record(key, value);
53        } else if let Some(value) = value.to_u64() {
54            self.record(key, value);
55        } else if let Some(value) = value.to_f64() {
56            self.record(key, value);
57        } else if let Some(value) = value.to_bool() {
58            self.record(key, value);
59        } else {
60            self.record(key, format!("{value:?}"));
61        };
62
63        Ok(())
64    }
65}
66
67fn extract_record_attributes(record: &log::Record<'_>) -> AttributeVisitor {
68    let mut visitor = AttributeVisitor::default();
69    let _ = record.key_values().visit(&mut visitor);
70    visitor
71}
72
73/// Creates a [`Breadcrumb`] from a given [`log::Record`].
74pub fn breadcrumb_from_record(record: &log::Record<'_>) -> Breadcrumb {
75    let visitor = extract_record_attributes(record);
76
77    Breadcrumb {
78        ty: "log".into(),
79        level: convert_log_level(record.level()),
80        category: Some(record.target().into()),
81        message: Some(record.args().to_string()),
82        data: visitor.json_values,
83        ..Default::default()
84    }
85}
86
87/// Creates an [`Event`] from a given [`log::Record`].
88pub fn event_from_record(record: &log::Record<'_>) -> Event<'static> {
89    let visitor = extract_record_attributes(record);
90    let attributes = visitor.json_values;
91
92    let mut contexts = BTreeMap::new();
93
94    let mut metadata_map = BTreeMap::new();
95    metadata_map.insert("logger.target".into(), record.target().into());
96    if let Some(module_path) = record.module_path() {
97        metadata_map.insert("logger.module_path".into(), module_path.into());
98    }
99    if let Some(file) = record.file() {
100        metadata_map.insert("logger.file".into(), file.into());
101    }
102    if let Some(line) = record.line() {
103        metadata_map.insert("logger.line".into(), line.into());
104    }
105    contexts.insert(
106        "Rust Log Metadata".to_string(),
107        sentry_core::protocol::Context::Other(metadata_map),
108    );
109
110    if !attributes.is_empty() {
111        contexts.insert(
112            "Rust Log Attributes".to_string(),
113            sentry_core::protocol::Context::Other(attributes),
114        );
115    }
116
117    Event {
118        logger: Some(record.target().into()),
119        level: convert_log_level(record.level()),
120        message: Some(record.args().to_string()),
121        contexts,
122        ..Default::default()
123    }
124}
125
126/// Creates an exception [`Event`] from a given [`log::Record`].
127pub fn exception_from_record(record: &log::Record<'_>) -> Event<'static> {
128    // TODO: Exception records in Sentry need a valid type, value and full stack trace to support
129    // proper grouping and issue metadata generation. log::Record does not contain sufficient
130    // information for this. However, it may contain a serialized error which we can parse to emit
131    // an exception record.
132    event_from_record(record)
133}
134
135/// Creates a [`Log`] from a given [`log::Record`].
136#[cfg(feature = "logs")]
137pub fn log_from_record(record: &log::Record<'_>) -> Log {
138    let visitor = extract_record_attributes(record);
139
140    let mut attributes: BTreeMap<String, LogAttribute> = visitor
141        .json_values
142        .into_iter()
143        .map(|(key, val)| (key, val.into()))
144        .collect();
145
146    attributes.insert("logger.target".into(), record.target().into());
147    if let Some(module_path) = record.module_path() {
148        attributes.insert("logger.module_path".into(), module_path.into());
149    }
150    if let Some(file) = record.file() {
151        attributes.insert("logger.file".into(), file.into());
152    }
153    if let Some(line) = record.line() {
154        attributes.insert("logger.line".into(), line.into());
155    }
156
157    attributes.insert("sentry.origin".into(), "auto.logger.log".into());
158
159    Log {
160        level: convert_log_level_to_sentry_log_level(record.level()),
161        body: format!("{}", record.args()),
162        trace_id: None,
163        timestamp: SystemTime::now(),
164        severity_number: None,
165        attributes,
166    }
167}
sentry_log/converters.rs

sentry_log/
converters.rs
