irfsdash 0.1.3 → 0.1.5

data/README.md

@@ -16,6 +16,16 @@ Or install it yourself as:
 
     $ gem install irfsdash
 
+## Requirements
+
+*You cannot run IRFSDash without an AMQP server and a statsd/graphite server*. There is a production server, which is the default, but this is only accessible within the IRFS gateway.
+
+You can set the AMQP/Statsd hosts as follows:
+
+    # must be called BEFORE any other methods, ie in an initializer
+    IRFSDash.statsd_host(hostname)
+    IRFSDash.amqp_host(hostname)
+
 ## Usage
 
 In an initializer:
@@ -43,6 +53,14 @@ Publish a widget:
     IRFSDash.widget(content: '<strong>Hello</strong> world')
     IRFSDash.widget(url: 'http://some-url')
 
+Increment/decrement a counter:
+
+    IRFSDash.increment("clips-made")
+    IRFSDash.decrement("clips-made")
+
+Record the time taken for an event (time in milliseconds):
+
+    IRFSDash.timing("clip-creation", 500)
 
 ## Contributing
 
@@ -51,3 +69,4 @@ Publish a widget:
 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
+

data/irfsdash.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency('bunny', '>= 0.8.0')
   gem.add_dependency('json', '>= 1.7.5')
   gem.add_dependency('trollop', '>= 2.0.0')
+  gem.add_dependency('statsd-ruby', '>= 1.0.0')
 end

data/lib/irfsdash.rb

@@ -1,14 +1,29 @@
 require "irfsdash/version"
 require "bunny"
 require "json"
+require "statsd"
 module IRFSDash
+  # Set the Statsd hostname
+  def self.statsd_host(host='10.10.12.156')
+    @statsd_host ||= host
+  end
+  # Set the AMQP host
+  def self.amqp_host(host='10.10.12.156')
+    @amqp_host ||= host
+  end
   # Returns an AMQP channel
   def self.amqp
     return @b if @b
-    @b = Bunny.new(host: 'localhost')
+    @b = Bunny.new(host: self.amqp_host)
     @b.start
     return @b
   end
+  def self.statsd
+    return @statsd if @statsd
+    @statsd = Statsd.new(self.statsd_host, 8125)
+    @statsd.namespace('irfsdash')
+    return @statsd
+  end
   # Setup the library's defaults
   def self.setup(opts={})
     @defaults = opts
@@ -48,5 +63,20 @@ module IRFSDash
     raise ArgumentError, "No content or URL specified" unless msg[:url] or msg[:content]
     self.amqp.exchange("irfs-dashboard.widgets", type: :fanout).publish(JSON.dump(msg))
   end
+  # Increment a counter in statsd.
+  # Arguments: Counter name to increment, optional sample rate
+  def self.increment(*args)
+    self.statsd.increment(*args)
+  end
+  # Decrement a counter in statsd.
+  # Arguments: Counter name to decrement, optional sample rate
+  def self.decrement(*args)
+    self.statsd.decrement(*args)
+  end
+  # Report a task time in statsd
+  # Arguments: Task name, time in milliseconds, optional sample rate
+  def self.timing(*args)
+    self.statsd.timing(*args)
+  end
 
 end

data/lib/irfsdash/version.rb

@@ -1,3 +1,3 @@
 module IRFSDash
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irfsdash
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Interface gem for the BBC Research and Development IRFS Dashboard
 email:
 - james.harrison2@bbc.co.uk