Isar Database Instrumentation
Learn more about the Sentry Isar Database Instrumentation for the Flutter SDK.
This feature is currently in Beta. Beta features are still in progress and may have bugs. We recognize the irony.
(New in version 7.16.0)
Isar is a fast cross-platform database for Flutter. The sentry_isar package provides Isar support for database instrumentation and allows you to track the performance of your queries.
The created spans will be attached to the transaction on the scope. If no transaction is on the scope the Isar span will not be sent to Sentry.
Before starting, ensure:
Add the sentry_isar dependency to install the Isar database instrumentation.
pubspec.yamldependencies:
sentry_flutter: ^8.11.0
sentry_isar: ^8.11.0
path_provider: ^2.0.0
Use SentryIsar to initialize the instance:
import 'package:path_provider/path_provider.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
import 'package:sentry_isar/sentry_isar.dart';
import 'user.dart'; // Import your Isar model instead
final dir = await getApplicationDocumentsDirectory();
final isar = await SentryIsar.open(
[UserSchema],
directory: dir.path,
);
import 'package:path_provider/path_provider.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
import 'package:sentry_isar/sentry_isar.dart';
import 'user.dart'; // Import your Isar model instead
Future<void> runApp() async {
final tr = Sentry.startTransaction('isarTest', 'db', bindToScope: true);
final dir = await getApplicationDocumentsDirectory();
final isar = await SentryIsar.open(
[UserSchema],
directory: dir.path,
);
final newUser = User()
..name = 'Joe Dirt'
..age = 36;
await isar.writeTxn(() async {
await isar.users.put(newUser); // insert & update
});
final existingUser = await isar.users.get(newUser.id); // get
await isar.writeTxn(() async {
await isar.users.delete(existingUser!.id); // delete
});
await tr.finish(status: const SpanStatus.ok());
}
To view the recorded transaction, log into sentry.io. Use the left sidebar to navigate to the Performance page. Select your project and scroll down to the transactions table to see the just recorded transaction with the name isarTest. You can also use the search bar to find the transaction. Click on the transaction to open its Transaction Summary page for more performance details.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").