Skip to content

Commit

Permalink
Update README with new features
Browse files Browse the repository at this point in the history
  • Loading branch information
nikz committed Jan 7, 2015
1 parent 1af3e84 commit 566af4c
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,20 @@ end

```

(You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html))
You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html)

### Customising Paremter Filtering

If you'd like to customize how parameters are filtered, you can pass a `Proc` to `filter_parameters`. Raygun4Ruby will yield the params hash to the block, and the return value will be sent along with your error.

```ruby
Raygun.setup do |config|
config.api_key = "YOUR_RAYGUN_API_KEY"
config.filter_parameters do |params|
params.slice("only", "a", "few", "keys") # note that Hash#slice is in ActiveSupport
end
end
```

###Custom User Data
Custom data can be added to `track_exception` by passing a custom_data key in the second parameter hash.
Expand Down Expand Up @@ -111,6 +124,17 @@ Raygun.setup do |config|
end
```

###Using a Proxy

You can pass proxy settings using the `proxy_settings` config option.

```ruby
Raygun.setup do |config|
config.api_key = "MY_SWEET_API_KEY"
config.proxy_settings = { host: "localhost", port: 8888 }
end
```

###Affected User Tracking

Raygun can now track how many users have been affected by an error.
Expand Down

0 comments on commit 566af4c

Please sign in to comment.