https://github.com/Bhuvaneshw/CrashHandler
A Crash Handling library for Android projects that automatically stores all crash logs in a file until intentionally cleared.
https://github.com/Bhuvaneshw/CrashHandler
android crash crash-handler java kotlin
Last synced: 4 months ago
JSON representation
A Crash Handling library for Android projects that automatically stores all crash logs in a file until intentionally cleared.
- Host: GitHub
- URL: https://github.com/Bhuvaneshw/CrashHandler
- Owner: Bhuvaneshw
- License: gpl-3.0
- Created: 2024-09-02T15:56:10.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-24T03:53:35.000Z (9 months ago)
- Last Synced: 2024-10-09T11:04:04.739Z (8 months ago)
- Topics: android, crash, crash-handler, java, kotlin
- Language: Kotlin
- Homepage: https://acutecoder.netlify.app
- Size: 1.79 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - Bhuvaneshw/CrashHandler - A Crash Handling library for Android projects that automatically stores all crash logs in a file until intentionally cleared. (Kotlin)
README
# Crash handler
A Crash Handling library for Android projects that automatically stores all crash logs in a file until intentionally cleared. It also records the time of the last exception, making it easy to review and debug issues by sharing the logs.
## Screenshots
[
](## "Default Crash Handler") [
](## "Custom Crash Handler")
## Contents:
1. Setup
1.1 Kotlin DSL
1.2 Groovy DSL
2. Usage
2.1 Default Crash Hanlder
2.2 Formatter and Logger
2.3 Restart after crash
2.4 Custom Crash handler
2.5 Loading Crash data in Activity
2.6 Thread specific crash handler
3. Custom Crash Handler UI
3.1 Custom Activity Implementation or See File
3.2 Custom Activity Implementation for Compose or See File
4. License
## 1. Setup
### 1.1 Gradle - Kotlin DSL
Step 1: Project level build.gradle.kts / settings.gradle.kts
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven("https://jitpack.io")
}
}
Step 2: Module level build.gradle
```
dependencies {
implementation("com.github.Bhuvaneshw:CrashHandler:$version")
}
```
Replace $version with latest version
Latest Version:
[](https://jitpack.io/#Bhuvaneshw/CrashHandler)
Example:
```
dependencies {
implementation("com.github.Bhuvaneshw:CrashHandler:1.0.0")
}
```
### 1.2 Gradle - Groovy DSL
Step 1: Project level build.gradle / settings.gradle
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
}
Step 2: Module level build.gradle
```
dependencies {
implementation 'com.github.Bhuvaneshw:CrashHandler:$version'
}
```
## 2. Usage
### 2.1 Default Crash handler
Extend Application with CrashHandlerApplication and call installCrashHandler()
Koltin
```
class MyApp : CrashHandlerApplication() {
init {
installCrashHandler()
}
}
```
Java
```
public class MyApp extends CrashHandlerApplication {
@Override
public void onCreate() {
super.onCreate();
initCrashHandler();
}
}
```
Register in AndroidManifiest
```
...
```
> [!NOTE]
> This default handler will not restart app after crash. See [Restart after crash](#22-restart-after-crash) section
### 2.2 Formatter and Logger
You can provide Custom Formatter by extending [ErrorMessageFormatter](crashhandler/src/main/java/com/acutecoder/crashhandler/formatter/ErrorMessageFormatter.java) and pass it in [installCrashHandler](#21-default-crash-handler)
You can provide Custom Logger by extending [CrashLogger](crashhandler/src/main/java/com/acutecoder/crashhandler/logger/CrashLogger.java) and pass it in [installCrashHandler](#21-default-crash-handler)
Koltin
```
class MyApp : CrashHandlerApplication() {
init {
installCrashHandler(
errorMessageFormatter = DefaultErrorMessageFormatter, // OR timedErrorMessageFormatter()
logger = AndroidErrorLogger(),
)
}
}
```
Java
```
public class MyApp extends CrashHandlerApplication {
@Override
public void onCreate() {
super.onCreate();
initCrashHandler(DefaultErrorMessageFormatter.INSTANCE, new RestartAppCallback(this), new AndroidErrorLogger());
}
}
```
> [!NOTE]
> The default formatter is [DefaultErrorMessageFormatter](crashhandler/src/main/java/com/acutecoder/crashhandler/formatter/DefaultErrorMessageFormatter.kt) and the default logger is [AndroidErrorLogger](crashhandler/src/main/java/com/acutecoder/crashhandler/logger/AndroidErrorLogger.kt)
> [!NOTE]
> TimedErrorMessageFormatter follows Decorator Patter, to create instance use timedErrorMessageFormatter() extension function for Kotlin and new TimedErrorMessageFormatter(this, DefaultErrorMessageFormatter.INSTANCE) for Java
### 2.3 Restart after crash
Provide RestartAppCallback() while initializing the crash handler
Kotlin
```
class MyApp : CrashHandlerApplication() {
init {
installCrashHandler(callback = RestartAppCallback(this))
}
}
```
Java
```
public class MyApp extends CrashHandlerApplication {
@Override
public void onCreate() {
super.onCreate();
initCrashHandler(
DefaultErrorMessageFormatter.INSTANCE,
new RestartAppCallback(this),
new AndroidErrorLogger()
);
}
}
```
### 2.4 Custom Crash Handler
Override startCrashHandlerActivity() and provide your custom activity class
Kotlin
```
class CustomCrashHandlerApp : CrashHandlerApplication() {
init {
installCrashHandler()
}
override fun startCrashHandlerActivity(defaultActivityClass: Class<*>) {
super.startCrashHandlerActivity(CustomCrashHandlerActivity::class.java) // Provide your custom activity class
}
}
```
Java
```
public class DefaultCrashHandlerApp extends CrashHandlerApplication {
@Override
public void onCreate() {
super.onCreate();
initCrashHandler();
}
@Override
protected void startCrashHandlerActivity(@NonNull Class> defaultActivityClass) {
super.startCrashHandlerActivity(CustomCrashHandlerActivity.class); // Provide your custom activity class
}
}
```
### 2.5 Loading crash data in Activity
> [!CAUTION]
> Calling loadErrorLog() on main thread is not allowed, throws ReadLogOnMainThreadException.
Kotlin
```
val log: ErrorLog = crashHandler.loadErrorLog()
val errors: MutableList? = log.errors
val simplifiedLog: String = log.simplifiedLog()
val lastErrorTime: String? = log.lastErrorTime
```
> [!TIP]
> Using coroutine with IO dispatcher is recommended
Java
```
ErrorLog log = CrashHandlerUtilsKt.getCrashHandler(context).loadErrorLog();
//Works only when the context.applicationContext is an instance of CrashHandler,
//i.e The application must implement CrashHandler, like extending CrashHandlerApplication
List errors = log.getErrors();
String simplifiedLog = log.simplifiedLog();
String lastErrorTime = log.getLastErrorTime();
```
### 2.6 Thread specific crash handler
You can provide specific threads instead of setting it for all threads.
Kotlin
```
class MyApp : CrashHandlerApplication() {
init {
installCrashHandler(threads = arrayOf(myThread1, myThread2, myThreadN))
//OR
// installCrashHandler(
// errorMessageFormatter = DefaultErrorMessageFormatter,
// callback = null,
// logger = AndroidErrorLogger(),
// myThread1, myThread2, myThreadN
//)
}
}
```
Java
```
public class MyApp extends CrashHandlerApplication {
@Override
public void onCreate() {
super.onCreate();
initCrashHandler(DefaultErrorMessageFormatter.INSTANCE, new RestartAppCallback(this), new AndroidErrorLogger(), myThread1, myThread2, myThreadN);
}
}
```
## 3. Custom Crash Handler UI
### 3.1 Custom Activity Implementation
> [!NOTE]
> For more details see the [CrashHandlerActivity](crashhandler/src/main/java/com/acutecoder/crashhandler/CrashHandlerActivity.kt) implementation.
### 3.2 Custom Activity Implementation for Compose
> [!NOTE]
> If you are using compose in your project see [CustomCrashHandlerActivity](app/src/main/java/com/acutecoder/crashhandler/CustomCrashHandlerActivity.kt) for implementation.
## 4. License
```
CrashHandler - Crash Handling Library
Copyright (C) 2024 Bhuvaneshwaran
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
```