drone 1.0.2 → 1.0.4

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/.yardopts

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

data/Gemfile

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

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,162 @@
+
+# What is this ?
+
+Drone is a monitoring library designed to collect data from your application and export them
+to virtually any monitoring tool.
+Its core is heavily based on the impressive works of Coda Hale on the metrics java library.
+
+A fully working example is included in examples/simple, to run it
+(I suppose you already cloned the repository and have a prompt at the root of it):
+
+    gem install bundler
+    bundle
+    ruby examples/simple.rb
+  
+The example will output the collected statistics directly on the console every second.
+
+# Supported Runtimes
+
+- MRI 1.8.7+
+- Rubinius 1.2.2+
+
+
+# Status
+ - Most of the features I wanted in are (see below for usage examples):
+  - timing method calls
+  - method calls rate
+  - counters
+  - gauges
+
+ - Good test coverage
+ 
+ The gem was created for a specific need and is currently used in preproduction environment,
+ no major bugs until now.
+
+
+# How is it done
+
+The library is split in different parts
+
+- the core:<br/>
+  it contains all the API used to declare which data to collect and how as well as the storage for them
+
+- the metrics:<br/>
+  that is all the metrics type the library know.
+
+- the interfaces:<br/>
+  those are the parts which will decides how the stored data are made available.
+
+- the schedulers:</br>
+  this is where the timers are scheduled, currently there is only one scheduler: eventmachine
+
+- the storage:<br/>
+  this part decides where the actual data for the metrics are stored, the default is to store them
+  in memory but other possible options are: redis, memcached, etc...
+  The goal for external storage is to allow concurrent applications to share the same metrics, an
+  immediate example of such application is a rails application ran under passenger or any other spawner
+
+## Constraints
+
+- the name of each metric can be formatted how it pleases you (note that output interfaces may expect some format)
+  but the name is expected to be unique or you could end up reusing the same metric without wanting it.
+  (this only applies to monitor_time and monitor_rate helpers but could apply anywhere else as needed)
+
+# Usage
+  
+  I try to keep things as simple as possible, there is currently two ways to use
+  this library:
+  
+  - the first one is to just instantiate metrics by hand and use them directly
+  
+      ``` ruby
+      require 'drone'
+      Drone::init_drone()
+      @counter = Drone::Metris::Counter.new('my_counter')
+    
+      def some_method
+        @counter.inc()
+      end
+      ```
+  
+  - the other way is to instrument a class:
+  
+      ``` ruby
+      require 'drone'
+      Drone::init_drone()
+      
+      class User
+        include Drone::Monitoring
+        
+        monitor_rate("users/new")
+        def initialize(login, pass); end
+        
+        monitor_time("users/rename")
+        def rename(new_login); end
+        
+      end
+      ```
+      
+      This code will create three metrics:
+      - "users/new"       : how many users are created each second
+      - "users/rename"    : how much time renaming a user takes and how many users are renamed
+                            each second
+      
+  
+Once you have your data you need to add a way to serve them, each lives in a separate
+gem to limit the core's dependencies so the only one in core is:
+  
+  - console output (puts), mainly for debug:
+  
+      ``` ruby
+      require 'drone'
+      Drone::init_drone()
+      Drone::add_output(:console, 1)
+      ```
+      
+      The values will be printed on the console at the inter
+  
+  The others output are available in their own gems:
+  
+  - drone_json:<br/>
+    The stats are served by a thin server in json
+  
+  - drone_collectd:<br/>
+    The stats are send to a collectd daemon.
+  
+# Goals
+
+  My goal is to be able to serve stats efficiently from any ruby 1.9 application built
+  on top of eventmachine and fibers but I built the library to allow non eventmachine uses too, for
+  now the only part where eventmachine is required is the scheduler.
+  
+  Implementing a scheduler based on a background Thread is possible but before that work
+  needs to be done to ensure thread safety, Actually the library is not thread safe.
+  
+  if someone wants to implements it I am not against it but I prefer it to be added as an
+  optional part instead of in the core. There should not be any problem to implements it
+  in an includable module not included as default (it may requires some modifications in the core):
+  
+  ``` ruby
+  require 'drone'
+  require 'drone/threadsafe'
+    
+  # [...]
+  ```
+  
+# Development
+
+  Installing the development environment is pretty simple thanks to bundler:
+  
+    gem install bundler
+    bundle
+  
+## Running specs
+  
+  The specs are written with bacon, mocha and em-spec, they can be ran with:
+  
+    rake spec
+  
+## Build the doc
+  You will need the gems: yard and bluecloth and then run:
+  
+    rake doc

