Hallmonitor

Hallmonitor is a simple event monitoring framework for Ruby. It allows programs to define and emit events.

Hallmonitor supports publishing events to a Statsd instance if the 'statsd-ruby' gem is installed. See https://github.com/reinh/statsd for details

Setup

Before you can use Hallmonitor you have to do a tiny bit of configuration in the form of adding outputters

Hallmonitor::Outputter.add_outputter Hallmonitor::Outputters::IOOutputter.new("STDOUT", STDOUT)
Hallmonitor::Outputter.add_outputter Hallmonitor::Outputters::StatsdOutputter.new("example", "localhost")

The StatsdOutputter is only available if you've installed the statsd-ruby gem. If it's not available, StatsdOutputter's intitialize method will raise a RuntimeError

Usage

There are a few different ways to use Hallmonitor:

Included in your class

class Foo
  include Hallmonitor::Monitored

  # This method will emit 100 events
  def bar
    # Emit 100 events.  The string will be the name of the Event object that gets emitted
    100.times do
      emit("event")
    end

    # You can also just emit Event objects themselves
    emit(Event.new("new_event"))

    # emit also takes a block, if you want to modify the event before it is emitted
    emit(Event.new("event")) do |e|
      e.name = "changed"
    end
  end

  # This method will emit 1 TimedEvent for the block
  def time_me
    watch("timed") do |x|
      sleep(10)
    end
  end
end

foo = Foo.new
foo.bar # Will emit 10 events
foo.time_me # Will emit a single TimedEvent

Explicit Event objects

event = Hallmonitor::Event.new("event")
event.emit

Contributing to Hallmonitor