Module: Hallmonitor

Defined in:
lib/hallmonitor/monitored.rb,
lib/hallmonitor.rb,
lib/hallmonitor/event.rb,
lib/hallmonitor/version.rb,
lib/hallmonitor/outputter.rb,
lib/hallmonitor/dispatcher.rb,
lib/hallmonitor/middleware.rb,
lib/hallmonitor/gauge_event.rb,
lib/hallmonitor/timed_event.rb,
lib/hallmonitor/configuration.rb,
lib/hallmonitor/outputters/new_relic.rb,
lib/hallmonitor/outputters/iooutputter.rb,
lib/hallmonitor/outputters/statsd_outputter.rb

Overview

Include this module in classes where you want monitoring capabilities

Defined Under Namespace

Modules: Monitored, Outputters, Version Classes: Configuration, Dispatcher, Event, GaugeEvent, Middleware, Outputter, TimedEvent

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.



12
13
14
 
# File 'lib/hallmonitor.rb', line 12

def config
  @config
end

Class Method Details

.add_outputter(outputter) ⇒ Object

Note:

This delegates to Hallmonitor::Dispatcher.add_outputter

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

Parameters:

  • outputter (Outputter) —

    An instance of an outputter



27
28
29
 
# File 'lib/hallmonitor.rb', line 27

def self.add_outputter(outputter)
  Dispatcher.add_outputter(outputter)
end

.configure {|config| ... } ⇒ Object

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

Yields:



18
19
20
21
 
# File 'lib/hallmonitor.rb', line 18

def self.configure
  self.config ||= Hallmonitor::Configuration.new
  yield(config)
end