Skip to content

Commit 6cd2938

Browse files
Update Performance documentation. (#7181)
* Add secret to performance integration tests. * Updat pull request path to trigger the GHA. * Remove pull request condition. * Remove dev test App GoogleService-Info.plist * Create README.md * Fix style. * Add gitignore for GoogleService-Info.plist. * Move .gitignore to root directory. * Update Performance content to README. * Update Performance README. * Update README.md * Update Performance dev test App README. * Fix style. * Incorporate comments. * Update performance supported platforms.
1 parent 5c44730 commit 6cd2938

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

FirebasePerformance/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# Firebase Performance
1+
# Firebase Performance Monitoring
22

3-
Firebase Performance is a free mobile app performance analytics service. It
3+
[Firebase Performance Monitoring](https://firebase.google.com/docs/perf-mon) is a free mobile app performance analytics service. It
44
provides detailed information about the performance of your apps automatically,
55
but works at its best with Timers set by you. For more information about app
6-
performance and many other cool mobile services, check out [Firebase]
7-
(https://firebase.google.com).
6+
performance and many other cool mobile services, check out [Firebase](https://firebase.google.com/).
87

98
## Prereqs
109

@@ -20,7 +19,7 @@ The above command should be sufficient for most scenarios. Few more options list
2019

2120
- `sh generate_project.sh -e "prod"`
2221

23-
### Generate project for Autopush environment
22+
### Generate project for Autopush environment. The events generated for the Autopush environment will not be available on the console outside of Google as these are processed on our staging servers.
2423

2524
- `sh generate_project.sh` (or) `sh generate_project.sh -e "autopush"`
2625

FirebasePerformance/Tests/TestApp/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
## Setup
44

5-
Download the `GoogleService-Info.plist` file from [Firebase Console](https://console.firebase.google.com/)
6-
(for whatever Firebase project you have or want to integrate the `dev-app`). For Autopush environment, store the
7-
`GoogleService-Info.plist` under [Plists/Autopush/FIRPerfTestAppAutopush/](./Plists/Autopush/FIRPerfTestAppAutopush/).
8-
For Prod environment, project, store the `GoogleService-Info.plist` under [Plists/Prod/FIRPerfTestApp/](./Plists/Prod/FIRPerfTestApp/).
5+
For Prod environment, create a [Firebase project]((https://console.firebase.google.com/)) with bundle ID `com.google.FIRPerfTestApp`. Download and store the `GoogleService-Info.plist` under [Plists/Prod/FIRPerfTestApp/](./Plists/Prod/FIRPerfTestApp/). This should be sufficient for most scenarios.
6+
7+
For Autopush environment, create a [Firebase project]((https://console.firebase.google.com/)) with bundle ID `com.google.FIRPerfTestAppAutopush`. Download and store the
8+
`GoogleService-Info.plist` under [Plists/Autopush/FIRPerfTestAppAutopush/](./Plists/Autopush/FIRPerfTestAppAutopush/). The events generated for the Autopush environment will not be available on the console outside of Google as these are processed on our staging servers.
9+
910

1011
## Build
1112

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
[![Actions Status][gh-inappmessaging-badge]][gh-actions]
2121
[![Actions Status][gh-interop-badge]][gh-actions]
2222
[![Actions Status][gh-messaging-badge]][gh-actions]
23+
[![Actions Status][gh-performance-badge]][gh-actions]
2324
[![Actions Status][gh-remoteconfig-badge]][gh-actions]
2425
[![Actions Status][gh-storage-badge]][gh-actions]
2526
[![Actions Status][gh-symbolcollision-badge]][gh-actions]
@@ -194,6 +195,12 @@ To run against a production instance, provide a valid GoogleServices-Info.plist
194195
[public](https://firebase.google.com/docs/database/security/quickstart) while your tests are
195196
running.
196197

198+
### Firebase Performance Monitoring
199+
If you're doing specific Firebase Performance Monitoring development, see
200+
[the Performance README](FirebasePerformance/README.md) for instructions about building the SDK
201+
and [the Performance TestApp README](FirebasePerformance/Tests/TestApp/README.md) for instructions about
202+
integrating Performance with the dev test App.
203+
197204
### Firebase Storage
198205

199206
To run the Storage Integration tests, follow the instructions in
@@ -253,6 +260,7 @@ pod 'Firebase/Database' # No watchOS support yet
253260
pod 'Firebase/Firestore' # No watchOS support yet
254261
pod 'Firebase/Functions' # No watchOS support yet
255262
pod 'Firebase/Messaging'
263+
pod 'Firebase/Performance' # No macOS, tvOS, watchOS, and Catalyst support yet
256264
pod 'Firebase/RemoteConfig' # No watchOS support yet
257265
pod 'Firebase/Storage'
258266
```
@@ -305,6 +313,7 @@ Your use of Firebase is governed by the
305313
[gh-inappmessaging-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/inappmessaging/badge.svg
306314
[gh-interop-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/interop/badge.svg
307315
[gh-messaging-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/messaging/badge.svg
316+
[gh-performance-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/performance/badge.svg
308317
[gh-remoteconfig-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/remoteconfig/badge.svg
309318
[gh-storage-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/storage/badge.svg
310319
[gh-symbolcollision-badge]: https://github.com/firebase/firebase-ios-sdk/workflows/symbolcollision/badge.svg

0 commit comments

Comments
 (0)