Sentry Grails Plugin

Introduction

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

It uses the official Sentry.io client under the cover.

Installation

Declare the plugin dependency in the build.gradle file, as shown here:

dependencies {
    ...
    compile("com.github.pmedianetwork:grails-sentry:2.1.0")
    ...
}

Config

Add your Sentry DSN to your grails-app/conf/application.yml.

grails:
    plugin:
        sentry:
            dsn: https://{PUBLIC_KEY}@app.getsentry.com/{PROJECT_ID}

The DSN can be found in project's Settings under Client Keys (DSN) section.

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.

environments:
    development:
        grails:
            plugin:
                sentry:
                    active: false
    test:
        grails:
            plugin:
                sentry:
                    active: false

You can also configure the multiple logger to which you want to append the sentry appender. You can also set the server name, but it is recommended to don't set this configuration and let the plugin to resolve it.

Optional configurations

grails:
    plugin:
        sentry:
            dsn: https://[email protected]/123
            loggers: [LOGGER1, LOGGER2, LOGGER3]
            environment: staging
            serverName: dev.server.com
            minLevel: ERROR
            tags: {tag1: val1,  tag2: val2, tag3: val3}
            logHttpRequest: true
            disableMDCInsertingServletFilter: true
            inAppIncludes:
              - my.app.package.one
              - my.app.package.two
            tracesSampleRate: 0.5
            traceJDBC: true
            linkPrefix: https://sentry.example.com/organizations/company
            excludedUris:
              - /exact/uri
              - /prefix/.*
              - /(any|general)/regex[/]?
            springSecurityUser: true
            springSecurityUserProperties:
                id: 'id'
                email: 'emailAddress'
                username: 'login'
                data: # Additional properties to be retrieved from user details object and passed as extra properties to Sentry user interface.
                    - 'authorities'

Transactions with uri matching any of configured excludedUris will be ignored. It depends on request URI in MDC so disableMDCInsertingServletFilter must be false (default) for this feature to work.

Check Sentry-java documentation to configure connection, protocol and async options in your DSN. If you are sending extra tags from the plugin for the exceptions, make sure to enable the corresponding tag on sentry tag settings for the particular project to see the tag as a filter on the exception stream on sentry.

Usage

Logback Appender

The Logback Appender is automatically configured by the plugin, you just have to set enabled environments as shown in Configuration section.

All application exceptions will be logged on sentry by the appender. The appender is configured to log just the WARN level and up. To log manually just use the log.error() method.

Capturing events manually

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

import io.sentry.Sentry
import io.sentry.SentryEvent
import io.sentry.SentryLevel
import io.sentry.protocol.Message

// Send simple message
Sentry.currentHub.captureMessage("some message")

// Send exception
Sentry.currentHub.captureException(new Exception("some exception"))

// Custom event
SentryEvent event = new SentryEvent(
        message: new Message(message: "This is a test"),
        level: SentryLevel.INFO,
        logger: MyClass.class.name,
)

Sentry.currentHub.captureEvent(event)

Performance monitoring

Sentry performance monitoring is disabled by default. You have to set config tracesSampleRate to value greater than 0 to enable it. Sample rate represents percentage of requests that should be traced (value 1 = 100%). Requests handled by controllers are then automatically traced in Sentry according to sample rate. You can also enable JDBC tracing by setting config traceJDBC to true.

To enable distributed tracing you need to connect services (frontend) by adding <sentry:traceMeta /> to <head> of your gsp view.

If you configure linkPrefix you can also add <sentry:traceLink /> to your gsp view which displays direct link to transaction in sentry application.

Latest releases

See releases.

For historical releases ("org.grails.plugins:sentry") see agorapulse/grails-sentry.

Bugs

To report any bug, please use the project Issues section on GitHub.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

Copyright © 2016 Alan Rafael Fachini, authors, and contributors. All rights reserved.

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.

Maintained by