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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
use std::any::TypeId;
use std::borrow::Cow;
use std::fmt;
use std::panic::RefUnwindSafe;
use std::sync::Arc;
use std::sync::RwLock;
use std::time::Duration;
use rand::random;
use sentry_types::protocol::v7::SessionUpdate;
use crate::constants::SDK_INFO;
use crate::protocol::{ClientSdkInfo, Event};
use crate::session::SessionFlusher;
use crate::types::{Dsn, Uuid};
use crate::{ClientOptions, Envelope, Hub, Integration, Scope, SessionMode, Transport};
impl<T: Into<ClientOptions>> From<T> for Client {
fn from(o: T) -> Client {
Client::with_options(o.into())
}
}
pub(crate) type TransportArc = Arc<RwLock<Option<Arc<dyn Transport>>>>;
/// The Sentry Client.
///
/// The Client is responsible for event processing and sending events to the
/// sentry server via the configured [`Transport`]. It can be created from a
/// [`ClientOptions`].
///
/// See the [Unified API] document for more details.
///
/// # Examples
///
/// ```
/// sentry::Client::from(sentry::ClientOptions::default());
/// ```
///
/// [`ClientOptions`]: struct.ClientOptions.html
/// [`Transport`]: trait.Transport.html
/// [Unified API]: https://develop.sentry.dev/sdk/unified-api/
pub struct Client {
options: ClientOptions,
transport: TransportArc,
session_flusher: RwLock<Option<SessionFlusher>>,
integrations: Vec<(TypeId, Arc<dyn Integration>)>,
pub(crate) sdk_info: ClientSdkInfo,
}
impl fmt::Debug for Client {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Client")
.field("dsn", &self.dsn())
.field("options", &self.options)
.finish()
}
}
impl Clone for Client {
fn clone(&self) -> Client {
let transport = Arc::new(RwLock::new(self.transport.read().unwrap().clone()));
let session_flusher = RwLock::new(Some(SessionFlusher::new(
transport.clone(),
self.options.session_mode,
)));
Client {
options: self.options.clone(),
transport,
session_flusher,
integrations: self.integrations.clone(),
sdk_info: self.sdk_info.clone(),
}
}
}
impl Client {
/// Creates a new Sentry client from a config.
///
/// # Supported Configs
///
/// The following common values are supported for the client config:
///
/// * `ClientOptions`: configure the client with the given client options.
/// * `()` or empty string: Disable the client.
/// * `&str` / `String` / `&OsStr` / `String`: configure the client with the given DSN.
/// * `Dsn` / `&Dsn`: configure the client with a given DSN.
/// * `(Dsn, ClientOptions)`: configure the client from the given DSN and optional options.
///
/// The `Default` implementation of `ClientOptions` pulls in the DSN from the
/// `SENTRY_DSN` environment variable.
///
/// # Panics
///
/// The `Into<ClientOptions>` implementations can panic for the forms where a DSN needs to be
/// parsed. If you want to handle invalid DSNs you need to parse them manually by calling
/// parse on it and handle the error.
pub fn from_config<O: Into<ClientOptions>>(opts: O) -> Client {
Client::with_options(opts.into())
}
/// Creates a new sentry client for the given options.
///
/// If the DSN on the options is set to `None` the client will be entirely
/// disabled.
pub fn with_options(mut options: ClientOptions) -> Client {
// Create the main hub eagerly to avoid problems with the background thread
// See https://github.com/getsentry/sentry-rust/issues/237
Hub::with(|_| {});
let create_transport = || {
options.dsn.as_ref()?;
let factory = options.transport.as_ref()?;
Some(factory.create_transport(&options))
};
let transport = Arc::new(RwLock::new(create_transport()));
let mut sdk_info = SDK_INFO.clone();
// NOTE: We do not filter out duplicate integrations based on their
// TypeId.
let integrations: Vec<_> = options
.integrations
.iter()
.map(|integration| (integration.as_ref().type_id(), integration.clone()))
.collect();
for (_, integration) in integrations.iter() {
integration.setup(&mut options);
sdk_info.integrations.push(integration.name().to_string());
}
let session_flusher = RwLock::new(Some(SessionFlusher::new(
transport.clone(),
options.session_mode,
)));
Client {
options,
transport,
session_flusher,
integrations,
sdk_info,
}
}
pub(crate) fn get_integration<I>(&self) -> Option<&I>
where
I: Integration,
{
let id = TypeId::of::<I>();
let integration = &self.integrations.iter().find(|(iid, _)| *iid == id)?.1;
integration.as_ref().as_any().downcast_ref()
}
fn prepare_event(
&self,
mut event: Event<'static>,
scope: Option<&Scope>,
) -> Option<Event<'static>> {
// event_id and sdk_info are set before the processors run so that the
// processors can poke around in that data.
if event.event_id.is_nil() {
event.event_id = Uuid::new_v4();
}
if event.sdk.is_none() {
// NOTE: we need to clone here because `Event` must be `'static`
event.sdk = Some(Cow::Owned(self.sdk_info.clone()));
}
if let Some(scope) = scope {
event = match scope.apply_to_event(event) {
Some(event) => event,
None => return None,
};
}
for (_, integration) in self.integrations.iter() {
let id = event.event_id;
event = match integration.process_event(event, &self.options) {
Some(event) => event,
None => {
sentry_debug!("integration dropped event {:?}", id);
return None;
}
}
}
if event.release.is_none() {
event.release = self.options.release.clone();
}
if event.environment.is_none() {
event.environment = self.options.environment.clone();
}
if event.server_name.is_none() {
event.server_name = self.options.server_name.clone();
}
if &event.platform == "other" {
event.platform = "native".into();
}
if let Some(ref func) = self.options.before_send {
sentry_debug!("invoking before_send callback");
let id = event.event_id;
if let Some(processed_event) = func(event) {
event = processed_event;
} else {
sentry_debug!("before_send dropped event {:?}", id);
return None;
}
}
if let Some(scope) = scope {
scope.update_session_from_event(&event);
}
if !self.sample_should_send(self.options.sample_rate) {
None
} else {
Some(event)
}
}
/// Returns the options of this client.
pub fn options(&self) -> &ClientOptions {
&self.options
}
/// Returns the DSN that constructed this client.
pub fn dsn(&self) -> Option<&Dsn> {
self.options.dsn.as_ref()
}
/// Quick check to see if the client is enabled.
///
/// The Client is enabled if it has a valid DSN and Transport configured.
///
/// # Examples
///
/// ```
/// use std::sync::Arc;
///
/// let client = sentry::Client::from(sentry::ClientOptions::default());
/// assert!(!client.is_enabled());
///
/// let dsn = "https://public@example.com/1";
/// let transport = sentry::test::TestTransport::new();
/// let client = sentry::Client::from((
/// dsn,
/// sentry::ClientOptions {
/// transport: Some(Arc::new(transport)),
/// ..Default::default()
/// },
/// ));
/// assert!(client.is_enabled());
/// ```
pub fn is_enabled(&self) -> bool {
self.options.dsn.is_some() && self.transport.read().unwrap().is_some()
}
/// Captures an event and sends it to sentry.
pub fn capture_event(&self, event: Event<'static>, scope: Option<&Scope>) -> Uuid {
if let Some(ref transport) = *self.transport.read().unwrap() {
if let Some(event) = self.prepare_event(event, scope) {
let event_id = event.event_id;
let mut envelope: Envelope = event.into();
// For request-mode sessions, we aggregate them all instead of
// flushing them out early.
if self.options.session_mode == SessionMode::Application {
let session_item = scope.and_then(|scope| {
scope
.session
.lock()
.unwrap()
.as_mut()
.and_then(|session| session.create_envelope_item())
});
if let Some(session_item) = session_item {
envelope.add_item(session_item);
}
}
if let Some(scope) = scope {
for attachment in scope.attachments.iter().cloned() {
envelope.add_item(attachment);
}
}
transport.send_envelope(envelope);
return event_id;
}
}
Default::default()
}
/// Sends the specified [`Envelope`] to sentry.
pub fn send_envelope(&self, envelope: Envelope) {
if let Some(ref transport) = *self.transport.read().unwrap() {
transport.send_envelope(envelope);
}
}
pub(crate) fn enqueue_session(&self, session_update: SessionUpdate<'static>) {
if let Some(ref flusher) = *self.session_flusher.read().unwrap() {
flusher.enqueue(session_update);
}
}
/// Drains all pending events without shutting down.
pub fn flush(&self, timeout: Option<Duration>) -> bool {
if let Some(ref flusher) = *self.session_flusher.read().unwrap() {
flusher.flush();
}
if let Some(ref transport) = *self.transport.read().unwrap() {
transport.flush(timeout.unwrap_or(self.options.shutdown_timeout))
} else {
true
}
}
/// Drains all pending events and shuts down the transport behind the
/// client. After shutting down the transport is removed.
///
/// This returns `true` if the queue was successfully drained in the
/// given time or `false` if not (for instance because of a timeout).
/// If no timeout is provided the client will wait for as long a
/// `shutdown_timeout` in the client options.
pub fn close(&self, timeout: Option<Duration>) -> bool {
drop(self.session_flusher.write().unwrap().take());
let transport_opt = self.transport.write().unwrap().take();
if let Some(transport) = transport_opt {
sentry_debug!("client close; request transport to shut down");
transport.shutdown(timeout.unwrap_or(self.options.shutdown_timeout))
} else {
sentry_debug!("client close; no transport to shut down");
true
}
}
/// Returns a random boolean with a probability defined
/// by rate
pub fn sample_should_send(&self, rate: f32) -> bool {
if rate >= 1.0 {
true
} else {
random::<f32>() <= rate
}
}
}
// Make this unwind safe. It's not out of the box because of the
// `BeforeCallback`s inside `ClientOptions`, and the contained Integrations
impl RefUnwindSafe for Client {}