data/Rakefile

@@ -0,0 +1,49 @@
+require 'bundler'
+
+# Bundler::GemHelper.install_tasks
+
+GEM_FOLDER = File.expand_path('../pkg', __FILE__)
+
+
+def build_gem(path)
+  dir = File.dirname(path)
+  f = File.basename(path)
+  
+  sh "cd #{dir} && gem build #{f} && mv *.gem #{GEM_FOLDER}/"
+end
+
+task :build do
+  # drone
+  build_gem(File.expand_path('../drone.gemspec', __FILE__))
+  
+  # extensions
+  Dir["extensions/**/*.gemspec"].each do |path|
+    build_gem(path)
+  end
+
+end
+
+
+# task :release do
+#   Dir.chdir(File.expand_path('../pkg', __FILE__)) do
+#     %()
+#     
+#   end
+# end
+
+task :spec do
+  ENV['COVERAGE'] = "1"
+  Dir.chdir( File.dirname(__FILE__) ) do
+    Dir["specs/**/*_spec.rb"].each do |path|
+      load(path)
+    end
+  end
+end
+
+begin
+  require 'yard'
+  require 'bluecloth'
+  YARD::Rake::YardocTask.new(:doc)
+rescue LoadError
+  
+end

data/drone.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "drone/version"
+
+Gem::Specification.new do |s|
+  s.name        = "drone"
+  s.version     = Drone::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Julien Ammous"]
+  s.email       = []
+  s.homepage    = ""
+  s.summary     = %q{Drone is a monitoring library}
+  s.description = %q{Drone is a monitoring library based on the metrics java library}
+
+  s.rubyforge_project = "drone"
+
+  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("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/simple.rb

@@ -0,0 +1,50 @@
+require File.expand_path('../common', __FILE__)
+init_environment()
+
+require 'fiber'
+
+Drone::init_drone()
+Drone::register_gauge("cpu:0/user"){ rand(200) }
+
+class User
+  include Drone::Monitoring
+  
+  def initialize(name)
+    @name = name
+  end
+  
+  monitor_rate("users:rename:rate")
+  def rename(new_name)
+    @name = new_name
+  end
+  
+  monitor_time("users:do_something:time")
+  monitor_rate("users:do_something:rate")
+  def do_something
+    # fb = Fiber.current
+    # EM::add_timer(1){ fb.resume() }
+    # Fiber.yield
+  end
+end
+
+Drone::add_output(:console, 1)
+
+EM::run do
+  Drone::start_monitoring()
+  
+  counter1 = Drone::register_counter("something_counted")
+  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(2) do
+    Fiber.new do
+      a.do_something()
+    end.resume
+  end
+end

data/lib/drone.rb

@@ -0,0 +1,23 @@
+
+module Drone
+  def self.require_lib(path)
+    require File.expand_path("../#{path}", __FILE__)
+  end
+  
+  require_lib("drone/version")
+  
+  require_lib("drone/monitoring")
+  
+  # Schedulers
+  require_lib("drone/schedulers/eventmachine")
+  
+  # Metrics
+  require_lib("drone/metrics/counter")
+  require_lib("drone/metrics/gauge")
+  require_lib("drone/metrics/histogram")
+  require_lib("drone/metrics/meter")
+  require_lib("drone/metrics/timer")
+  
+  # Output
+  require_lib("drone/interfaces/console")
+end

data/lib/drone/core.rb

@@ -0,0 +1,141 @@
+require 'forwardable'
+
+
+require File.expand_path('../schedulers/eventmachine', __FILE__)
+
+require File.expand_path('../storage/memory', __FILE__)
+
+module Drone
+  ##
+  # This module contains all the metrics you can use to collect data
+  # 
+  module Metrics; end
+  
+  
+  ##
+  # This module contains all the interfaces to the outside world,
+  # they are the only way to communicate with external applications
+  # 
+  module Interface; end
+  
+  
+  ##
+  # This module contains the class used for scheduling timers
+  # 
+  module Schedulers; end
+  
+  
+  ##
+  # This module contains the class used for storage,
+  # they determine where the metric's data are stored
+  # 
+  module Storage; end
+  
+  class <<self
+    extend Forwardable
+    
+    def init_drone(scheduler = Schedulers::EMScheduler, storage = Storage::Memory.new)
+      @metrics = []
+      @scheduler = scheduler
+      @storage = storage
+      @monitored_classes = []
+      @output_modules = []
+    end
+    
+    ##
+    # Start monitoring.
+    # This method needs to be called when the timers can be started
+    # In the case of eventmachine scheduler it needs to be called
+    # in the EM::run block
+    # 
+    def start_monitoring
+      @scheduler.start()
+    end
+    
+    def each_metric
+      raise "Block expected" unless block_given?
+      @metrics.each{|m| yield(m) }
+    end
+    
+    
+    ##
+    # Fetch a metric by its name
+    # 
+    # @param [String] name The mtric's name
+    # 
+    def find_metric(name)
+      @metrics.detect{|m| m.name == name }
+    end
+    
+    ##
+    # Instantiate an output module.
+    # 
+    # @param [String,Symbol] type Class name in lowercase
+    # @param [Array] args additional parameters will be sent to thh
+    #   class constructor
+    # 
+    def add_output(type, *args)
+      class_name = type.to_s.capitalize
+      klass = Drone::Interfaces.const_get(class_name)
+      @output_modules << klass.new(*args)
+    end
+    
+    ##
+    # Register a new counter
+    # @see Drone::Metrics::Counter
+    # @param [String] type Name of this metric
+    # @api public
+    # 
+    def register_counter(type)
+      register_metric( Drone::Metrics::Counter.new(type) )
+    end
+    
+    
+    ##
+    # Register an Histogram
+    # @see Drone::Metrics::Histogram
+    # @param [String] name Name of this metric
+    # @param [optional,Enum] type one of Drone::Metrics::Histogram::TYPE_UNIFORM or Drone::Metrics::Histogram::TYPE_BIASED
+    # 
+    def register_histogram(name, type = :uniform)
+      register_metric( Drone::Metrics::Histogram.new(name, type) )
+    end
+    
+    ##
+    # Register a new gauge
+    # @see Drone::Metrics::Gauge
+    # @param [String] type Name of this metric
+    # @api public
+    # 
+    def register_gauge(type, &block)
+      register_metric( Drone::Metrics::Gauge.new(type, &block) )
+    end
+    
+    ##
+    # Register a new metric
+    # This method can be used bu the user but the prefered
+    # way is to use the register_counter / register_gauge methods
+    # 
+    # @param [Metric] metric The Metric to register
+    # @private
+    # 
+    def register_metric(metric)
+      @metrics << metric
+      metric
+    end
+    
+    
+    def_delegators :@storage, :request_fixed_size_array, :request_number, :request_hash
+    def_delegators :@scheduler, :schedule_periodic, :schedule_once
+    
+    
+    
+    ##
+    # Register a monitored class.
+    # @private
+    # 
+    def register_monitored_class(klass)
+      @monitored_classes << klass
+    end
+  end
+end