Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-crash-reporting
Fatal and Non-Fatal reporting to Crashlytics for Kotlin Multiplatform Mobile
https://github.com/icerockdev/moko-crash-reporting
android crash-reporting ios kotlin kotlin-multiplatform kotlin-native moko
Last synced: 2 months ago
JSON representation
Fatal and Non-Fatal reporting to Crashlytics for Kotlin Multiplatform Mobile
- Host: GitHub
- URL: https://github.com/icerockdev/moko-crash-reporting
- Owner: icerockdev
- License: apache-2.0
- Created: 2020-10-01T08:07:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-18T11:28:54.000Z (about 2 years ago)
- Last Synced: 2024-08-02T05:10:04.975Z (6 months ago)
- Topics: android, crash-reporting, ios, kotlin, kotlin-multiplatform, kotlin-native, moko
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 174 KB
- Stars: 27
- Watchers: 6
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- kmp-awesome - MOKO Crash Reporting - reporting to Crashlytics (Libraries / 🔍 Analytics)
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/crash-reporting-core) 
# Mobile Kotlin crash report
This is a Kotlin MultiPlatform library that provides reporting fatal and non-fatal exceptions from common code.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#set-up-locally)
- [Contributing](#contributing)
- [License](#license)
## Features
- **CrashlyticsLogger** implementation of **ExceptionLogger**, for logging messages and non-fatals to FirebaseCrashlytics.
- **CrashReportingAntilog** can be used for **Napier** logger to log messages and errors by **ExceptionLogger**
## Requirements
- Gradle version 6.8+
- Android API 19+
- iOS version 11.0+
## Installation
root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
project build.gradle
```groovy
dependencies {
commonMainImplementation("dev.icerock.moko:crash-reporting-crashlytics:0.4.0") // for CrashlyticsLogger
commonMainImplementation("dev.icerock.moko:crash-reporting-napier:0.4.0") // for CrashReportingAntilog
}
```
For CrashlyticsLogger need to add FirebaseCrashlytics cocoapod
With [mobile-multiplatform-gradle-plugin](https://github.com/icerockdev/mobile-multiplatform-gradle-plugin) cocoapods configuration simplest:
`build.gradle.kts`:
```kotlin
cocoaPods {
podsProject = file("ios-app/Pods/Pods.xcodeproj")
pod("MCRCDynamicProxy", onlyLink = true)
}
```
project Podfile
```ruby
pod 'MCRCDynamicProxy', :git => 'https://github.com/icerockdev/moko-crash-reporting.git', :tag => 'release/0.4.0'
pod 'MCRCStaticReporter', :git => 'https://github.com/icerockdev/moko-crash-reporting.git', :tag => 'release/0.4.0'
```
On iOS side add to `AppDelegate`:
```swift
import FirebaseCore
import MCRCStaticReporter
...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
FirebaseApp.configure()
MokoFirebaseCrashlytics.setup()
...
}
```
## Usage
### CrashlyticsLogger
If you haven't already, add Firebase to your project, you can see how to do it [here](https://firebase.google.com/docs/crashlytics/get-started)
```kotlin
val logger = CrashlyticsLogger()
// setting user id in crashlytics
logger.setUserId("User_1")
// setting custom key-value in crashlytics
logger.setCustomValue("customValue", "customKey")
// log message in crashlytics
logger.log("Hello World")
// send non-fatal exception to crashlytics
try {
"test".toInt()
} catch (e: NumberFormatException) {
logger.recordException(e)
}
```
### CrashReportingAntilog
```kotlin
val logger = CrashlyticsLogger() // CrashlyticsLogger for example, you can use any ExceptionLogger implementation
// initialize napier
Napier.base(antilog = CrashReportingAntilog(exceptionLogger = logger))
// All messages will be logged by exceptionLogger
Napier.d(message = "Hello World")
Napier.i(message = "This is random message", tag = "FYI")
Napier.w(message = "Something goes wrong", tag = "Alarm")
Napier.v(message = "just verbose", tag = "VERBOSE")
// throwable will be recorded by exceptionLogger
try {
"test".toInt()
} catch (e: NumberFormatException) {
Napier.e(message = "test is not a number", tag = "Non fatal", throwable = e)
}
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [crash-reporting-core](crash-reporting-core) contains basic classes and interfaces needed for crash reporting;
- The [crash-reporting-crashlytics](crash-reporting-crashlytics) contains integraion with firebase crashlytics;
- The [crash-reporting-napier](crash-reporting-napier) contains integration with [napier](https://github.com/AAkira/Napier) logger;
- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2020 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.