Advanced Usage
It’s possible to add extra data to events thanks to the MDC system provided by Logback.
Mapped Tags
By default all MDC parameters are stored under the “MDC” tab in Sentry.
import org.slf4j.MDC;
void logWithExtras() {
// MDC extras
MDC.put("Environment", "Development");
MDC.put("OS", "Linux");
// This sends an event where the Environment and OS MDC values are set as MDC entries
logger.error("This is a test");
}
Note that MDC manages data on a per-thread basis, and that a child thread does not automatically inherit MDC properties from its parent.
In Practice
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
public class MyClass {
private static final Logger logger = LoggerFactory.getLogger(MyClass.class);
void logSimpleMessage() {
// This sends a simple event to Sentry
logger.error("This is a test");
}
void logWithBreadcrumbs() {
// Record a breadcrumb that will be sent with the next event(s),
// by default the last 100 breadcrumbs are kept.
Sentry.addBreadcrumb("User made an action");
// Log entries below `minimumEventLevel` and above or equal to `minimumBreadcrumbLevel`
// are recorded as breadcrumbs
logger.info("User made another action");
// This sends a simple event to Sentry
logger.error("This is a test");
}
void logWithExtras() {
// MDC extras
MDC.put("extra_key", "extra_value");
// This sends an event with extra data to Sentry
logger.error("This is a test");
}
void logException() {
try {
unsafeMethod();
} catch (Exception e) {
// This sends an exception event to Sentry
logger.error("Exception caught", e);
}
}
void unsafeMethod() {
throw new UnsupportedOperationException("You shouldn't call this!");
}
}
Context Tags
Since Sentry 6.0.0, it is possible to define a list of MDC tags
that will show up as Tags
in the Sentry UI. MDC Tags
not in this list are shown as Context Data
in the UI, just like before.
To define such tags add a context-tag
xml tag to the options tag of the Sentry appender configuration in logback.xml
<appender name="sentry" class="io.sentry.logback.SentryAppender">
<options>
<!-- NOTE: Replace the test DSN below with YOUR OWN DSN to see the events from this app in your Sentry project/dashboard -->
<dsn>https://examplePublicKey@o0.ingest.sentry.io/0</dsn>
<contextTag>userId</contextTag>
<contextTag>requestId</contextTag>
</options>
</appender>
When calling MDC.put("userId", "myUserId")
with above Appender configuration in place, the userId
will show up as a tag
on the event in the Sentry UI.
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").
- Package:
- maven:io.sentry:sentry-logback
- Version:
- 6.17.0
- Repository:
- https://github.com/getsentry/sentry-java