Auto merge of #4115 - Turbo87:sentry-metadata, r=JohnTitor

Sentry: Improve metadata collection

The `request.id` tag and the "custom metadata" are currently only assigned to the Sentry scope in the `after()` method of the `LogRequest` middleware. This means that for any manual `sentry::capture_exception()` call these fields will not be set correctly.

This PR moves the `configure_scope()` calls into the `before()` method and `add_custom_metadata()` function instead. This allows us to send the fields to Sentry for error reports as soon as they are available.

Author: bors

src/middleware/log_request.rs

@@ -21,6 +21,15 @@ impl Middleware for LogRequests {
     fn before(&self, req: &mut dyn RequestExt) -> BeforeResult {
         let path = OriginalPath(req.path().to_string());
         req.mut_extensions().insert(path);
+
+        if let Some(request_id) = req
+            .headers()
+            .get("x-request-id")
+            .and_then(|value| value.to_str().ok())
+        {
+            sentry::configure_scope(|scope| scope.set_tag("request.id", request_id));
+        }
+
         Ok(())
     }
 
@@ -86,6 +95,8 @@ pub fn add_custom_metadata<V: Display>(req: &mut dyn RequestExt, key: &'static s
         metadata.entries.push((key, value.to_string()));
         req.mut_extensions().insert(metadata);
     }
+
+    sentry::configure_scope(|scope| scope.set_extra(key, value.to_string().into()));
 }
 
 fn report_to_sentry(req: &dyn RequestExt, res: &AfterResult, response_time: u64) {
@@ -101,14 +112,6 @@ fn report_to_sentry(req: &dyn RequestExt, res: &AfterResult, response_time: u64)
             scope.set_user(Some(user));
         }
 
-        if let Some(request_id) = req
-            .headers()
-            .get("x-request-id")
-            .and_then(|value| value.to_str().ok())
-        {
-            scope.set_tag("request.id", request_id);
-        }
-
         {
             let status = res
                 .as_ref()
@@ -119,12 +122,6 @@ fn report_to_sentry(req: &dyn RequestExt, res: &AfterResult, response_time: u64)
         }
 
         scope.set_extra("Response time [ms]", response_time.into());
-
-        if let Some(metadata) = req.extensions().find::<CustomMetadata>() {
-            for (key, value) in &metadata.entries {
-                scope.set_extra(key, value.to_string().into());
-            }
-        }
     });
 }