README.md

BugSplat

Crash and error reporting built for busy developers.

👋 Introduction

node-dump-syms is a thin wrapper around the Mozilla dump_syms crate that allows dump_syms to be added to your project via npm. This package can be invoked via the node-dump-syms command-line command, or used as a library by importing dumpSyms.

✅ Prerequisites

This repo provides prebuilt native addons for node.js 18.x and 20.x on Windows, macOS, and Ubuntu Linux. If you are using a different version of Node.js or a different OS, you will need to build the native addon from source which requires the rust toolchain. Once you have installed rust, you can build the native addon from source by re-running npm i.

If you would like to request a prebuilt binary for a different version of Node.js or a different OS, please open an issue.

🏗️ Installation

Install node-dump-syms as a package dependency.

npm i node-dump-syms

Or install node-dump-syms globally as a command-line tool.

npm i -g node-dump-syms

🧑‍💻 Command

If you installed node-dump-syms globally you can invoke it in via a terminal window.

node-dump-syms /path/to/file.so /output/file.so.sym

The first argument is the path to your binary file. The second argument is the path to write the output sym file.

📚 Library

Import or require dumpSyms.

import { dumpSyms } from 'node-dump-syms'

Call dumpSyms, providing it a path to your binary file, an output path for the .sym file.

dumpSyms('/path/to/file.so', '/output/file.so.sym');

🐛 About

BugSplat is a software crash and error reporting service with support for Qt, Linux, Android and many more. BugSplat automatically captures critical diagnostic data such as stack traces, log files, and other runtime information. BugSplat also provides automated incident notifications, a convenient dashboard for monitoring trends and prioritizing engineering efforts, and integrations with popular development tools to maximize productivity and ship more profitable software.