BugSplat-Git / node-dump-syms

npm package for running dump_syms

BugSplat

Crash and error reporting built for busy developers.

👋 Introduction

node-dump-syms is a thin wrapper around the Breakpad dump_syms utility 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.

🏗️ 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 darwin

The first argument is the path to your executable or library file. The second argument is the path to the output file. The third argument is the platform. The platform can be one of the following: darwin, amazonlinux, bullseye.

For additional platform support, please open an issue.

📚 Library

Import or require dumpSyms.

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

Await a call to dumpSyms, providing it a path to your executable or library file, an output path for the .sym file, and the dump_syms platform binary you'd like to use.

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

You can also call dumpSymsSync to perform the same operation synchronously.

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

🐛 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.