algometrics.io ruby client

algometrics-gem is an official ruby client for event-tracking and real-time workflow monitoring and alerting platform algometrics.io

Add this line to your application's Gemfile:

gem 'algometrics'

And then execute:

$ bundle

Or install it yourself as:

$ gem install algometrics

Quickest possible way to send events is the following:

client = Algometrics::Client.new(api_key: '...')
client.track(event: 'Job - Started', actor: {type: 'Job', id: 123})
client.track(event: 'Job - Completed', actor: {type: 'Job', id: 123})

This way, we'll be able to track events for actor Job#123.

By default all events are sent with status success.

You can explicitly send events with status failure, in this case any workflows associated with events will be immediately marked as failed and notifications will be sent.

client = Algometrics::Client.new(api_key: '...')
client.track(event: 'Order Placed', actor: {type: 'Order', id: 123}, status: Algometrics::FAILURE)

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

Bump up version in lib/algometrics/version.rb and then run

rake release

Bug reports and pull requests are welcome on GitHub at https://github.com/algometricsio/algometrics-gem

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