module Hallmonitor

Top-level module, allows for configuration

Include this module in classes where you want monitoring capabilities

add_outputter(outputter) click to toggle source

Adds an outputter to Hallmonitor. Whenever events are emitted they will be sent to all registered outputters

@param outputter [Outputter] An instance of an outputter @note This delegates to {Dispatcher.add_outputter}

# File lib/hallmonitor.rb, line 31
def add_outputter(outputter)
  Dispatcher.add_outputter(outputter)
end

config() click to toggle source

@return {Hallmonitor::Configuration} instance

# File lib/hallmonitor.rb, line 15
def config
  @config ||= Hallmonitor::Configuration.new
end

configure() { |config| ... } click to toggle source

Method to configure Hallmonitor, takes a block and passes a {Hallmonitor::Configuration} object in, which can be used to set configuration options.

# File lib/hallmonitor.rb, line 22
def configure
  yield(config)
end