Babysitter

A ruby gem that uses Fozzie to report progress on long-running tasks. When provided with a Logger it will output statistics of progress to the logs.

Installation

Add this line to your application's Gemfile:

gem "babysitter"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install babysitter

Use

Configuration

Babysitter.configure do |c|
  c.logger = MyApp.logger
end

The default logger does nothing, override if you want to see log output.

Amazon Simple Notification Service Integration

Babysitter can also make use of Amazons Simple Notification Service to provide notifications of when exceptions occur.

Babysitter.configure do |c|
  c.enable_simple_notification_service(
    topic_arn: "my-topic-arn",
    credentials: -> { 
      access_key_id: "YOUR_ACCESS_KEY_ID",
      secret_address_key: "YOUR_SECRET_ADDRESS_KEY",
    }
  )
end

The credentials should be supplied as a Proc so that they are only requested when they are required. This supports the use of temporary credentials with IAM and prevents any credentials fetched at configuration time having expired at some point later when an error occurs.

Monitoring

monitor = Babysitter.monitor("statsd.bucket.name")
monitor.start("Workername: description") do |tracker|
   things_to_do.each do |work|
      do_some work
      tracker.error(:badness,'Something bad happened') if something_bad?
      tracker.warn(:suspicions,'Something supicious happenedd') if something_bad?
      tracker.inc("Workername: {{count}} tasks completed", 1, counting: :things_to_do) # report progress here
   end
end

This will send statistics to StatsD in the supplied bucket name and will generate logs like this:

INFO -- : Start: statsd.bucket.name Matcher generating possible combinations
INFO -- : Done:  100 combinations generated
INFO -- : Rate:  20746.88796680498 combinations per second
INFO -- : End:   statsd.bucket.name

Logging statistics will incremented for bucket names

statsd.bucket.name.badness.errors
statsd.bucket.name.suspicions.warnings

Any exceptions that occur will be logged nicely. Exceptions will abort the process.

Development

$ git clone [email protected]:lonelyplanet/babysitter.git
$ cd babysitter

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request