Documentation Updates

This commit is contained in:
ehesp
2019-09-21 18:09:31 +01:00
parent 032c1b9847
commit 4226e0b569
23 changed files with 518 additions and 76 deletions

View File

@@ -3,9 +3,83 @@ title: Android Setup
description: Manually integrate Performance Monitoring into your Android application.
---
# Android Manual Linking
# Android Setup
The Performance Monitoring library requires the *Performance Monitoring plugin* to be installed in your project.
This plugin supplements the library by adding extra functionality and enabled [automatic HTTP/S network request monitoring.](https://firebase.google.com/docs/perf-mon#network-requests)
### Add the Performance Monitoring plugin
Add the plugin to your projects dependencies in your `/android/build.gradle` file:
```groovy
buildscript {
...
dependencies {
...
classpath 'com.google.firebase:perf-plugin:1.3.1'
}
```
### Apply the Performance Monitoring plugin
Apply the plugin in your `/android/app/build.gradle` file (at the top):
```groovy
apply plugin: 'com.android.application'
apply plugin: "com.google.firebase.firebase-perf"
```
## Android Manual Linking
> The following steps are only required if your environment does not have access to React Native
> auto-linking.
## TODO
#### Update Gradle Settings
Add the following to your projects `/android/settings.gradle` file:
```groovy
include ':@react-native-firebase_perf'
project(':@react-native-firebase_perf').projectDir = new File(rootProject.projectDir, './../node_modules/@react-native-firebase/perf/android')
```
#### Update Gradle Dependencies
Add the React Native Functions module dependency to your `/android/app/build.gradle` file:
```groovy{3}
dependencies {
...
implementation project(path: ":@react-native-firebase_perf")
}
```
#### Add package to the Android Application
Import and apply the React Native Firebase module package to your `/android/app/src/main/java/**/MainApplication.java` file:
Import the package:
```java
import io.invertase.firebase.perf.ReactNativeFirebasePerfPackage;
```
Add the package to the registry:
```java{4}
protected List<ReactPackage> getPackages() {
return Arrays.asList(
new MainReactPackage(),
new ReactNativeFirebasePerfPackage(),
```
#### Rebuild the project
Once the above steps have been completed, rebuild your Android project:
```bash
react-native run-android
```

View File

@@ -5,23 +5,31 @@ description: Manually integrate Performance Monitoring into your iOS application
# iOS Manual Linking
## Manual iOS Integration via CocoaPods
> The following steps are only required if your environment does not have access to React Native
> auto-linking.
#### Add Performance Monitoring Pod
### Add the RNFBPerf Pod
**`ios/Podfile`**:
Add the `RNFBPerf` Pod to your projects `/ios/Podfile`:
```ruby{4}
// ..
```ruby{3}
target 'app' do
// ..
...
pod 'RNFBPerf', :path => '../node_modules/@react-native-firebase/perf/ios'
end
```
## Manual iOS Integration via Frameworks
### Update Pods & rebuild the project
_TODO_
You may need to update your local Pods in order for the `RNFBPerf` Pod to be installed in your project:
```bash
$ cd /ios/
$ pod install --repo-update
```
Once the Pods have installed locally, rebuild your iOS project:
```bash
react-native run-ios
```

View File

@@ -18,6 +18,11 @@ yarn add @react-native-firebase/perf
> Integrating manually and not via React Native auto-linking? Check the setup instructions for <Anchor version group href="/android">Android</Anchor> & <Anchor version group href="/ios">iOS</Anchor>.
### Additional Android Steps:
Android requires additional manual installation steps. See the <Anchor version group href="/android">Android</Anchor>
installation documentation for more information.
## Module usage
Once installed, the Performance Monitoring package automatically traces events and metrics which