astro-collectd 0.0.7 → 0.0.8

data/README.rst

@@ -0,0 +1,83 @@
+collectd Data Model
+-------------------
+
+Collectd groups data by **six categories:**
+
+* *hostname* is grabbed from `hostname -f`
+* *plugin* is the application's name
+* *plugin-instance* is passed from the programs' side with the
+  programs instance identifier, useful if you're running the same
+  script twice (PIDs are quite too random)
+* *type* is the kind of data you are measuring and must be defined in
+  types.db_ for collectd to understand
+* *type-instance* provides further distinction and have no relation to
+  other type-instances. Multiple type-instances are only rendered into
+  one graph by collection3 if defined with module GenericStacked.
+* *values* are one or more field names and types belonging
+  together. The exact amount of fields and their corresponding names
+  (useful to collection3) are specified in collectd's types.db_.
+
+A value can be either of **two types:**
+
+* *COUNTER* is for increasing counters where you want to plot the
+  delta. Network interface traffic counters are a good example.
+* *GAUGE* is values that go up and down to be plotted as-is, like a
+  temperature graph.
+
+
+Usage
+-----
+
+::
+
+    gem 'astro-collectd'
+    require 'collectd'
+
+First of all, specify a server to send data to:
+
+::
+
+    Collectd.add_server(interval, addr='ff18::efc0:4a42', port=25826)
+
+Each server definition you add will receive all the data you push to
+later. An interval of 10 is quite reasonable. Because of UDP and some
+buffering in collectd, an interval of 1 seconds shouldn't hurt either.
+
+All the identifiers from above can be given free form with some
+method_missing stuff. Like this:
+
+::
+
+    # Set gauge absolutely
+    Collectd.plugin(:plugin_instance).type(:type_instance).gauge = 23
+    
+    # Increase counter relatively (collectd caches counters)
+    Collectd.plugin(:plugin_instance).type(:type_instance).count! 5
+    
+    # Set counter absolutely
+    Collectd.plugin(:plugin_instance).type(:type_instance).counter = 42
+
+For convenience, define yourself a global *shortcut*, like:
+
+::
+
+    Stats = Collectd.my_zombie(RAILS_ENV)
+
+To automatically collect *memory and CPU statistics* of your Ruby
+process, do:
+
+::
+
+    Stats.with_full_proc_stats
+
+You can also have the library *poll* for your data, if you feel
+comfortable with that, eg:
+
+::
+
+    Stats.counter(:seconds_elapsed).polled_counter do
+      Time.now.to_i
+    end
+
+
+.. _types.db: http://collectd.org/documentation/manpages/types.db.5.shtml

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'jeweler'
+rescue LoadError
+  raise "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Jeweler::Tasks.new do |s|
+  s.name = "collectd"
+  s.summary = "Send collectd statistics from Ruby"
+  s.email = "astro@spaceboyz.net"
+  s.homepage = "http://github.com/astro/ruby-collectd"
+  s.authors = ["Stephan Maka"]
+  s.files =  FileList["[A-Z]*", "{lib,spec,examples}/**/*"]
+  #s.add_dependency 'eventmachine'
+end
+
+begin
+  require 'spec/rake/spectask'
+  desc "Run all Spec"
+  Spec::Rake::SpecTask.new('spec') do |spec|
+    spec.spec_files = FileList['spec/*.rb']
+    spec.verbose = true
+    spec.warning = true
+    spec.rcov = true
+    spec.rcov_opts = []
+    spec.rcov_opts = ['--exclude', 'spec']
+  end
+rescue LoadError
+  task :spec do
+    abort "Rspec is not available. In order to run rspec, you must: sudo gem install rspec"
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 8
+:major: 0

data/examples/em_sender.rb

@@ -0,0 +1,17 @@
+require 'eventmachine'
+require 'collectd'
+
+EM.run do
+  Collectd::use_eventmachine = true
+  Collectd::add_server 1
+
+  c = 0
+  EM.add_periodic_timer(0.01) do
+    Collectd.ruby_collectd(:test).ping(:fun).gauge = 42 + Math.sin(Time.now.to_f / 600) * 23.5
+    Collectd.ruby_collectd(:test).cpu(:time).counter = c
+
+    c += 1
+    print '.'
+    STDOUT.flush
+  end
+end

