Skip to content

rubyonjets/honeybadger-jets

Repository files navigation

HoneyBadger Jets

Gem Version

BoltOps Badge

HoneyBadger is real-time error reporting and monitoring service.

This gem adds HoneyBadger error reporting support to Jets: Ruby Serverless Framework.

This gem is not officially associated and written by HoneyBadger. This is written by tongueroo. Looking for maintainers or someone who would like to see if they can get this integrated to the official honeybadger gem. instead At which point, this gem should be deprecated.

Installation

Add this line to your Jets project Gemfile:

gem 'honeybadger-jets'

And then execute:

bundle

Add the HONEYBADGER_API_KEY env variable to the .env file in your project. Here's an example of what HONEYBADGER_API_KEY looks like.

.env:

HONEYBADGER_API_KEY=random-token

To get a HONEYBADGER_API_KEY, sign up for an account at honeybadger.io and create a project. For more info on Env Files, refer to the Jets docs.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tongueroo/honeybadger-jets.

License

The gem is available as open source under the terms of the MIT License.

TODO