https://github.com/aptabase/tauri-plugin-aptabase
Tauri Plugin for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps
https://github.com/aptabase/tauri-plugin-aptabase
analytics aptabase privacy tauri
Last synced: about 1 month ago
JSON representation
Tauri Plugin for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps
- Host: GitHub
- URL: https://github.com/aptabase/tauri-plugin-aptabase
- Owner: aptabase
- License: mit
- Created: 2023-03-23T14:41:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T03:59:33.000Z (about 1 year ago)
- Last Synced: 2024-10-29T22:56:39.636Z (7 months ago)
- Topics: analytics, aptabase, privacy, tauri
- Language: Rust
- Homepage: https://aptabase.com
- Size: 634 KB
- Stars: 35
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tauri - tauri-plugin-aptabase - Privacy-first and minimalist analytics for desktop and mobile apps. (Development / Plugins)
README
# Tauri Plugin for Aptabase
This plugin allows you to instrument your app with events that can be analyzed in Aptabase, an Open Source, Privacy-First, and Simple Analytics for Mobile, Desktop, and Web Apps.
## Install
Install the Core plugin by adding the following to your `Cargo.toml` file:
`src-tauri/Cargo.toml`
```toml
[dependencies]
tauri-plugin-aptabase = "1.0.0"
```
```toml
[dependencies]
tauri-plugin-aptabase = { git = "https://github.com/aptabase/tauri-plugin-aptabase" }
```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager
```bash
npm add @aptabase/tauri
```
```bash
npm add https://github.com/aptabase/tauri-plugin-aptabase
```
## Usage
First, you need to get your `App Key` from Aptabase, you can find it in the `Instructions` menu on the left side menu.
Then register the plugin with Tauri:
`src-tauri/src/main.rs`
```rust
#[tokio::main]
async fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_aptabase::Builder::new("").build()) // 👈 this is where you enter your App Key
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
```
And finally add `aptabase:allow-track-event` to your list Access Control List.
You can then start sending events from Rust by importing the `tauri_plugin_aptabase::EventTracker` trait and calling the `track_event` method on `App`, `AppHandle` or `Window`.
As an example, you can add `app_started` and `app_exited` events like this:
```rust
use tauri_plugin_aptabase::EventTracker;
#[tokio::main]
async fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_aptabase::init("".into()))
.setup(|app| {
app.track_event("app_started", None);
Ok(())
})
.build(tauri::generate_context!())
.expect("error while running tauri application")
.run(|handler, event| match event {
tauri::RunEvent::Exit { .. } => {
handler.track_event("app_exited", None);
handler.flush_events_blocking();
}
_ => {}
})
}
```
The `trackEvent` function is also available through the JavaScript guest bindings:
```js
import { trackEvent } from "@aptabase/tauri";
trackEvent("save_settings") // An event with no properties
trackEvent("screen_view", { name: "Settings" }) // An event with a custom property
```
A few important notes:
1. The plugin will automatically enhance the event with some useful information, like the OS, the app version, and other things.
2. You're in control of what gets sent to Aptabase. This plugin does not automatically track any events, you need to call `trackEvent` manually.
- Because of this, it's generally recommended to at least track an event at startup
3. You do not need to await for the `trackEvent` function, it'll run in the background.
3. Only strings and numbers values are allowed on custom properties
## Providing the APTABASE_KEY via .env
It's possible to load the APTABASE_KEY from a .env file at compile time using the `dotenvy_macro` crate. The `.env` file needs to be
in the `src-tauri` directory for the `dotevny_macro` crate to find it properly.
Add the `use` declaration to where you are building the tauri app (likely `lib.rs` for Tauri v2), and then call it where you would put the key.
```rust
use tauri_plugin_aptabase::EventTracker;
use dotenvy_macro::dotenv;
#[cfg_attr(mobile, tauri::mobile_entry_point)]
/// This function sets up and runs a Rust application using the Tauri framework, with various plugins
/// and event handlers.
pub fn run() {
tauri::Builder::default()
.build(tauri::generate_context!())
.plugin(tauri_plugin_aptabase::Builder::new(dotenv!("APTABASE_KEY")).build())
.expect("Error when building tauri app")
.run(|handler, event| match event {
tauri::RunEvent::Exit { .. } => {
handler.track_event("app_exited", None);
handler.flush_events_blocking();
}
tauri::RunEvent::Ready { .. } => {
handler.track_event("app_started", None);
}
_ => {}
});
}
```