9 releases (5 breaking)

Uses new Rust 2021

0.29.1 Dec 1, 2022
0.29.0 Nov 17, 2022
0.28.0 Nov 4, 2022
0.27.0 Jun 20, 2022
0.24.2 Jan 25, 2022

#267 in Debugging

Download history 811/week @ 2022-08-19 982/week @ 2022-08-26 1068/week @ 2022-09-02 819/week @ 2022-09-09 931/week @ 2022-09-16 1095/week @ 2022-09-23 733/week @ 2022-09-30 1076/week @ 2022-10-07 910/week @ 2022-10-14 1088/week @ 2022-10-21 1039/week @ 2022-10-28 1894/week @ 2022-11-04 1209/week @ 2022-11-11 1302/week @ 2022-11-18 1397/week @ 2022-11-25 2276/week @ 2022-12-02

6,519 downloads per month
Used in sentry

Apache-2.0

190KB
3.5K SLoC

Sentry

Sentry Rust SDK: sentry-tower

Adds support for automatic hub binding for each request received by the Tower server (or client, though usefulness is limited in this case).

This allows breadcrumbs collected during the request handling to land in a specific hub, and avoid having them mixed across requests should a new hub be bound at each request.

Examples

use sentry_tower::NewSentryLayer;

// Compose a Tower service where each request gets its own Sentry hub
let service = ServiceBuilder::new()
    .layer(NewSentryLayer::<Request>::new_from_top())
    .timeout(Duration::from_secs(30))
    .service(tower::service_fn(|req: Request| format!("hello {}", req)));

More customization can be achieved through the new function, such as passing a [Hub] directly.

use sentry::Hub;
use sentry_tower::SentryLayer;

// Create a hub dedicated to web requests
let hub = Arc::new(Hub::with(|hub| Hub::new_from_top(hub)));

// Compose a Tower service
let service = ServiceBuilder::new()
    .layer(SentryLayer::<_, _, Request>::new(hub))
    .timeout(Duration::from_secs(30))
    .service(tower::service_fn(|req: Request| format!("hello {}", req)));

The layer can also accept a closure to return a hub depending on the incoming request.

use sentry::Hub;
use sentry_tower::SentryLayer;

// Compose a Tower service
let hello = Arc::new(Hub::with(|hub| Hub::new_from_top(hub)));
let other = Arc::new(Hub::with(|hub| Hub::new_from_top(hub)));

let service = ServiceBuilder::new()
    .layer(SentryLayer::new(|req: &Request| match req.as_str() {
        "hello" => hello.clone(),
        _ => other.clone(),
    }))
    .timeout(Duration::from_secs(30))
    .service(tower::service_fn(|req: Request| format!("{} world", req)));

When using Tonic, the layer can be used directly by the Tonic stack:

use hello_world::{greeter_server::*, *};
use sentry_tower::NewSentryLayer;

struct GreeterService;

#[tonic::async_trait]
impl Greeter for GreeterService {
    async fn say_hello(
        &self,
        req: Request<HelloRequest>,
    ) -> Result<Response<HelloReply>, Status> {
        let HelloRequest { name } = req.into_inner();
        if name == "world" {
            capture_anyhow(&anyhow!("Trying to greet a planet"));
            return Err(Status::invalid_argument("Cannot greet a planet"));
        }
        Ok(Response::new(HelloReply {
            message: format!("Hello {}", name),
        }))
    }
}

Server::builder()
    .layer(NewSentryLayer::new_from_top())
    .add_service(GreeterServer::new(GreeterService))
    .serve("127.0.0.1:50051".parse().unwrap())
    .await?;

Usage with tower-http

The http feature offers another layer which will attach request details onto captured events, and optionally start a new performance monitoring transaction based on the incoming HTTP headers.

The created transaction will automatically use the request URI as its name. This is sometimes not desirable in case the request URI contains unique IDs or similar. In this case, users should manually override the transaction name in the request handler using the Scope::set_transaction method.

When combining both layers, take care of the ordering of both. For example with tower::ServiceBuilder, always define the Hub layer before the Http one, like so:

let layer = tower::ServiceBuilder::new()
    .layer(sentry_tower::NewSentryLayer::<Request>::new_from_top())
    .layer(sentry_tower::SentryHttpLayer::with_transaction());

Resources

License: Apache-2.0

Dependencies

~3–4.5MB
~116K SLoC