Honeybadger for Ruby

Hi there! You've found Honeybadger's docs on Ruby exception tracking. In this guide we're going to discuss the honeybadger Ruby gem and how to use it to track exceptions in your Ruby applications.

For a refresher on working with exceptions in Ruby, check out the Honeybadger guide to Ruby exceptions.

How You Should Read the Docs

If you're new to Honeybadger, we recommend reading over our Getting Started guide (good work, you're reading it now!) from start to finish. This guide is also your reference for how to use the gem in the future, so bookmark it.

Our Integration guides cover everything you'll need to know to install Honeybadger in less than 3 minutes and get the most out of your platform or framework.

See the Gem Reference section for a quick reference to the gem's configuration, public method API, and CLI (Command Line Interface).

Finally, you may also be interested in other areas of our documentation, such as our REST API guide or general product guides.

Getting Support

If you're having trouble working with the gem (such as you aren't receiving error reports when you should be):

  1. Read Frequently asked questions
  2. Upgrade to the latest gem version if possible (you can find a list of bugfixes and other changes in the CHANGELOG)
  3. Run through our Troubleshooting guide

For all other problems, contact support for help: support@honeybadger.io

If your issue is gem-related, here are a few items you can send us which will make it easier to spot the problem:

  • Run bundle exec honeybadger test --file=honeybadger_test.txt from the server having the problem and attach the generated honeybadger_test.txt file
  • Run bundle exec rake middleware from the server having the problem and attach the output as plaintext
  • Attach your config/honeybadger.yml file
  • Attach your Gemfile.lock file