Logging Integration

The sentry_logging library provides Logging support for Sentry using the onRecord property. It is able to collect breadcrumbs and capture events. Once this integration is configured, you can use Logging’s public API exclusively or in combination to the Sentry's SDK API to capture and enrich events.

The source can be found on GitHub.

Install

To add the Logging integration, add the sentry_logging dependency.

pubspec.yaml
Copied
dependencies:
  sentry: ^6.6.0
  sentry_logging: ^6.6.0
  logging: ^1.0.2

Configure

Configuration should happen as early as possible in your application's lifecycle.

Copied
import 'package:sentry_logging/sentry_logging.dart';
import 'package:sentry/sentry.dart';

Future<void> main() async {
  await Sentry.init(
    (options) {
      options.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0';
      options.addIntegration(LoggingIntegration());
    },
    appRunner: initApp, // Init your App.
  );
}

Verify

This snippet captures an intentional error, so you can test that everything is working as soon as you set it up:

Copied
import 'package:logging/logging.dart';

void main() async {
  final log = Logger('MyAwesomeLogger');

  log.info('a breadcrumb!');

  try {
    throw Exception();
  } catch (error, stackTrace) {
    log.severe('an error!', error, stackTrace);
  }
}

To view and resolve the recorded message, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").