Auto merge of #3988 - Turbo87:sentry-conduit, r=locks

Use `sentry-conduit` middleware for error reporting

The implementation of this crate is largely based on the Sentry middleware code in crates.io and the implementation of sentry-actix. It has several advantages over the implementation that we currently use:

- Automatic per-request scoping of errors, breadcrumbs and other data
- Optional release health tracking
- Reporting of error stack traces, if available
- `transaction` field support (aka. the route pattern that was used by conduit-router)

see https://github.com/Turbo87/sentry-conduit

Author: bors

Cargo.lock

@@ -74,6 +74,7 @@ reqwest = { version = "0.11", features = ["blocking", "gzip", "json"] }
 scheduled-thread-pool = "0.2.0"
 semver = { version = "1.0.3", features = ["serde"] }
 sentry = { version = "0.23.0", features = ["tracing"] }
+sentry-conduit = "0.2.0"
 serde = { version = "1.0.0", features = ["derive"] }
 serde_json = "1.0.0"
 sha2 = "0.9"

Cargo.toml

@@ -32,6 +32,7 @@ use conduit_conditional_get::ConditionalGet;
 use conduit_cookie::{Middleware as Cookie, SessionMiddleware};
 use conduit_middleware::MiddlewareBuilder;
 use conduit_router::RouteBuilder;
+use sentry_conduit::SentryMiddleware;
 
 use std::env;
 use std::sync::Arc;
@@ -46,6 +47,7 @@ pub fn build_middleware(app: Arc<App>, endpoints: RouteBuilder) -> MiddlewareBui
     if env != Env::Test {
         m.add(ensure_well_formed_500::EnsureWellFormed500);
         m.add(log_request::LogRequests::default());
+        m.around(SentryMiddleware::default());
     }
 
     if env == Env::Development {

src/middleware.rs

@@ -4,17 +4,14 @@
 use super::prelude::*;
 use crate::util::request_header;
 
-use conduit::{header, Host, RequestExt, Scheme, StatusCode};
+use conduit::{header, RequestExt, StatusCode};
 use conduit_cookie::RequestSession;
-use sentry::Level;
 
 use std::fmt::{self, Display, Formatter};
 use std::time::{SystemTime, UNIX_EPOCH};
 
 const SLOW_REQUEST_THRESHOLD_MS: u64 = 1000;
 
-const FILTERED_HEADERS: &[&str] = &["Authorization", "Cookie", "X-Real-Ip", "X-Forwarded-For"];
-
 #[derive(Default)]
 pub(super) struct LogRequests();
 
@@ -92,28 +89,7 @@ pub fn add_custom_metadata<V: Display>(req: &mut dyn RequestExt, key: &'static s
 }
 
 fn report_to_sentry(req: &dyn RequestExt, res: &AfterResult, response_time: u64) {
-    let (message, level) = match res {
-        Err(e) => (e.to_string(), Level::Error),
-        Ok(_) => return,
-    };
-
-    let config = |scope: &mut sentry::Scope| {
-        let method = Some(req.method().as_str().to_owned());
-
-        let scheme = match req.scheme() {
-            Scheme::Http => "http",
-            Scheme::Https => "https",
-        };
-
-        let host = match req.host() {
-            Host::Name(name) => name.to_owned(),
-            Host::Socket(addr) => addr.to_string(),
-        };
-
-        let path = &req.extensions().find::<OriginalPath>().unwrap().0;
-
-        let url = format!("{}://{}{}", scheme, host, path).parse().ok();
-
+    sentry::configure_scope(|scope| {
         {
             let id = req.session().get("user_id").map(|str| str.to_string());
 
@@ -125,29 +101,6 @@ fn report_to_sentry(req: &dyn RequestExt, res: &AfterResult, response_time: u64)
             scope.set_user(Some(user));
         }
 
-        {
-            let headers = req
-                .headers()
-                .iter()
-                .filter(|(k, _v)| !FILTERED_HEADERS.iter().any(|name| k == name))
-                .map(|(k, v)| (k.to_string(), v.to_str().unwrap_or_default().to_string()))
-                .collect();
-
-            let sentry_req = sentry::protocol::Request {
-                url,
-                method,
-                headers,
-                ..Default::default()
-            };
-
-            scope.add_event_processor(Box::new(move |mut event| {
-                if event.request.is_none() {
-                    event.request = Some(sentry_req.clone());
-                }
-                Some(event)
-            }));
-        }
-
         if let Some(request_id) = req
             .headers()
             .get("x-request-id")
@@ -172,9 +125,7 @@ fn report_to_sentry(req: &dyn RequestExt, res: &AfterResult, response_time: u64)
                 scope.set_extra(key, value.to_string().into());
             }
         }
-    };
-
-    sentry::with_scope(config, || sentry::capture_message(&message, level));
+    });
 }
 
 #[cfg(test)]

src/middleware/log_request.rs

@@ -23,9 +23,11 @@ pub fn init() -> ClientInitGuard {
     let release = dotenv::var("HEROKU_SLUG_COMMIT").ok().map(Into::into);
 
     let opts = ClientOptions {
+        auto_session_tracking: true,
         dsn,
         environment,
         release,
+        session_mode: sentry::SessionMode::Request,
         ..Default::default()
     };