From 8be4982e872ff1b0e24f8eab6ff2099845ddb96f Mon Sep 17 00:00:00 2001 From: Nik Wakelin Date: Mon, 13 May 2024 16:08:26 +1200 Subject: [PATCH] Minor README tweaks Split usage into steps, and clarify Raygun dashboard -> Crash Reporting dashboard --- README.md | 14 ++++++++------ lib/raygun/demo_exception.rb | 2 +- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e65802e..6c0a258 100644 --- a/README.md +++ b/README.md @@ -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! @@ -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: diff --git a/lib/raygun/demo_exception.rb b/lib/raygun/demo_exception.rb index 3d63222..09b6bc9 100644 --- a/lib/raygun/demo_exception.rb +++ b/lib/raygun/demo_exception.rb @@ -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 << ")"