Performance Monitoring

caution

This is a beta FlutterFire plugin and therefore is not yet production quality.

What does it do?#

Firebase Performance Monitoring is a service that helps you to gain insight into the performance characteristics of your iOS, Android, and web apps.

Installation#

Legacy
Null safety

caution

This package version is not null safe migrated yet, but has been implemented to be compatible with other null safe FlutterFire packages.

Ensure you're using the Flutter stable channel:

$ flutter channel stable

If your app is mixing legacy and null-safe packages, use the --no-sound-null-safety flag:

$ flutter run --no-sound-null-safety

For legacy package imports, place the following ignore comment to hide Dart analyzer warnings:

// ignore: import_of_legacy_library_into_null_safe
import 'package:firebase_performance/firebase_performance.dart';

1. Add dependency#

Legacy
Null safety

pubspec.yaml

dependencies:
  flutter:
    sdk: flutter
  firebase_core: "^0.7.0"
  firebase_performance: "^0.5.0+1"

2. Download dependency#

$ flutter pub get

3. (Web Only) Add the SDK#

If using FlutterFire on the web, add the firebase-performance JavaScript SDK to your index.html file:

web/index.html

<html>
  ...
  <body>
    <script src="https://www.gstatic.com/firebasejs/8.6.1/firebase-app.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.6.1/firebase-performance.js"></script>
  </body>
</html>

4. Rebuild your app#

Once complete, rebuild your Flutter application:

$ flutter run

Next Steps#

Once installed, you're ready to start using Performance Monitoring in your Flutter Project.

Additional documentation will be available once the Firebase Performance Monitoring plugin update lands as part of the FlutterFire roadmap.