bugsplat-git / elfy

BugSplat

Crash and error reporting built for busy developers.

elfy

A tiny utility for parsing ELF/SELF files.

Usage

1. Install this package

npm i @bugsplat/elfy

2. Create an instance of ElfFile using the async static factory function create. The ElfFile class implements Disposable so you should use a using statement in TypeScript 5.2+ or call dispose manually.

import { ElfFile } from '@bugsplat/elfy';
using elfFile = await ElfFile.create('path/to/elf/file');
// or
const elfFile = await ElfFile.create('path/to/elf/file');
try {
    ...
} finally {
    elfFile.dispose();
}

3. Read the contents of a section using readSection. This method throws if the section does not exist.

const contents: Buffer = await elfFile.readSection('.note.gnu.build-id');

4. You can also safely read the contents of a section using tryReadSection.

const { success, section } = await elfFile.tryReadSection('.note.gnu.build-id');

🐛 About

BugSplat is a software crash and error reporting service with support for game engines like Unreal Engine, and supports platforms such as PlayStation, Xbox 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.