bugsplat-git / node-minidump-stackwalk

Node.js wrapper for calling Breakpad's minidump-stackwalk

BugSplat

Crash and error reporting built for busy developers.

👋 Introduction

node-minidump-stackwalk is a thin wrapper around the Breakpad minidump_stackwalk utility that allows minidump_stackwalk to be added to your project via npm. This package can be invoked via the node-minidump-stackwalk command-line command, or used as a library by importing minidumpStackwalk.

🏗️ Installation

Install node-minidump-stackwalk as a package dependency.

npm i node-minidump-stackwalk

Or install node-minidump-stackwalk globally as a command-line tool.

npm i -g node-minidump-stackwalk

🧑‍💻 Command

If you installed node-minidump-stackwalk globally you can invoke it in via a terminal window.

node-minidump-stackwalk <minidump-file-path> <symbol-paths> [-p <platform>] [-m] [-s] [-c] [-b] [-v]

The first argument is the path to your minidump file. The second argument is a path or array of paths to search for sym files. Specify a platform with -p <platform>. Valid platforms are darwin, and bullseye. You can also specify the -m, -s, -c, and -b minidump_stackwalk arguments. The -v argument will print stderr to the terminal.

For additional platform support, please open an issue.

📚 Library

Import or require minidumpStackwalk.

import { minidumpStackwalk, minidumpStackwalkSync } from 'node-minidump-stackwalk'

Await a call to minidumpStackwalk, providing it a path to your minidump file, and an array of symbol folder paths, and optionally the platform you're running on as well as options to forward to the minidump_stackwalk executable.

const options: MinidumpStackwalkOptions = {
  machineReadable: true,
  stackContents: false,
  dumpingThreadOnly: false,
  threadBrief: falst
};

await minidumpStackwalk('/path/to/minidump.dmp', ['/path/to/symbols'], 'darwin', options);

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

minidumpStackwalkSync('/path/to/minidump.dmp', ['/path/to/symbols'], 'darwin', options);

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