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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
use std::sync::Arc;
use sentry_core::{sentry_debug, SessionMode};
use crate::defaults::apply_defaults;
use crate::{Client, ClientOptions, Hub};
/// Helper struct that is returned from `init`.
///
/// When this is dropped events are drained with the configured `shutdown_timeout`.
#[must_use = "when the init guard is dropped the send queue is flushed and the \
transport will be shut down and no further events can be sent."]
pub struct ClientInitGuard(Arc<Client>);
impl std::ops::Deref for ClientInitGuard {
type Target = Client;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl ClientInitGuard {
/// Quick check if the client is enabled.
pub fn is_enabled(&self) -> bool {
self.0.is_enabled()
}
}
impl Drop for ClientInitGuard {
fn drop(&mut self) {
if self.is_enabled() {
sentry_debug!("dropping client guard -> disposing client");
} else {
sentry_debug!("dropping client guard (no client to dispose)");
}
// end any session that might be open before closing the client
crate::end_session();
self.0.close(None);
}
}
/// Creates the Sentry client for a given client config and binds it.
///
/// This returns a client init guard that must be kept in scope and that will help the
/// client send events before the application closes. When the guard is
/// dropped, then the transport that was initialized shuts down and no
/// further events can be sent on it.
///
/// If you don't want (or can not) keep the guard around, it's permissible to
/// call `mem::forget` on it.
///
/// # Examples
///
/// ```
/// let _sentry = sentry::init("https://key@sentry.io/1234");
/// ```
///
/// Or if draining on shutdown should be ignored:
/// This is not recommended, as events or session updates that have been queued
/// might be lost.
///
/// ```
/// std::mem::forget(sentry::init("https://key@sentry.io/1234"));
/// ```
///
/// The guard returned can also be inspected to see if a client has been
/// created to enable further configuration:
///
/// ```
/// let sentry = sentry::init(sentry::ClientOptions {
/// release: Some("foo-bar-baz@1.0.0".into()),
/// ..Default::default()
/// });
/// if sentry.is_enabled() {
/// // some other initialization
/// }
/// ```
///
/// This behaves similar to creating a client by calling `Client::from_config`
/// and to then bind it to the hub except it also applies default integrations,
/// a default transport, as well as other options populated from environment
/// variables.
/// For more information about the formats accepted see `Client::from_config`,
/// and `ClientOptions`.
///
/// # Panics
///
/// This will panic when the provided DSN is invalid.
/// If you want to handle invalid DSNs you need to parse them manually by
/// calling `parse` on each of them and handle the error.
pub fn init<C>(opts: C) -> ClientInitGuard
where
C: Into<ClientOptions>,
{
let opts = apply_defaults(opts.into());
let auto_session_tracking = opts.auto_session_tracking;
let session_mode = opts.session_mode;
let client = Arc::new(Client::from(opts));
Hub::with(|hub| hub.bind_client(Some(client.clone())));
if let Some(dsn) = client.dsn() {
sentry_debug!("enabled sentry client for DSN {}", dsn);
} else {
sentry_debug!("initialized disabled sentry client due to disabled or invalid DSN");
}
if auto_session_tracking && session_mode == SessionMode::Application {
crate::start_session()
}
ClientInitGuard(client)
}