Files
flipper/docs/crash-reporter-plugin.md
Pritesh Nandgaonkar 1bc566f813 Updated the website docs with the information of crash reporter plugin
Summary: Added the documentation of crash reporter plugin. Also removed the stale comment

Reviewed By: passy

Differential Revision: D13434177

fbshipit-source-id: bb8b14e989c91b35cd268daea12ac7fe590c5d5b
2018-12-17 11:08:28 -08:00

51 lines
1.4 KiB
Markdown

---
id: crash-reporter-plugin
title: Crash Reporter Plugin
---
The Crash Reporter Plugin shows a notification in Flipper whenever an app crashes. You can click on the notification to see crash information like stacktrace and other metadata. For Android, you can also use the "Open in Logs" action to find the relevant point in the logs view, so that it is easy to investigate what had happend before the crash.
Since this is an alpha release, it doesn't fire notification on all kind of crashes. It fires notifications on uncaught exceptions for both Android and iOS applications, whereas it fires crash notification for signal errors just for iOS and currently not for Android. We are still working on it, but do try out this plugin. Feedback and issues are welcome!
The plugin looks like the following
![UI](/docs/assets/crashreporterplugin.png)
![Notification](/docs/assets/crashreporterpluginnotification.png)
## Setup
### iOS
Add crash reporter plugin to the client.
#### Objective-C
```objectivec
#import <FlipperKitCrashReporterPlugin/FlipperKitCrashReporterPlugin.h>
[client addPlugin:[FlipperKitCrashReporterPlugin sharedInstance]];
```
#### Swift
```swift
import FlipperKit
client?.add(FlipperKitCrashReporterPlugin.sharedInstance());
```
### Android
Add crash reporter plugin to the client.
```java
import com.facebook.flipper.plugins.crashreporter.CrashReporterPlugin;
client.addPlugin(CrashReporterPlugin.getInstance());
```