Skip to content
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

Minor README tweaks #181

Merged
merged 1 commit into from
May 13, 2024
Merged

Minor README tweaks #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,27 @@ And then execute:

$ bundle install

Or, if you're not using Bundler, install the gem directly:

$ gem install raygun4ruby

## Usage

### Rails 6+

#### Step 1

Run:

rails g raygun:install YOUR_API_KEY_HERE

You can find your API key in the [Raygun app](https://app.raygun.com/) under "Application Settings".

#### Step 2

You can then test your Raygun integration by running:

rails raygun:test

You should see an "ItWorksException" appear in your Raygun dashboard. You're ready to zap those errors! :zap:
You should see an "ItWorksException" appear in your Raygun Crash Reporting dashboard. You're ready to zap those errors! :zap:

#### Step 3 (optional)

The generator will create a file in `config/initializers` called "raygun.rb". If you need to do any further configuration or customization of Raygun, that's the place to do it!

Expand Down Expand Up @@ -292,7 +294,7 @@ To see the defaults check out [affected_user.rb](https://github.com/MindscapeHQ/

If you're using Rails, most authentication systems will have this method set and you should be good to go.

The count of unique affected customers will appear on the error group in the Raygun dashboard. If your customer has an `email` attribute, and that email has a Gravatar associated with that address, you will also see your customer's avatar.
The count of unique affected customers will appear on the error group in Raygun Crash Reporting. If your customer has an `email` attribute, and that email has a Gravatar associated with that address, you will also see your customer's avatar.

If you wish to keep it anonymous, you could set this identifier to something like `SecureRandom.uuid` and store that in a cookie, like so:

Expand Down
2 changes: 1 addition & 1 deletion lib/raygun/demo_exception.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def track_test_exception
response = Raygun.track_exception(e)

if response.success?
puts "Success! Now go check your Raygun Dashboard"
puts "Success! Now go check your Raygun Crash Reporting dashboard"
else
puts "Oh-oh, something went wrong - double check your API key"
puts "API Key - " << Raygun.configuration.api_key << ")"
Expand Down