How to install and use firebase_crashlytics with Flutter 3.10.5 - including code sample!
A popular Flutter package with 922 likes that support Flutter version 3.10.5 and above. Last version of the package was published on Aug 01, 2023.Installing firebase_crashlytics
You can either add the package directly using the flutter command line.
In either case, make sure to refresh your packages by running the following command:
$ flutter pub add firebase_crashlytics
dependencies:
firebase_crashlytics: ^3.3.4
In either case, make sure to refresh your packages by running the following command:
$ flutter pub get
Using firebase_crashlytics
Once you have installed the package, you can use it in your Flutter application by importing it.
import 'package:firebase_crashlytics/firebase_crashlytics.dart';
How to use firebase_crashlytics with a code example/sample
// ignore_for_file: require_trailing_commas
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'dart:io';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_crashlytics/firebase_crashlytics.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'firebase_options.dart';
// Toggle this to cause an async error to be thrown during initialization
// and to test that runZonedGuarded() catches the error
const _kShouldTestAsyncErrorOnInit = false;
// Toggle this for testing Crashlytics in your app locally.
const _kTestingCrashlytics = true;
Future main() async {
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
const fatalError = true;
// Non-async exceptions
FlutterError.onError = (errorDetails) {
if (fatalError) {
// If you want to record a "fatal" exception
FirebaseCrashlytics.instance.recordFlutterFatalError(errorDetails);
// ignore: dead_code
} else {
// If you want to record a "non-fatal" exception
FirebaseCrashlytics.instance.recordFlutterError(errorDetails);
}
};
// Async exceptions
PlatformDispatcher.instance.onError = (error, stack) {
if (fatalError) {
// If you want to record a "fatal" exception
FirebaseCrashlytics.instance.recordError(error, stack, fatal: true);
// ignore: dead_code
} else {
// If you want to record a "non-fatal" exception
FirebaseCrashlytics.instance.recordError(error, stack);
}
return true;
};
runApp(MyApp());
}
class MyApp extends StatefulWidget {
MyApp({Key? key}) : super(key: key);
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends State {
late Future _initializeFlutterFireFuture;
Future _testAsyncErrorOnInit() async {
Future.delayed(const Duration(seconds: 2), () {
final List list = [];
print(list[100]);
});
}
// Define an async function to initialize FlutterFire
Future _initializeFlutterFire() async {
if (_kTestingCrashlytics) {
// Force enable crashlytics collection enabled if we're testing it.
await FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(true);
} else {
// Else only enable it in non-debug builds.
// You could additionally extend this to allow users to opt-in.
await FirebaseCrashlytics.instance
.setCrashlyticsCollectionEnabled(!kDebugMode);
}
if (_kShouldTestAsyncErrorOnInit) {
await _testAsyncErrorOnInit();
}
}
@override
void initState() {
super.initState();
_initializeFlutterFireFuture = _initializeFlutterFire();
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('Crashlytics example app'),
),
body: FutureBuilder(
future: _initializeFlutterFireFuture,
builder: (context, snapshot) {
switch (snapshot.connectionState) {
case ConnectionState.done:
if (snapshot.hasError) {
return Center(
child: Text('Error: ${snapshot.error}'),
);
}
return Center(
child: Column(
children: [
ElevatedButton(
onPressed: () {
FirebaseCrashlytics.instance
.setCustomKey('example', 'flutterfire');
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'Custom Key "example: flutterfire" has been set \n'
'Key will appear in Firebase Console once an error has been reported.'),
duration: Duration(seconds: 5),
));
},
child: const Text('Key'),
),
ElevatedButton(
onPressed: () {
FirebaseCrashlytics.instance
.log('This is a log example');
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'The message "This is a log example" has been logged \n'
'Message will appear in Firebase Console once an error has been reported.'),
duration: Duration(seconds: 5),
));
},
child: const Text('Log'),
),
ElevatedButton(
onPressed: () async {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text('App will crash is 5 seconds \n'
'Please reopen to send data to Crashlytics'),
duration: Duration(seconds: 5),
));
// Delay crash for 5 seconds
sleep(const Duration(seconds: 5));
// Use FirebaseCrashlytics to throw an error. Use this for
// confirmation that errors are being correctly reported.
FirebaseCrashlytics.instance.crash();
},
child: const Text('Crash'),
),
ElevatedButton(
onPressed: () {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'Thrown error has been caught and sent to Crashlytics.'),
duration: Duration(seconds: 5),
));
// Example of thrown error, it will be caught and sent to
// Crashlytics.
throw StateError('Uncaught error thrown by app');
},
child: const Text('Throw Error'),
),
ElevatedButton(
onPressed: () {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text(
'Uncaught Exception that is handled by second parameter of runZonedGuarded.'),
duration: Duration(seconds: 5),
));
// Example of an exception that does not get caught
// by `FlutterError.onError` but is caught by
// `runZonedGuarded`.
runZonedGuarded(() {
Future.delayed(const Duration(seconds: 2),
() {
final List list = [];
print(list[100]);
});
}, FirebaseCrashlytics.instance.recordError);
},
child: const Text('Async out of bounds'),
),
ElevatedButton(
onPressed: () async {
try {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text('Recorded Error'),
duration: Duration(seconds: 5),
));
throw Error();
} catch (e, s) {
// "reason" will append the word "thrown" in the
// Crashlytics console.
await FirebaseCrashlytics.instance.recordError(e, s,
reason: 'as an example of fatal error',
fatal: true);
}
},
child: const Text('Record Fatal Error'),
),
ElevatedButton(
onPressed: () async {
try {
ScaffoldMessenger.of(context)
.showSnackBar(const SnackBar(
content: Text('Recorded Error'),
duration: Duration(seconds: 5),
));
throw Error();
} catch (e, s) {
// "reason" will append the word "thrown" in the
// Crashlytics console.
await FirebaseCrashlytics.instance.recordError(e, s,
reason: 'as an example of non-fatal error');
}
},
child: const Text('Record Non-Fatal Error'),
),
],
),
);
default:
return const Center(child: Text('Loading'));
}
},
),
),
);
}
}