3 releases (breaking)

0.3.0 Apr 12, 2024
0.2.0 Jul 1, 2023
0.1.0 Jun 21, 2022

#467 in Debugging

Download history 178/week @ 2024-02-25 210/week @ 2024-03-03 1242/week @ 2024-03-10 205/week @ 2024-03-17 118/week @ 2024-03-24 120/week @ 2024-03-31 180/week @ 2024-04-07 101/week @ 2024-04-14 65/week @ 2024-04-21 158/week @ 2024-04-28 27/week @ 2024-05-05 20/week @ 2024-05-12 36/week @ 2024-05-19 32/week @ 2024-05-26 53/week @ 2024-06-02 18/week @ 2024-06-09

141 downloads per month

MIT/Apache

275KB
148 lines

sentry-tauri

A Tauri Plugin for improved Sentry support.

It's perfectly reasonable to use Sentry's Rust and browser SDKs separately in a Tauri app. However, this plugin passes browser breadcrumbs and events through the Rust backend which has a number of advantages:

  • Browser events are enriched with Rust, OS and device context
    • Events from both Rust and browser will have the same context for filtering
  • Breadcrumbs are merged from both the Rust and browser SDKs
    • See what was happening in the Rust backend and the browser frontend at the time of the event

Installation

This example also shows usage of sentry_rust_minidump which allows you to capture minidumps for native crashes from a separate crash reporting process.

Add the required dependencies in Cargo.toml:

[dependencies]
sentry-tauri = "0.2"

sentry and sentry-rust-minidump are re-exported by sentry-tauri so you don't need to add them as dependencies.

fn main() {
    let client = sentry_tauri::sentry::init((
        "__YOUR_DSN__",
        sentry_tauri::sentry::ClientOptions {
            release: sentry_tauri::sentry::release_name!(),
            ..Default::default()
        },
    ));

    // Everything before here runs in both app and crash reporter processes
    let _guard = sentry_tauri::minidump::init(&client);
    // Everything after here runs in only the app process

    tauri::Builder::default()
        .plugin(sentry_tauri::plugin())
        .run(tauri::generate_context!())
        .expect("error while running tauri app");
}

The Plugin

  • Injects and initialises @sentry/browser in every web-view
  • Includes beforeSend and beforeBreadcrumb hooks that intercept events and breadcrumbs and passes them to the Rust SDK via the Tauri invoke API
  • Tauri + serde + existing Sentry Rust types = Deserialisation mostly Just Works™️

Example App

Clone this repository and install dependencies:

> yarn install

In examples/basic-app/src-tauri/src/main.rs replace the DSN with your DSN

Run in development mode:

> yarn example

Dependencies

~25–68MB
~1M SLoC