BugSplat

Crash and error reporting built for busy developers.

android-dump-syms

Leverage globs and Mozilla's dump_syms to create .sym files from Android/Linux binaries.

Command Line

1. Install this package globally npm i -g @bugsplat/android-dump-syms
2. Run symbol-upload with -h to see the latest usage information:

bobby@BugSplat % ~ % android-dump-syms -h

@bugsplat/android-dump-syms

  android-dump-syms contains a command line utility and a library to help you
  generate sym files from Android binaries via the BugSplat API.

Usage

  -f, --files string (optional)       Glob pattern that specifies a set of android binary files to upload Defaults to '**/*.so'

  -d, --directory string (optional)   Path of the base directory used to search for symbol files. This value will be combined with the --files glob. Defaults to '.'

  -h, --help                          Print this usage guide.

Example

  android-dump-syms glob-for-android-binary-files -d directory-to-search

Links

  🐛 https://bugsplat.com

  💻 https://github.com/BugSplat-Git/android-dump-syms

  💌 [email protected]

3. Run android-dump-syms passing it a path or glob pattern to locate Android binary files to convert to .sym files.

API

1. Install this package locally npm i @bugsplat/android-dump-syms.
2. Import DumpSyms from @bugsplat/android-dump-syms.

import { DumpSyms } from "@bugsplat/android-dump-syms";

3. Create a new instance of DumpSyms.

const dumpSyms = new DumpSyms();

4. Call run, passing the function a path to an Android .so file, and optionally an output file path.

const { stderr } = await dumpSyms.run(inputPath, outputPath);

If you've done everything correctly the resulting file will resemble the following:

MODULE Linux arm64 9E957A33B0CDD8A32F80AD65D75601950 MyUnrealCrasher-arm64
INFO CODE_ID 337A959ECDB0A3D82F80AD65D756019583483F98
FILE 0 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/Core/Public/Containers/ContainerAllocationPolicies.h
FILE 1 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/Core/Public/Delegates/DelegateInstancesImpl.h
FILE 2 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/Core/Public/Modules/ModuleManager.h
FILE 3 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/Core/Public/Templates/Function.h
FILE 4 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h
FILE 5 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/CoreUObject/Public/UObject/Object.h
FILE 6 /Users/Shared/Epic Games/UE_5.2/Engine/Source/Runtime/CoreUObject/Public/UObject/UObjectBase.h

Thanks for using BugSplat!