Skip to content

Update README for Grails 3 #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rpalcolea wants to merge 2 commits into
base: grails-3.0
Choose a base branch
from
Open

Update README for Grails 3 #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b835575
Update README to use Interceptor instead of Filters.
rpalcolea Oct 22, 2016
2fc9d19
Update README.md
rpalcolea Oct 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ When an uncaught exception occurs, Airbrake will POST the relevant data to the A

## Installation & Configuration

Add the following to your `BuildConfig.groovy`
Add the following dependency to your `build.gradle`

```
compile ":airbrake:0.9.4"
compile ":airbrake:1.0.0.RC1"
```

Once the plugin is installed, you need to provide your Api Key in `Config.groovy` file:
Once the plugin is installed, you need to provide your Api Key in `application.groovy` file:

```groovy
grails.plugins.airbrake.apiKey = 'YOUR_API_KEY'
Expand Down Expand Up @@ -83,7 +83,7 @@ grails.plugins.airbrake.excludes
```

### Enabling/Disabling Notifications
By default all errors are sent to Airbrake. However, you can disable error notifications (essentially disabling the plugin) by setting `grails.plugins.airbrake.enabled = false`. For example to disable error notificaitons in development and test environments you might have the following in `Config.groovy`:
By default all errors are sent to Airbrake. However, you can disable error notifications (essentially disabling the plugin) by setting `grails.plugins.airbrake.enabled = false`. For example to disable error notificaitons in development and test environments you might have the following in `application.groovy`:

```groovy
grails.plugins.airbrake.apiKey = 'YOUR_API_KEY'
Expand Down Expand Up @@ -137,7 +137,7 @@ grails.plugins.airbrake.includeEventsWithoutExceptions = true
then logged errors get reported to Airbrake:

```groovy
@Log4j
@Sl4fj
class SomeGroovyClass {
def doSomething() {
if (somethingWentWrong()) {
Expand Down Expand Up @@ -182,22 +182,23 @@ The supported keys are `id`, `name`, `email` and `username`
airbrakeService.addNoticeContext(id: '1234', name: 'Bugs Bunny', email: 'bugs@acme.com', username: 'bugs')
```

In most web apps the simplest way to provide this context is in a Grails filter. For example if you are using `SpringSecurity` add the following `AirbrakeFilter.groovy` in `grails-app/conf`
In most web apps the simplest way to provide this context is in a Grails Interceptor. For example if you are using `SpringSecurity` add the following `AirbrakeInterceptor.groovy` in `grails-app/controllers/<appname>/AirbrakeInterceptor.groovy`
```groovy
class AirbrakeFilters {
def airbrakeService
def springSecurityService

def filters = {
all(uri: '/**') {
before = {
def user = springSecurityService.currentUser
if (user) {
airbrakeService.addNoticeContext(user: [id: user.id, name: user.name, email: user.email, username: user.username ])
}
}
}
class AirbrakeInterceptor {
def airbrakeService
def springSecurityService

AirbrakeInterceptor() {
matchAll()
}

boolean before() {
def user = springSecurityService.currentUser
if (user) {
airbrakeService.addNoticeContext(user: [id: user.id, name: user.name, email: user.email, username: user.username ])
}
true
}
}
```

Expand Down