Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hexhacking/xCrash

🔥 xCrash provides the Android app with the ability to capture java crash, native crash and ANR. No root permission or any system permissions are required.
https://github.com/hexhacking/xCrash

android anr apm block crash crash-reporting exception handler java jni native reporter reporting

Last synced: about 2 months ago
JSON representation

🔥 xCrash provides the Android app with the ability to capture java crash, native crash and ANR. No root permission or any system permissions are required.

Host: GitHub
URL: https://github.com/hexhacking/xCrash
Owner: hexhacking
License: other
Created: 2020-10-09T11:41:40.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2022-04-25T17:07:34.000Z (over 2 years ago)
Last Synced: 2024-06-01T20:41:42.058Z (4 months ago)
Topics: android, anr, apm, block, crash, crash-reporting, exception, handler, java, jni, native, reporter, reporting
Language: C
Homepage:
Size: 2.81 MB
Stars: 214
Watchers: 10
Forks: 22
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        


# HexHacking xCrash

![](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)

![](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)

![](https://img.shields.io/badge/release-3.0.0-red.svg?style=flat)

![](https://img.shields.io/badge/Android-4.1%20--%2011-blue.svg?style=flat)

![](https://img.shields.io/badge/arch-armeabi--v7a%20%7C%20arm64--v8a%20%7C%20x86%20%7C%20x86__64-blue.svg?style=flat)

HexHacking xCrash is a branch version of xCrash, and its version number starts from 3.0.0. Whether in terms of architecture or technical details, HexHacking xCrash will be more radical.

xCrash provides the Android app with the ability to capture java crash, native crash and ANR. No root permission or any system permissions are required.



xCrash can generate a tombstone file (similar format as Android system's tombstone file) in the directory you specified when the app process crashes or ANRs.

[README 中文版](README.zh-CN.md)

## Features

* Support Android 4.1 - 11 (API level 16 - 30).

* Support armeabi-v7a, arm64-v8a, x86 and x86_64.

* Capturing java crash, native crash and ANR.

* Dumping detailed statistics about process, threads, memory, FD and network.

* Setting which thread's info should be dumped via regular expressions.

* Do not require root permission or any system permissions.

## Tombstone File Previews

* [java crash](doc/tombstone_java.txt)

* [native crash (armeabi-v7a)](doc/tombstone_native_armeabi-v7a.txt)

* [native crash (arm64-v8a)](doc/tombstone_native_arm64-v8a.txt)

* [native crash (x86)](doc/tombstone_native_x86.txt)

* [native crash (x86_64)](doc/tombstone_native_x86_64.txt)

* [ANR (armeabi-v7a)](doc/tombstone_anr_armeabi-v7a.txt)

* [ANR (arm64-v8a)](doc/tombstone_anr_arm64-v8a.txt)

* [ANR (x86)](doc/tombstone_anr_x86.txt)

* [ANR (x86_64)](doc/tombstone_anr_x86_64.txt)

## Overview Maps

### Architecture



### Capture Native Crash



### Capture ANR



## Usage

#### 1. Add dependency.

```Gradle

dependencies {

    implementation 'io.hexhacking.xcrash:xcrash-android-lib:3.0.0'

}

```

#### 2. Specify one or more ABI(s) you need.

```Gradle

android {

    defaultConfig {

        ndk {

            abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'

        }

    }

}

```

#### 3. Initialize xCrash.

> Java

```Java

public class MyCustomApplication extends Application {

    @Override

    protected void attachBaseContext(Context base) {

        super.attachBaseContext(base);

        

        xcrash.XCrash.init(this);

    }

}

```

> Kotlin

```Kotlin

class MyCustomApplication : Application() {

    override fun attachBaseContext(base: Context) {

        super.attachBaseContext(base)

        xcrash.XCrash.init(this)

    }

}

```

Tombstone files will be written to `Context#getFilesDir() + "/tombstones"` directory by default. (usually in: `/data/data/PACKAGE_NAME/files/tombstones`)

There is a more practical and complex sample app in the [xcrash_sample](xcrash_sample) folder.

## Support

* [GitHub Issues](https://github.com/hexhacking/xCrash/issues)

* [GitHub Discussions](https://github.com/hexhacking/xCrash/discussions)

* [Telegram Public Group](https://t.me/android_native_geeks)

## Contributing

[xCrash Contributing Guide](CONTRIBUTING.md).

## License

xCrash is MIT licensed, as found in the [LICENSE](LICENSE) file.

xCrash documentation is Creative Commons licensed, as found in the [LICENSE-docs](LICENSE-docs) file.