data/examples/sender.rb

@@ -0,0 +1,13 @@
+require 'collectd'
+
+Collectd::add_server 1
+
+c = 0
+loop do
+  Collectd.ruby_collectd(:test).ping(:fun).gauge = 42 + Math.sin(Time.now.to_f / 600) * 23.5
+  Collectd.ruby_collectd(:test).cpu(:time).counter = c
+  c += 1
+  sleep 0.01
+  print '.'
+  STDOUT.flush
+end

data/lib/collectd/proc_stats.rb

@@ -2,42 +2,39 @@ module Collectd
   ##
   # Included by Interface
   module ProcStats
-    def with_polled_memory
-      def process_status(field)
-        fields = {}
+    def process_status(field)
+      fields = {}
+      begin
         IO.readlines("/proc/#{$$}/status").each { |line|
           line.strip!
           if line =~ /^(.+?):\s+(.+)$/
             fields[$1] = $2
           end
         }
+      rescue Errno::ENOENT
+        nil
+      else
         fields[field]
       end
+    end
 
+    def with_polled_memory
       memory('VmRSS').polled_gauge do
-        process_status('VmRSS').to_i * 1024
+        v = process_status('VmRSS') ? v.to_i * 1024 : nil
       end
       memory('VmSize').polled_gauge do
-        process_status('VmSize').to_i * 1024
+        v = process_status('VmSize') ? v.to_i * 1024 : nil
       end
 
       self
     end
 
     def with_polled_cpu
-      def schedstats
-        if IO.readlines("/proc/#{$$}/schedstat").to_s =~ /^(\d+) (\d+) (\d+)/
-            [$1.to_i, $2.to_i, $3.to_i]
-        else
-          []
-        end
-      end
-
       cpu('user').polled_counter do
-        schedstats[0]
+        (Process::times.utime * 100).to_i
       end
-      cpu('wait').polled_counter do
-        schedstats[1]
+      cpu('sys').polled_counter do
+        (Process::times.stime * 100).to_i
       end
     end
 

data/spec/interface_spec.rb

