Skip to content

Use sentry-conduit middleware for error reporting #3988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 2 additions & 0 deletions src/middleware.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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 {
Expand Down
55 changes: 3 additions & 52 deletions src/middleware/log_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down Expand Up @@ -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());

Expand All @@ -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")
Expand All @@ -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)]
Expand Down
2 changes: 2 additions & 0 deletions src/sentry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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()
};

Expand Down