gmetric 0.1.0

data/README.rdoc

@@ -0,0 +1,59 @@
+= GMetric
+
+A pure Ruby client for generating Ganglia 3.1.x+ gmetric meta and metric packets and talking to your gmond / gmetad nodes over UDP protocol. Supports host spoofing, and all the same parameters as the gmetric command line executable.
+
+== Example: Sending a gmetric to a gmond over UDP
+
+  Ganglia::GMetric.send("127.0.0.1", 8670, {
+    :name => 'pageviews',
+    :units => 'req/min',
+    :type => 'uint8',
+    :value => 7000,
+    :tmax => 60,
+    :dmax => 300
+  })
+
+== Example: Generating the Meta and Metric packets
+
+  g = Ganglia::GMetric.pack(
+    :slope => 'positive',
+    :name => 'ruby',
+    :value => rand(100),
+    :tmax => 60,
+    :units => '',
+    :dmax => 60,
+    :type => 'uint8'
+  )
+
+  # g[0] = meta packet
+  # g[1] = gmetric packet
+  
+  s = UDPSocket.new
+  s.connect("127.0.0.1", 8670)
+  s.send g[0], 0
+  s.send g[1], 0
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Ilya Grigorik
+
+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,28 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gmetric"
+    gemspec.summary = "Pure Ruby interface for generating Ganglia gmetric packets"
+    gemspec.description = gemspec.summary
+    gemspec.email = "ilya@igvita.com"
+    gemspec.homepage = "http://github.com/igrigorik/gmetric"
+    gemspec.authors = ["Ilya Grigorik"]
+    gemspec.rubyforge_project = "gmetric"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.ruby_opts = ['-rtest/unit']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gmetric.rb

@@ -0,0 +1,91 @@
+require "stringio"
+require "socket"
+
+module Ganglia
+  class GMetric
+
+    SLOPE = {
+      'zero'        => 0,
+      'positive'    => 1,
+      'negative'    => 2,
+      'both'        => 3,
+      'unspecified' => 4
+    }
+
+    def self.send(host, port, metric)
+      conn = UDPSocket.new
+      conn.connect(host, port)
+      gmetric = self.pack(metric)
+      
+      conn.send gmetric[0], 0
+      conn.send gmetric[1], 0
+    end
+
+    def self.pack(metric)
+      metric = {
+        :hostname => '',   
+        :spoof    => 0,
+        :units    => '',
+        :slope    => 'both',
+        :tmax     => 60,
+        :dmax     => 0
+      }.merge(metric)
+      
+      raise "Missing key, value, type" if not metric.key? :name or not metric.key? :value or not metric.key? :type
+      raise "Invalid metric type" if not %w(string int8 uint8 int16 uint16 int32 uint32 float double).include? metric[:type]
+      
+      meta = XDRPacket.new
+      data = XDRPacket.new
+      
+      # METADATA payload
+      meta.pack_int(128)                            # gmetadata_full
+      meta.pack_string(metric[:hostname])           # hostname
+      meta.pack_string(metric[:name].to_s)          # name of the metric
+      meta.pack_int(metric[:spoof].to_i)            # spoof hostname flag
+      
+      meta.pack_string(metric[:type].to_s)          # one of: string, int8, uint8, int16, uint16, int32, uint32, float, double
+      meta.pack_string(metric[:name].to_s)          # name of the metric 
+      meta.pack_string(metric[:units].to_s)         # units for the value, e.g. 'kb/sec'
+      meta.pack_int(SLOPE[metric[:slope]])          # sign of the derivative of the value over time, one of zero, positive, negative, both, default both
+      meta.pack_uint(metric[:tmax].to_i)            # maximum time in seconds between gmetric calls, default 60
+      meta.pack_uint(metric[:dmax].to_i)            # lifetime in seconds of this metric, default=0, meaning unlimited
+      meta.pack_int(0)                                                   
+                                                                         
+      # DATA payload                                                     
+      data.pack_int(128+5)                          # string message     
+      data.pack_string(metric[:hostname].to_s)      # hostname           
+      data.pack_string(metric[:name].to_s)          # name of the metric 
+      data.pack_int(metric[:spoof].to_i)            # spoof hostname flag      
+      data.pack_string("%s")                        #                    
+      data.pack_string(metric[:value].to_s)         # value of the metric
+
+      [meta.data, data.data]
+    end
+  end
+
+  class XDRPacket
+    def initialize
+      @data = StringIO.new
+    end
+
+    def pack_uint(data)
+      # big endian unsigned long
+      @data << [data].pack("N")
+    end
+    alias :pack_int  :pack_uint
+
+    def pack_string(data)
+      len = data.size
+      pack_uint(len)
+
+      # pad the string
+      len = ((len+3) / 4) * 4
+      data = data + ("\0" * (len - data.size))
+      @data << data
+    end
+
+    def data
+      @data.string
+    end
+  end
+end

