Tauri Plugin Log

This plugin provides configurable interfaces for capturing and storing logs.

Installation

There are three general methods of installation that we can recommend.

1. Pull sources directly from Github using git tags / revision hashes (most secure, good for developement, shown below)
2. Git submodule install this repo in your tauri project and then use file protocol to ingest the source
3. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked). These packages are not yet available.

For more details and usage see the example app. Please note, below in the dependencies you can also lock to a revision/tag in both the Cargo.toml and package.json

Note that the instructions below will install the latest development version, which should not be considered stable. Remember to replace this with a proper package from crates.io when it becomes available.

RUST

src-tauri/Cargo.toml

[dependencies.tauri-plugin-log]
git = "https://github.com/tauri-apps/tauri-plugin-log"
branch = "dev"

WEBVIEW

Install from a tagged release

npm install github:tauri-apps/tauri-plugin-log#dev
# or
yarn add github:tauri-apps/tauri-plugin-log#dev

package.json

  "dependencies": {
    "tauri-plugin-log-api": "github:tauri-apps/tauri-plugin-log#dev",

Usage

RUST

Use in src-tauri/src/main.rs:

use tauri_plugin_log::{LogTarget, LoggerBuilder};
fn main() {
    tauri::Builder::default()
        .plugin(LoggerBuilder::default().targets([
            LogTarget::LogDir,
            LogTarget::Stdout,
            LogTarget::Webview,
        ]).build())
        .build()
        .run();
}

To log from rust code, add the log crate to your cargo.toml:

[dependencies]
log = "^0.4"

Now, you can use the macros provided by the log crate to log messages from your backend. See the docs for more details.

WEBVIEW

import { trace, info, error, attachConsole } from 'tauri-plugin-log-api'

// with LogTarget::Webview enabled this function will print logs to the browser console
const detach = await attachConsole()

trace("Trace")
info("Info")
error("Error")

// detach the browser console from the log stream
detach()