Raven-Grails

Raven-Grails is a Grails client for integrating apps with Sentry. Sentry is an event logging platform primarily focused on capturing and aggregating exceptions.

Take a look on the grails.org plugin page.

Installation

Add the following to your BuildConfig.groovy:

plugins {
    compile ":raven:0.5.4"
}

Configuration

You need to provide your Sentry DSN in Config.groovy file. The plugin will sent notifications to Sentry by default, if you want to disable notifications for an specific environment set the active option as false.

grails.plugins.raven.dsn = "https://{PUBLIC_KEY}:{SECRET_KEY}@app.getsentry.com/{PATH}{PROJECT_ID}"

environments {
    test {
        grails.plugins.raven.active = false
    }
    development {
        grails.plugins.raven.active = false
    }
    production {
    }
}

To set the current user data to be included in the logged messages sent to Sentry use the method ravenClient.setUserData passing a Map containing the user data. The supported keys are id, username, email and is_authenticated. The only key that is mandatory is is_authenticated. If you are using SpringSecurity in your application, you can get the current user using the method springSecurityService.currentUser. Above an example of Grails filter to set the user data:

import grails.plugins.raven.RavenClient

class SentryFilters {
    def ravenClient
    def springSecurityService

    def filters = {
        all(uri: '/**') {
            before = {
                if (springSecurityService.isLoggedIn()) {
                    def user = springSecurityService.currentUser
                    def userData = [id: user.id, is_authenticated: true, email: user.email, username: user.username]
                    ravenClient.setUserData(userData)
                } else {
                    ravenClient.setUserData([is_authenticated:false])
                }
            }
        }
    }
}

You can also set the server name, but it is recommended to don't set this configuration and let the plugin to resolve it.

grails.plugins.raven.serverName = 'dev.server.com'

Usage

Log4j Appender

The Log4j Appender is automatically configured by plugin, you have just to set enabled environments in Config.groovy file as shown in Configuration section. All application exceptions will be logged on sentry by the appender. The appender is configured to log just the ERROR, WARN and FATAL levels. To log manually just use the log.error method.

ravenClient

You also can use ravenClient to sent info messages to Sentry:

import grails.plugins.raven.RavenClient

def ravenClient

ravenClient.captureMessage(String message)
ravenClient.captureMessage(String message, String loggerClass, String logLevel)
ravenClient.captureException(Throwable exception)
ravenClient.captureException(Throwable exception, String loggerClass, String logLevel, HttpServletRequest request)