Set Up Logs

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.

Requirements

Logs for JUL are supported in Sentry Java SDK version 8.16.0 and above.

Setup

To enable logging, you need to configure the option in sentry.properties or when calling Sentry.init.

logs.enabled=true

You may also configure the Sentry handler and set minimumLevel in logging.properties:

# Configure the Sentry handler
handlers=io.sentry.jul.SentryHandler

# Set the minimum level for Sentry handler
io.sentry.jul.SentryHandler.minimumLevel=CONFIG

Usage

Once the handler is configured with logging enabled, any logs at or above the minimumLevel will be sent to Sentry.

Integrations

Available integrations:

• Spring Boot using Logback
• Logback
• Log4j2
• JUL

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

Options

beforeSendLog

To filter logs, or update them before they are sent to Sentry, you can use the getLogs().beforeSend option.

import io.sentry.Sentry;

Sentry.init(options -> {
  options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
  options.getLogs().setBeforeSend((logEvent) -> {
    // Modify the event here:
    logEvent.setBody("new message body");
    return logEvent;
  });
});

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.