feat: Added debug logs (#90)

Author: mitsuhiko

Cargo.toml

@@ -22,6 +22,7 @@ with_backtrace = ["backtrace", "regex"]
 with_panic = ["with_backtrace"]
 with_failure = ["failure", "with_backtrace"]
 with_log = ["log", "with_backtrace"]
+with_debug_to_log = ["log"]
 with_env_logger = ["with_log", "env_logger"]
 with_error_chain = ["error-chain", "with_backtrace"]
 with_device_info = ["libc", "hostname", "uname", "with_client_implementation"]

src/client.rs

@@ -92,6 +92,10 @@ pub struct ClientOptions {
     /// The timeout on client drop for draining events on shutdown.
     pub shutdown_timeout: Duration,
     /// Enables debug mode.
+    ///
+    /// In debug mode debug information is printed to stderr to help you understand what
+    /// sentry is doing.  When the `with_debug_to_log` flag is enabled Sentry will instead
+    /// log to the `sentry` logger independently of this flag with the `Debug` level.
     pub debug: bool,
     /// Attaches stacktraces to messages.
     pub attach_stacktrace: bool,

src/lib.rs

@@ -97,6 +97,8 @@
 //! * `with_device_info`: enables the device info context
 //! * `with_rust_info`: enables the rust compiler info context
 //! * `with_debug_meta`: enables debug meta support (permits server side symbolication)
+//! * `with_debug_to_log`: when enabled sentry will debug log to a debug log at all times
+//!   instead of printing to stderr when debug is enabled on the hub.
 //!
 //! additional features:
 //!
@@ -144,7 +146,8 @@ extern crate failure;
 #[cfg(feature = "with_error_chain")]
 extern crate error_chain;
 
-#[cfg(feature = "with_log")]
+#[cfg(any(feature = "with_log", feature = "with_debug_to_log"))]
+#[cfg_attr(feature = "with_debug_to_log", macro_use)]
 extern crate log;
 
 #[cfg(feature = "with_env_logger")]

src/macros.rs

@@ -40,12 +40,17 @@ macro_rules! with_client_impl {
 macro_rules! sentry_debug {
     ($($arg:tt)*) => {
         with_client_impl! {{
-            $crate::Hub::with(|hub| {
-                if hub.client().map_or(false, |c| c.options().debug) {
-                    eprint!("[sentry] ");
-                    eprintln!($($arg)*);
-                }
-            });
+            #[cfg(feature = "with_debug_to_log")] {
+                debug!(target: "sentry", $($arg)*);
+            }
+            #[cfg(not(feature = "with_debug_to_log"))] {
+                $crate::Hub::with(|hub| {
+                    if hub.client().map_or(false, |c| c.options().debug) {
+                        eprint!("[sentry] ");
+                        eprintln!($($arg)*);
+                    }
+                });
+            }
         }}
     }
 }

src/transport.rs

@@ -144,26 +144,36 @@ fn spawn_http_sender(
             }
 
             // while we are disabled due to rate limits, skip
-            if disabled > SystemTime::now() {
+            let now = SystemTime::now();
+            if let Ok(time_left) = disabled.duration_since(now) {
+                sentry_debug!(
+                    "Skipping event send because we're disabled due to rate limits for {}s",
+                    time_left.as_secs()
+                );
                 continue;
             }
 
-            if let Ok(resp) = client
+            match client
                 .post(url.as_str())
                 .json(&event)
                 .header("X-Sentry-Auth", dsn.to_auth(Some(&user_agent)).to_string())
                 .send()
             {
-                if resp.status() == 429 {
-                    if let Some(retry_after) = resp
-                        .headers()
-                        .get(RETRY_AFTER)
-                        .and_then(|x| x.to_str().ok())
-                        .and_then(parse_retry_after)
-                    {
-                        disabled = retry_after;
+                Ok(resp) => {
+                    if resp.status() == 429 {
+                        if let Some(retry_after) = resp
+                            .headers()
+                            .get(RETRY_AFTER)
+                            .and_then(|x| x.to_str().ok())
+                            .and_then(parse_retry_after)
+                        {
+                            disabled = retry_after;
+                        }
                     }
                 }
+                Err(err) => {
+                    sentry_debug!("Failed to send event: {}", err);
+                }
             }
 
             let mut size = queue_size.lock().unwrap();