Opsgenie::Send

Simplest possible ruby library to send alerts and heartbeats to Opsgenie.

That's all it does: one two things well.

Add this line to your application's Gemfile:

gem 'opsgenie-send'

And then execute:

$ bundle

Or install it yourself as:

$ gem install opsgenie-send

Set environment variable to your Opsgenie API key:

export OPSGENIE_KEY=xxx

Run from the command-line:

opsgenie-alert Test alert
opsgenie-heartbeat Test heartbeat

Run from your code:

require 'opsgenie/send'
Opsgenie::Send.heartbeat('Test heartbeat')
Opsgenie::Send.alert('Test alert')

The methods return the JSON string response from Opsgenie.

You may pass optional parameters to alerts (see the list at https://www.opsgenie.com/docs/web-api/alert-api#createAlertRequest):

Opsgenie::Send.alert('Test alert', tags: %w[foo bar])

You can send, and then close an alert by using an alias:

Opsgenie::Send.alert('Test alert', alias: 'test')
Opsgenie::Send.close(alias: 'test')

After checking out the repo, run bin/setup to install dependencies. 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.

Bug reports and pull requests are welcome on GitHub at https://github.com/rlister/opsgenie-send. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

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