impulse 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in impulse.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,124 @@
+= impulse
+
+* http://github.com/lloydpick/impulse
+
+== DESCRIPTION:
+
+RubyGem to help generate & maintain RRDTool graphs
+
+== FEATURES/PROBLEMS:
+
+ * Ability to create and push data into RRD files with multiple data sources
+ * Ability to draw graphs based on multiple RRD files with multiple data sources
+
+== SYNOPSIS:
+
+Require and initialize the gem
+
+  require 'impulse'
+  imp = Impulse::Graph.new
+  
+Lets push some data into an RRD file, it will be created if it doesn't exist...
+
+  imp.push("elb_eu_west", 5000)
+  
+We'll now have an RRD file named 'elb_eu_west' and it will contain a data source called 'data'
+
+To draw a graph based on this data...
+
+  imp.draw("elb_eu_west", :hour, { :filename => 'elb_eu_west_hour.png', :title => 'ELB Requests - Last Hour', :vertical => 'Requests' })
+  
+We specify the name of the RRD file, the time duration we want, it can be...
+
+  :hour
+  :day
+  :week
+  :month
+  :year
+  
+...or any value in seconds.
+  
+Then some various other graphical options.
+
+
+If we want to have more than one data source in the RRD file, we can do that too...
+  
+  imp.push("data_in_out", { :in => 50, :out => 20 })
+  
+We will now have a 'data_in_out.rrd' file and it will contain 2 data sources named 'in' and 'out'
+
+To draw a graph with two data sources...
+
+  imp.draw(
+    { 
+      'In' => { :name => "data_in_out", :data => :in, :color => '#000000' },
+      'Out' => { :name => "data_in_out", :data => :out }
+    }, 
+    :hour, 
+    { 
+      :filename => 'data_in_out.png', 
+      :title => 'In/Out - Last Hour', 
+      :vertical => 'Data'
+    }
+  )
+  
+Simply need to specify the different data sources within a hash, since we provide the name of the file we can combine multiple files...
+
+  imp.draw(
+    { 
+      'In' => { :name => "data_in_out", :data => :in, :color => '#000000' },
+      'Out' => { :name => "data_in_out", :data => :out },
+      'Requests' => { :name => "elb_eu_west" }
+    }, 
+    :hour, 
+    { 
+      :filename => 'data_in_out_elb.png', 
+      :title => 'In/Out + ELB - Last Hour', 
+      :vertical => 'Data'
+    }
+  )
+  
+Note that it will attempt to guess as much of the options as it can, as you can see we didn't have to tell it the name of the data source for the 'elb_eu_west' RRD file.
+
+== PARAMS:
+
+Default parameters...
+
+  :filename => 'impuse.png', 
+  :height => 200, 
+  :width => 600, 
+  :title => 'Impuse Graph', 
+  :vertical => '',
+  :legend => ''
+  
+All can be configured on a per graph basis.
+
+
+== INSTALL:
+
+  gem install impulse
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Lloyd Pick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/impulse.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "impulse/version"
+
+Gem::Specification.new do |s|
+  s.name        = "impulse"
+  s.version     = Impulse::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lloyd Pick"]
+  s.email       = ["lloydpick+impulse@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{RubyGem to help make very quick RRDTool graphs}
+  s.description = %q{Ability to make RRDTool graphs with zero thought}
+
+  s.rubyforge_project = "impulse"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/impulse/version.rb

@@ -0,0 +1,3 @@
+module Impulse
+  VERSION = "0.0.1"
+end

data/lib/impulse.rb

@@ -0,0 +1,84 @@
+module Impulse
+  class Graph
+    attr_reader :debug
+  
+    def initialize(debug = false)
+      @debug = debug
+    end
+    
+    def push(name, datas, params = {})
+      create_or_find_rrd(name, datas)
+      push_to_rrd(name, datas)
+    end
+    
+    def draw(name, time_scale = :day, params = {})
+      params = { 
+        :filename => 'impuse.png', 
+        :height => 200, 
+        :width => 600, 
+        :title => 'Impuse Graph', 
+        :vertical => '',
+        :legend => ''
+      }.merge(params)
+      
+      defaults = "-E -W 'Generated at #{Time.at(Time.now)}' -e now -h #{params[:height]} -w #{params[:width]}"
+      cmd = ["rrdtool graph #{params[:filename]} -s -#{seconds_for(time_scale)} #{defaults} -t '#{params[:title]}' -v '#{params[:vertical]}'"]
+      
+      if name.is_a?(Hash)
+        c = 0
+        name.each do |k,v|
+          v = { :color => '#FF0000', :data => :data }.merge(v)
+          cmd << "DEF:d#{c}=./#{v[:name]}.rrd:#{v[:data].to_s}:MAX"
+          cmd << "LINE1:d#{c}#{v[:color]}:'#{k}' GPRINT:d#{c}:LAST:\"Last\\:%8.0lf\" GPRINT:d#{c}:MIN:\"	Min\\:%8.0lf\" GPRINT:d#{c}:AVERAGE:\"	Avg\\:%8.0lf\" GPRINT:d#{c}:MAX:\"	Max\\:%8.0lf\\n\""
+          c += 1
+        end
+      else
+        cmd << "DEF:average=./#{name}.rrd:data:MAX"
+        cmd << "LINE1:average#FF0000:'#{params[:legend]}' GPRINT:average:LAST:\"Last\\:%8.0lf\" GPRINT:average:MIN:\"	Min\\:%8.0lf\" GPRINT:average:AVERAGE:\"	Avg\\:%8.0lf\" GPRINT:average:MAX:\"	Max\\:%8.0lf\\n\""
+      end
+      
+      system cmd.join(" ")
+    end
+    
+    private
+    def create_or_find_rrd(name, datas)
+      averages = "RRA:AVERAGE:0.5:1:576 RRA:MIN:0.5:1:576 RRA:MAX:0.5:1:576 RRA:AVERAGE:0.5:6:432 RRA:MIN:0.5:6:432 RRA:MAX:0.5:6:432 RRA:AVERAGE:0.5:24:540 RRA:MIN:0.5:24:540 RRA:MAX:0.5:24:540 RRA:AVERAGE:0.5:288:450 RRA:MIN:0.5:288:450 RRA:MAX:0.5:288:450"
+      unless File.exist?(name + ".rrd")
+        puts 'Creating RRD' if @debug
+        if datas.is_a?(Hash)
+          entries = []
+          datas.each do |k,v|
+            entries << "DS:#{k.to_s}:GAUGE:600:0:U"
+          end
+          system "rrdtool create #{name}.rrd --step 300 --start #{Time.now.to_i - 1} #{entries.join(' ')} #{averages}"
+        else
+          system "rrdtool create #{name}.rrd --step 300 --start #{Time.now.to_i - 1} DS:data:GAUGE:600:0:U #{averages}"
+        end
+      end
+    end
+    
+    def push_to_rrd(name, data)
+      unless File.exist?(name + ".rrd")
+        puts 'Updating RRD' if @debug
+        system "rrdtool update #{name}.rrd #{Time.now.to_i}:#{data}"
+      end
+    end
+    
+    def seconds_for(time_scale)      
+      case time_scale
+      when :hour
+        3600
+      when :day
+        86400
+      when :week
+        604800
+      when :month
+        2629743
+      when :year
+        31556926
+      else
+        time_scale
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: impulse
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lloyd Pick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-09 00:00:00 Z
+dependencies: []
+
+description: Ability to make RRDTool graphs with zero thought
+email: 
+- lloydpick+impulse@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- impulse.gemspec
+- lib/impulse.rb
+- lib/impulse/version.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: impulse
+rubygems_version: 1.8.1
+signing_key: 
+specification_version: 3
+summary: RubyGem to help make very quick RRDTool graphs
+test_files: []
+