@@ -0,0 +1,145 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'collectd'
+
+describe Collectd do
+  before(:each) do
+    Collectd.reset!
+    @server = mock('Server')
+    Collectd << @server
+  end
+
+  it 'should set_counter' do
+    @server.should_receive(:set_counter).
+      with([:plugin1, :plugin_instance1,
+            :type1, :type_instance1], [23])
+    Collectd.plugin1(:plugin_instance1).type1(:type_instance1).counter = 23
+  end
+  it 'should inc_counter' do
+    @server.should_receive(:inc_counter).
+      with([:plugin1, :plugin_instance1,
+            :type1, :type_instance1], [23, 42])
+    Collectd.plugin1(:plugin_instance1).type1(:type_instance1).count! 23, 42
+  end
+  it 'should set_gauge' do
+    @server.should_receive(:set_gauge).
+      with([:plugin1, :plugin_instance1,
+            :type1, :type_instance1], [23, 42, 5])
+    Collectd.plugin1(:plugin_instance1).type1(:type_instance1).gauge = [23, 42, 5]
+  end
+
+  it 'should poll a pollable' do
+    pollable = mock('Pollable')
+    Collectd.add_pollable { |*a|
+      pollable.call *a
+    }
+    pollable.should_receive(:call).with(@server).and_return(nil)
+    Collectd.run_pollables_for @server
+  end
+  it 'should poll a polled_count' do
+    Collectd.plugin1(:plugin_instance1).type1(:type_instance1).polled_count do
+      [23, 42, 5, 7]
+    end
+    @server.should_receive(:inc_counter).
+      with([:plugin1, :plugin_instance1,
+            :type1, :type_instance1], [23, 42, 5, 7])
+    Collectd.run_pollables_for @server
+  end
+  it 'should poll a polled_counter' do
+    Collectd.plugin1(:plugin_instance1).type1(:type_instance1).polled_counter do
+      [23, 42, 5, 7]
+    end
+    @server.should_receive(:set_counter).
+      with([:plugin1, :plugin_instance1,
+            :type1, :type_instance1], [23, 42, 5, 7])
+    Collectd.run_pollables_for @server
+  end
+  it 'should poll a polled_gauge' do
+    Collectd.plugin1(:plugin_instance1).type1(:type_instance1).polled_gauge do
+      [23, 42, 5, 7]
+    end
+    @server.should_receive(:set_gauge).
+      with([:plugin1, :plugin_instance1,
+            :type1, :type_instance1], [23, 42, 5, 7])
+    Collectd.run_pollables_for @server
+  end
+end
+
+class StubServer < Collectd::Values
+  attr_reader :counters
+  attr_reader :gauges
+  def initialize
+    super(1000)
+  end
+end
+
+describe Collectd::ProcStats do
+  before(:each) do
+    Collectd.reset!
+    @server = StubServer.new
+    Collectd << @server
+    Collectd.plugin1(:plugin_instance1).with_full_proc_stats
+    Collectd.run_pollables_for @server
+  end
+
+  context 'when polling memory' do
+    it 'should report VmRSS' do
+      g = @server.gauges[[:plugin1, :plugin_instance1, :memory, "VmRSS"]]
+      g[0].should be_kind_of(Fixnum)
+    end
+    it 'should report VmSize' do
+      g = @server.gauges[[:plugin1, :plugin_instance1, :memory, "VmSize"]]
+      g[0].should be_kind_of(Fixnum)
+    end
+  end
+  context 'when polling cpu' do
+    it 'should report user time' do
+      c = @server.counters[[:plugin1, :plugin_instance1, :cpu, "user"]]
+      c[0].should be_kind_of(Fixnum)
+    end
+    it 'should report system time' do
+      c = @server.counters[[:plugin1, :plugin_instance1, :cpu, "sys"]]
+      c[0].should be_kind_of(Fixnum)
+    end
+  end
+end
+
+describe Collectd::EmPlugin do
+  before(:each) do
+    Collectd.reset!
+    @server = StubServer.new
+    Collectd << @server
+    @df = EM::DefaultDeferrable.new
+    Collectd.plugin1(:plugin_instance1).track_deferrable('df', @df)
+  end
+
+  context 'when succeeding' do
+    it 'should callback' do
+      @df.succeed
+    end
+    it 'should report latency' do
+      @df.succeed
+      g = @server.gauges[[:plugin1, :plugin_instance1, :latency, 'df success']]
+      g[0].should be_kind_of(Numeric)
+    end
+    it 'should increase a counter' do
+      @df.succeed
+      c = @server.counters[[:plugin1, :plugin_instance1, :counter, 'df success']]
+      c[0].should be_kind_of(Numeric)
+    end
+  end
+  context 'when failing' do
+    it 'should callback' do
+      @df.fail
+    end
+    it 'should report latency' do
+      @df.fail
+      g = @server.gauges[[:plugin1, :plugin_instance1, :latency, 'df error']]
+      g[0].should be_kind_of(Numeric)
+    end
+    it 'should increase a counter' do
+      @df.fail
+      c = @server.counters[[:plugin1, :plugin_instance1, :counter, 'df error']]
+      c[0].should be_kind_of(Numeric)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: astro-collectd
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Stephan Maka
@@ -9,31 +9,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-27 00:00:00 -07:00
+date: 2009-05-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
 description: 
-email: stephan@spaceboyz.net
+email: astro@spaceboyz.net
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rst
 files: 
-- lib/collectd/pkt.rb
+- README.rst
+- Rakefile
+- VERSION.yml
+- examples/em_sender.rb
+- examples/sender.rb
+- lib/collectd.rb
 - lib/collectd/em_server.rb
+- lib/collectd/em_support.rb
 - lib/collectd/interface.rb
+- lib/collectd/pkt.rb
 - lib/collectd/proc_stats.rb
 - lib/collectd/server.rb
-- lib/collectd/em_support.rb
-- lib/collectd.rb
+- spec/interface_spec.rb
 has_rdoc: false
 homepage: http://github.com/astro/ruby-collectd
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -53,7 +59,9 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Send collectd statistics from Ruby
-test_files: []
-
+test_files: 
+- spec/interface_spec.rb
+- examples/sender.rb
+- examples/em_sender.rb