Dropwizard Sentry

Dropwizard integration for error logging to Sentry.

Usage

Dropwizard Sentry provides an AppenderFactory which is automatically registered in Dropwizard and will send errors to Sentry.

Logging startup errors

In order to log startup errors (i.e. before the SentryAppenderFactory has been properly initialized), the Dropwizard application has to run the SentryBootstrap.bootstrap() in its main method and set a custom UncaughtExceptionHandler for the main thread.

public static void main(String[] args) throws Exception {
    SentryBootstrap.bootstrap(DSN);
    Thread.currentThread().setUncaughtExceptionHandler(UncaughtExceptionHandlers.systemExit());

    new MyDropwizardApplication().run(args);
}

Please note that by default startup logger will catch all logs, you can specify custom threshold as following:

public static void main(String[] args) throws Exception {
    SentryBootstrap.Builder()
        .withDsn(DSN)
        .withThreshold(THRESHOLD)
        .bootstrap();
    Thread.currentThread().setUncaughtExceptionHandler(UncaughtExceptionHandlers.systemExit());

    new MyDropwizardApplication().run(args);
}

Configuration

Include the sentry appender in your application's YAML configuration:

appenders:
  - type: sentry
    threshold: ERROR
    dsn: https://user:[email protected]/appid
    environment: production
    mdcTags: ['foo','bar','baz']
    sentryClientFactory: com.example.SentryClientFactory
    release: 1.0.0
    serverName: 10.0.0.1
    extra: {key1:'value1',key2:'value2'}
    stacktraceAppPackages: ['com.example','com.foo']

Setting	Default	Description	Example Value
threshold	ALL	The log level to configure to send to Sentry	ERROR
dsn		Data Source Name - format is https://{PUBLIC_KEY}:{SECRET_KEY}@sentry.io/{PROJECT_ID}	https://foo:[email protected]/12345
environment	[empty]	The environment your application is running in	production
tags	[empty]	Tags to be sent with each event	tag1:value1,tag2,value2
mdcTags	[empty]	Tag names to be extracted from logging MDC	['foo', 'bar']
sentryClientFactory	[empty]	Specify a custom SentryClientFactory class	com.example.SentryClientFactory
release	[empty]	The release version of your application	1.0.0
serverName	[empty]	Override the server name (rather than looking it up dynamically)	10.0.0.1
extra	[empty]	Extra data to be sent with errors (but not as tags)	{key1:'value1',key2:'value2'}
stacktraceAppPackages	[empty]	List of package prefixes used by application code	['com.example','com.foo']

If you need to set configuration properties not listed above, append them to the dsn as described here.

Maven Artifacts

This project is available in the Central Repository. To add it to your project simply add the following dependency to your POM:

<dependency>
  <groupId>org.dhatim</groupId>
  <artifactId>dropwizard-sentry</artifactId>
  <version>1.3.9-1</version>
</dependency>

Support

Please file bug reports and feature requests in GitHub issues.

Acknowledgements

Thanks to dropwizard-raven from which much of the original implementation was derived.