File I/O
File I/O operations are fundamental for reading from and writing to files within an application. The sentry_file
integration provides File support for Sentry thus providing insight into performance monitoring of file operations.
- The created spans will be attached to the transaction on the scope - if no transaction is on the scope the File I/O span will not be sent to Sentry.
- The File I/O integration is only available for the
dart:io:File
class, not for thedart:html:File
class. - The SDK sets the span
operation
tofile.copy
,file.write
,file.delete
,file.open
,file.read
orfile.rename
, anddescription
tofilename
(for example,file.txt
). - The span finishes once the operation has been executed. The span
status
is then set toSpanStatus.ok
if successful, orSpanStatus.internalError
if there was an error. - When the operation throws an
Exception
, Sentry's SDK associates it with the running span.
To use the SentryFile
wrapper, add the sentry_file
dependency.
pubspec.yaml
Copied
dependencies:
sentry: ^7.19.0
sentry_file: ^7.19.0
Call the Sentry extension method to wrap the file:
Copied
final sentryFile = file.sentryTrace();
Copied
import 'package:sentry/sentry.dart';
import 'package:sentry_file/sentry_file.dart';
import 'dart:io';
Future<void> main() async {
await Sentry.init(
(options) {
options.dsn = 'https://example@sentry.io/example';
// To set a uniform sample rate
options.tracesSampleRate = 1.0;
},
appRunner: runApp, // Init your App.
);
}
Future<void> runApp() async {
final file = File('my_file.txt');
// Call the Sentry extension method to wrap up the File
final sentryFile = file.sentryTrace();
// Start a transaction if there's no active transaction
final transaction = Sentry.startTransaction(
'MyFileExample',
'file',
bindToScope: true,
);
// create the File
await sentryFile.create();
// Write some content
await sentryFile.writeAsString('Hello World');
// Read the content
final text = await sentryFile.readAsString();
print(text);
// Delete the file
await sentryFile.delete();
// Finish the transaction
await transaction.finish(status: SpanStatus.ok());
await Sentry.close();
}
To view the recorded transaction, log into sentry.io and open your project. Clicking Performance will open a page with transactions, where you can select the just recorded transaction with the name MyFileExample
.
Help improve this content
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").
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").
- Package:
- pub:sentry
- Version:
- 7.19.0
- Repository:
- https://github.com/getsentry/sentry-dart
- API Documentation:
- https://pub.dev/documentation/sentry/latest/