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
This commit is contained in:
Pritesh Nandgaonkar
2018-12-17 06:56:03 -08:00
committed by Facebook Github Bot
parent 88820d4865
commit 1bc566f813
5 changed files with 53 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 135 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

View File

@@ -0,0 +1,50 @@
---
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());
```

View File

@@ -100,10 +100,10 @@ target 'MyApp' do
platform :ios, '9.0' platform :ios, '9.0'
pod 'FlipperKit', '~>' + flipperkit_version pod 'FlipperKit', '~>' + flipperkit_version
# Layout and network plugins are not yet supported for swift projects
pod 'FlipperKit/FlipperKitLayoutComponentKitSupport', '~>' + flipperkit_version pod 'FlipperKit/FlipperKitLayoutComponentKitSupport', '~>' + flipperkit_version
pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version
pod 'FlipperKit/FlipperKitUserDefaultsPlugin', '~>' + flipperkit_version pod 'FlipperKit/FlipperKitUserDefaultsPlugin', '~>' + flipperkit_version
pod 'FlipperKit/FlipperKitCrashReporterPlugin', '~>' + flipperkit_version
post_install do |installer| post_install do |installer|
installer.pods_project.targets.each do |target| installer.pods_project.targets.each do |target|

View File

@@ -12,7 +12,8 @@
"network-plugin", "network-plugin",
"sandbox-plugin", "sandbox-plugin",
"shared-preferences-plugin", "shared-preferences-plugin",
"leak-canary-plugin" "leak-canary-plugin",
"crash-reporter-plugin"
], ],
"Plugins: Desktop part": [ "Plugins: Desktop part": [
"js-setup", "js-setup",