drone_collectd 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc/
+Gemfile.lock
+pkg/*
+doc/

data/.yardopts

@@ -0,0 +1 @@
+--no-private lib/**/*.rb - README.md LICENSE examples/*.rb

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in drone_collectd.gemspec
+gemspec
+
+
+gem 'drone', :path => "/Users/schmurfy/Dev/personal/drone"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2011 Julien Ammous
+
+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/README.md

@@ -0,0 +1,24 @@
+## What is this
+
+It is an output interface to collectd for Drone.<br/>
+You can find more about Drone [here](https://github.com/schmurfy/drone)
+
+# Supported Runtimes
+
+- MRI 1.8.7+
+- Rubinius 1.2.2+
+
+
+# How to use
+
+First you obviously need a collectd server (or any server able to receive collectd network packets),
+after that you need to add those lines to your types.db config file if you use collectd:
+
+    meter         mean:GAUGE:U:U, rate1:GAUGE:U:U, rate5:GAUGE:U:U, rate15:GAUGE:U:U
+    timer         min:GAUGE:0:U,  max:GAUGE:0:U,  mean:GAUGE:0:U, stddev:GAUGE:U:U, median:GAUGE:0:U, p75:GAUGE:0:U, p95:GAUGE:0:U
+
+They are required to be able to understand timers and meters sent from Drone, you can update the timer
+as you wish to add/remove pecentiles (check examples/collectd to see how to configure the interface for that).
+
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+
+begin
+  require 'yard'
+  require 'bluecloth'
+  YARD::Rake::YardocTask.new(:doc)
+rescue
+  
+end

data/drone_collectd.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "drone_collectd/version"
+
+Gem::Specification.new do |s|
+  s.name        = "drone_collectd"
+  s.version     = DroneCollectd::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Julien Ammous"]
+  s.email       = []
+  s.homepage    = ""
+  s.summary     = %q{Drone Collectd Interface}
+  s.description = %q{Collectd Interface for Drone}
+
+  s.rubyforge_project = "drone_collectd"
+
+  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"]
+  
+  s.add_dependency('drone',         '~> 0.0.3')
+  s.add_dependency('eventmachine',  '~> 0.12.10')
+  
+  s.add_development_dependency("mocha")
+  s.add_development_dependency("bacon")
+  s.add_development_dependency("schmurfy-em-spec")
+  s.add_development_dependency("delorean")
+  s.add_development_dependency("simplecov")
+end

data/examples/collectd.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'drone'
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'drone_collectd'
+
+
+Drone::init_drone()
+Drone::register_gauge("cpu:user/gauge"){ rand(200) }
+
+class User
+  include Drone::Monitoring
+  
+  def initialize(name)
+    @name = name
+  end
+  
+  monitor_rate("apps:app1/meter")
+  def rename(new_name)
+    @name = new_name
+  end
+  
+  monitor_time("apps:app1/timer")
+  def do_something
+    # just eat some cpu
+    0.upto(rand(2000)) do |n|
+      str = "a"
+      200.times{ str << "b" }
+    end
+  end
+end
+
+EM::run do
+  Drone::add_output(:collectd, 2,
+      :hostname => 'my_app',
+      :address => '127.0.0.1',
+      :port => 25826,
+      :percentiles => [0.5, 0.75, 0.95]
+    )
+  Drone::start_monitoring()
+  
+  counter1 = Drone::register_counter("apps:app1/counter")
+  counter1.increment()
+  
+  a = User.new("bob")
+  
+  EM::add_periodic_timer(2) do
+    rand(100).times{|n| a.rename("user#{n}") }
+    counter1.increment()
+  end
+  
+  EM::add_periodic_timer(1) do
+    a.do_something()
+  end
+end

data/lib/drone_collectd/collectd.rb

@@ -0,0 +1,98 @@
+require File.expand_path('../parser', __FILE__)
+
+module Drone
+  module Interfaces
+    
+    ##
+    # Send data to collectd periodically, this interface except
+    # a specific format for the metric names which is:
+    # 
+    # plugin[:plugin_instance]/type[:type_instance]
+    # the simplest form being:
+    # plugin/type
+    # 
+    class Collectd < Base
+      include DroneCollectd
+      
+      # 1.9 only ...
+      # NAME_FORMAT = %r{(?<plugin>\w+)(:(?<plugin_instance>\w+))?/(?<type>\w+)(:(?<type_instance>\w+))?}
+      
+      NAME_FORMAT = %r{(\w+)(?::(\w+))?/(\w+)(?::(\w+))?}
+      
+      ##
+      # Instantiate a collectd interface
+      # 
+      # @param [Numeric] period the period passed to the Base class
+      # @param [String] hostname the hostname to use for collectd
+      # @param [String] address the address where the collectd daemon is listening
+      # @param [Numeric] port The collectd daemon port
+      # 
+      def initialize(period, args = {})        
+        super(period)
+        @hostname = args.delete(:hostname)
+        @address = args.delete(:address) || '127.0.0.1'
+        @port = args.delete(:port) || 25826
+        @reported_percentiles = args.delete(:percentiles)
+        @socket = EM::open_datagram_socket('0.0.0.0', nil)
+        
+        unless args.empty?
+          raise ArgumentError, "unknown keys: #{args.keys}"
+        end
+      end
+      
+      def output
+        
+        Drone::each_metric do |m|
+          # parse the name
+          if NAME_FORMAT.match(m.name)
+            # build the packet
+            data = DroneCollectd::CollectdPacket.new
+            data.host = @hostname
+            data.time = Time.now.to_i
+            data.interval = @period
+            data.plugin = $1.to_s
+            data.plugin_instance = $2.to_s
+            data.type = $3.to_s
+            data.type_instance = $4.to_s
+            
+            case m
+            when Metrics::Counter
+              data.add_value(:counter, m.value )
+              
+            when Metrics::Gauge
+              data.add_value(:gauge, m.value )
+              
+            when Metrics::Meter
+              # mean:GAUGE:U:U, rate1:GAUGE:U:U, rate5:GAUGE:U:U, rate15:GAUGE:U:U
+              data.add_value(:gauge, m.mean_rate )
+              data.add_value(:gauge, m.one_minute_rate )
+              data.add_value(:gauge, m.five_minutes_rate )
+              data.add_value(:gauge, m.fifteen_minutes_rate )
+            
+            when Metrics::Timer
+              # min:GAUGE:0:U,  max:GAUGE:0:U,  mean:GAUGE:0:U, stddev:GAUGE:U:U, median:GAUGE:0:U, p75:GAUGE:0:U, p95:GAUGE:0:U
+              data.add_value(:gauge, m.min )
+              data.add_value(:gauge, m.max )
+              data.add_value(:gauge, m.mean )
+              data.add_value(:gauge, m.stdDev )
+              
+              percs = m.percentiles( *@reported_percentiles )
+              percs.each do |p|
+                data.add_value(:gauge, p )
+              end
+            
+            end
+            
+            # and send it
+            @socket.send_datagram(data.build_packet, @address, @port)
+          else
+            puts "Metric with incorrect name ignored: #{m.name}"
+          end
+        end
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/drone_collectd/parser.rb

@@ -0,0 +1,86 @@
+module DroneCollectd
+  class CollectdPacket
+    # part type
+    HOST            = 0x0000
+    TIME            = 0x0001
+    PLUGIN          = 0x0002
+    PLUGIN_INSTANCE = 0x0003
+    TYPE            = 0x0004
+    TYPE_INSTANCE   = 0x0005
+    VALUES          = 0x0006
+    INTERVAL        = 0x0007
+    MESSAGE         = 0x0100
+    SEVERITY        = 0x0101
+    
+    # data type
+    COUNTER   = 0
+    GAUGE     = 1
+    DERIVE    = 2
+    ABSOLUTE  = 3
+    
+    
+    attr_accessor :host, :time, :interval
+    attr_accessor :plugin, :plugin_instance
+    attr_accessor :type, :type_instance
+    
+    def initialize
+      @values = []
+      @values_type = []
+    end
+    
+    def add_value(type, value)
+      raise(ArgumentError, "unknown type: #{type}") unless CollectdPacket::const_defined?(type.to_s.upcase)
+      data_type = CollectdPacket::const_get(type.to_s.upcase)
+      
+      @values_type << data_type
+      @values << value
+    end
+    
+    def build_packet
+      @pkt =  CollectdGenerator::string(HOST, @host)
+      @pkt << CollectdGenerator::number(TIME, @time)
+      @pkt << CollectdGenerator::number(INTERVAL, @interval)
+      @pkt << CollectdGenerator::string(PLUGIN, @plugin)
+      @pkt << CollectdGenerator::string(PLUGIN_INSTANCE, @plugin_instance)
+      @pkt << CollectdGenerator::string(TYPE, @type)
+      @pkt << CollectdGenerator::string(TYPE_INSTANCE, @type_instance)
+      
+      # values part header
+      @pkt << [VALUES, 4 + 2 + (@values.size * 9), @values.size].pack('nnn')
+      # types
+      @pkt << @values_type.pack('C*')
+      
+      # and the values
+      @values.each.with_index do |v, i|
+        case @values_type[i]
+        when COUNTER, ABSOLUTE, DERIVE
+          @pkt << [v >> 32, v & 0xffffffff].pack("NN")
+          
+        when GAUGE
+          @pkt << [v].pack('E')
+          
+        else
+          raise "unknown type: #{@values_type[i]}"
+        end
+      end
+      
+      @pkt
+    end
+      
+  end
+  
+  module CollectdGenerator
+    # Encode a string (type 0, null terminated string)
+    def self.string(type, str)
+      str += "\000"
+      str_size = str.respond_to?(:bytesize) ? str.bytesize : str.size
+      [type, 4 + str_size].pack("nn") + str
+    end
+    
+    # Encode an integer
+    def self.number(type, num)
+      [type, 12].pack("nn") + [num >> 32, num & 0xffffffff].pack("NN")
+    end
+  end
+  
+end

data/lib/drone_collectd/version.rb

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

data/lib/drone_collectd.rb

@@ -0,0 +1,8 @@
+module DroneCollectd
+  def self.require_lib(path)
+    require File.expand_path("../#{path}", __FILE__)
+  end
+  
+  require_lib('drone_collectd/version')
+  require_lib('drone_collectd/collectd')
+end

data/specs/common.rb

@@ -0,0 +1,63 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+
+puts "Testing with ruby #{RUBY_VERSION} and rubygems #{Gem::VERSION}"
+
+require 'bundler/setup'
+
+if (RUBY_VERSION >= "1.9") && ENV['COVERAGE']
+  require 'simplecov'
+  ROOT = File.expand_path('../../', __FILE__)
+  
+  puts "[[  SimpleCov enabled  ]]"
+  
+  SimpleCov.start do
+    add_filter '/gems/'
+    add_filter '/specs/'
+    
+    root(ROOT)
+  end
+end
+
+require 'bacon'
+require 'mocha'
+require 'delorean'
+require 'em-spec/bacon'
+EM.spec_backend = EventMachine::Spec::Bacon
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+module Bacon
+  module MochaRequirementsCounter
+    def self.increment
+      Counter[:requirements] += 1
+    end
+  end
+  
+  class Context
+    include Mocha::API
+    
+    alias_method :it_before_mocha, :it
+    
+    def it(description)
+      it_before_mocha(description) do
+        begin
+          mocha_setup
+          yield
+          mocha_verify(MochaRequirementsCounter)
+        rescue Mocha::ExpectationError => e
+          raise Error.new(:failed, "#{e.message}\n#{e.backtrace[0...10].join("\n")}")
+        ensure
+          mocha_teardown
+        end
+      end
+    end
+  end
+end
+
+def focus(test_label)
+  Bacon.const_set(:RestrictName, %r{#{test_label}})
+end
+
+Bacon.summary_on_exit()

data/specs/unit/parser_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../common', __FILE__)
+
+require 'drone_collectd/parser'
+include DroneCollectd
+
+describe 'Packet Parser' do
+  before do
+    @packet = CollectdPacket.new()
+    
+    @packet.host = "localhost"
+    @packet.time = 1
+    @packet.interval = 10
+    @packet.plugin = "plugin"
+    @packet.plugin_instance = "plugin_instance"
+    @packet.type = "type"
+    @packet.type_instance = "type_instance"
+    @packet.add_value(:counter, 42)
+  end
+  
+  it 'can generate a packet' do
+    expected = [
+        "\x00\x00\x00\x0elocalhost\x00",                    # host
+        "\x00\x01\x00\x0c\x00\x00\x00\x00\x00\x00\x00\x01", # time
+        "\x00\x07\x00\x0c\x00\x00\x00\x00\x00\x00\x00\x0a", # interval
+        "\x00\x02\x00\x0bplugin\x00",                       # plugin
+        "\x00\x03\x00\x14plugin_instance\x00",              # plugin_instance
+        "\x00\x04\x00\x09type\x00",                         # type
+        "\x00\x05\x00\x12type_instance\x00",                # type_instance
+        "\x00\x06\x00\x0f\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x2a"  # value
+        
+      ]
+    
+    if "".respond_to?(:encode)
+      expected = expected.map{|s| s.encode('ASCII') }
+    end
+    
+    data = @packet.build_packet
+    
+    data[0,14].should == expected[0]
+    data[14,12].should == expected[1]
+    data[26,12].should == expected[2]
+    data[38,11].should == expected[3]
+    data[49,20].should == expected[4]
+    data[69, 9].should == expected[5]
+    data[78,18].should == expected[6]
+    data[96,15].should == expected[7]
+  end
+  
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: drone_collectd
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Julien Ammous
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: drone
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 12
+        - 10
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: schmurfy-em-spec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: delorean
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: Collectd Interface for Drone
+email: []
+
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- drone_collectd.gemspec
+- examples/collectd.rb
+- lib/drone_collectd.rb
+- lib/drone_collectd/collectd.rb
+- lib/drone_collectd/parser.rb
+- lib/drone_collectd/version.rb
+- specs/common.rb
+- specs/unit/parser_spec.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: drone_collectd
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Drone Collectd Interface
+test_files: []
+
+has_rdoc: