Set Up Logs

Structured logs allow you to send, view and query logs sent from your applications within Sentry.

With Sentry Structured Logs, you can send text based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.

Logs for Dart are supported in Sentry Dart SDK version 9.0.0 and above.

To enable logging, you need to initialize the SDK with the enableLogs option set to true.

Copied
await Sentry.init(
  (options) {
    options.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0";
    // Enable logs to be sent to Sentry
    options.enableLogs = true;
  },
);

Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the Sentry.logger APIs.

The logger namespace exposes six methods that you can use to log messages at different log levels: trace, debug, info, warning, error, and fatal.

Aside from the primary logging methods, we've provided a format text function, Sentry.logger.fmt, that you can use to insert properties into to your log entries.

These properties will be sent to Sentry, and can be searched from within the Logs UI, and even added to the Logs views as a dedicated column.

Copied
Sentry.logger.fmt.error('Uh oh, something broke, here is the error: %s', [
  errorMsg
], attributes: {
  'additional_info': SentryLogAttribute.string('some info'),
});
Sentry.logger.fmt.info("%s added %s to cart.", [user.username, product.name]);

You can also pass additional attributes directly to the logging functions, avoiding the need to use the fmt function.

Copied
Sentry.logger.error('Uh oh, something broke, here is the error: $errorMsg',
    attributes: {
      'error': SentryLogAttribute.string(errorMsg),
      'some_info': SentryLogAttribute.string('some info'),
    });
Sentry.logger.info('User ${user.username} added ${product.name} to cart.', attributes: {
  'user': SentryLogAttribute.string(user.username),
  'product': SentryLogAttribute.string(product.name),
});

Available integrations:

If there's an integration you would like to see, open a new issue on GitHub.

To filter logs, or update them before they are sent to Sentry, you can use the beforeSendLog option.

Copied
await Sentry.init(
  (options) {
    options.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0";
    options.beforeSendLog = (log) {
      if (log.level == SentryLogLevel.info) {
        // Filter out all info logs
        return null;
      }

      return log;
    };
  },
);

The beforeSend function receives a log object, and should return the log object if you want it to be sent to Sentry, or null if you want to discard it.

Previous
Set Up Tracing
Next
Set Up User Feedback
Was this helpful?
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").