data/spec/gmetric_spec.rb

@@ -0,0 +1,67 @@
+require "helper"
+
+describe Ganglia::GMetric do
+
+  describe Ganglia::XDRPacket do
+    def hex(data)
+      [data].pack("H")
+    end
+
+    it "should pack an int & uint into XDR format" do
+      xdr = Ganglia::XDRPacket.new
+      xdr.pack_int(1)
+      xdr.data.should == "\000\000\000\001"
+
+      xdr = Ganglia::XDRPacket.new
+      xdr.pack_uint(8)
+      xdr.data.should == "\000\000\000\b"
+    end
+
+    it "should pack string" do
+      xdr = Ganglia::XDRPacket.new
+      xdr.pack_string("test")
+      xdr.data.should == "\000\000\000\004test"
+    end
+  end
+
+  it "should pack GMetric into XDR format from Ruby hash" do
+    data = {
+      :slope => 'both',
+      :name => 'foo',
+      :value => 'bar',
+      :tmax => 60,
+      :units => '',
+      :dmax => 0,
+      :type => 'string'
+    }
+
+    g = Ganglia::GMetric.pack(data)
+    g.size.should == 2
+    g[0].should == "\000\000\000\200\000\000\000\000\000\000\000\003foo\000\000\000\000\000\000\000\000\006string\000\000\000\000\000\003foo\000\000\000\000\000\000\000\000\003\000\000\000<\000\000\000\000\000\000\000\000"
+    g[1].should == "\000\000\000\205\000\000\000\000\000\000\000\003foo\000\000\000\000\000\000\000\000\002%s\000\000\000\000\000\003bar\000"
+  end
+
+  it "should raise an error on missing name, value, type" do
+    %w(name value type).each do |key|
+      lambda {
+        data = {:name => 'a', :type => 'b', :value => 'c'}
+        data.delete key.to_sym
+        Ganglia::GMetric.pack(data)
+      }.should raise_error
+    end
+  end
+
+  it "should verify type and raise error on invalid type" do
+    %w(string int8 uint8 int16 uint16 int32 uint32 float double).each do |type|
+      lambda {
+        data = {:name => 'a', :type => type, :value => 'c'}
+        Ganglia::GMetric.pack(data)
+      }.should_not raise_error
+    end
+
+    lambda {
+      data = {:name => 'a', :type => 'int', :value => 'c'}
+      Ganglia::GMetric.pack(data)
+    }.should raise_error
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require "lib/gmetric"
+require "spec"

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: gmetric
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-28 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Pure Ruby interface for generating Ganglia gmetric packets
+email: ilya@igvita.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/gmetric.rb
+- spec/gmetric_spec.rb
+- spec/helper.rb
+has_rdoc: true
+homepage: http://github.com/igrigorik/gmetric
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gmetric
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pure Ruby interface for generating Ganglia gmetric packets
+test_files: 
+- spec/gmetric_spec.rb
+- spec/helper.rb