1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Sentry `slog` Integration.
//!
//! The sentry `slog` integration consists of two parts, the
//! [`SlogIntegration`] which configures how sentry should treat
//! `slog::Record`s, and the [`SentryDrain`], which can be used to create a
//! `slog::Logger`.
//!
//! *NOTE*: This integration currently does not process any `slog::KV` pairs,
//! but support for this will be added in the future.
//!
//! # Examples
//!
//! ```
//! use sentry::{init, ClientOptions};
//! use sentry_slog::{SentryDrain, SlogIntegration};
//!
//! let integration = SlogIntegration::default();
//! let options = ClientOptions::default().add_integration(integration);
//! let _sentry = sentry::init(options);
//!
//! let drain = SentryDrain::new(slog::Discard);
//! let root = slog::Logger::root(drain, slog::o!());
//!
//! # let options = ClientOptions::default().add_integration(SlogIntegration::default());
//! # let events = sentry::test::with_captured_events_options(|| {
//! slog::info!(root, "recorded as breadcrumb");
//! slog::warn!(root, "recorded as regular event");
//! # }, options.clone());
//! # let captured_event = events.into_iter().next().unwrap();
//!
//! assert_eq!(
//!     captured_event.breadcrumbs.as_ref()[0].message.as_deref(),
//!     Some("recorded as breadcrumb")
//! );
//! assert_eq!(
//!     captured_event.message.as_deref(),
//!     Some("recorded as regular event")
//! );
//!
//! # let events = sentry::test::with_captured_events_options(|| {
//! slog::crit!(root, "recorded as exception event");
//! # }, options);
//! # let captured_event = events.into_iter().next().unwrap();
//!
//! assert_eq!(captured_event.exception.len(), 1);
//! ```
//!
//! The integration can also be customized with a `filter`, and a `mapper`:
//!
//! ```
//! use sentry_slog::{exception_from_record, LevelFilter, RecordMapping, SlogIntegration};
//!
//! let integration = SlogIntegration::default()
//!     .filter(|level| match level {
//!         slog::Level::Critical | slog::Level::Error => LevelFilter::Event,
//!         _ => LevelFilter::Ignore,
//!     })
//!     .mapper(|record, kv| RecordMapping::Event(exception_from_record(record, kv)));
//! ```
//!
//! Please not that the `mapper` can override any classification from the
//! previous `filter`.
//!
//! [`SlogIntegration`]: struct.SlogIntegration.html
//! [`SentryDrain`]: struct.SentryDrain.html

#![deny(missing_docs)]
#![deny(unsafe_code)]

mod converters;
mod drain;
mod integration;

pub use converters::*;
pub use drain::SentryDrain;
pub use integration::{default_filter, LevelFilter, RecordMapping, SlogIntegration};