graphite-api 0.1.0 → 0.1.1

data/README.md

@@ -50,7 +50,7 @@ Creating a new client instance
 ```ruby
 require 'graphite-api'
 
-GraphiteAPI::Client.new(
+GraphiteAPI.new(
   graphite: "graphite.example.com:2003", # required argument
   prefix: ["example","prefix"],          # add example.prefix to each key
   slice: 60,                             # results are aggregated in 60 seconds slices
@@ -64,7 +64,7 @@ Adding simple metrics
 ```ruby
 require 'graphite-api'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 client.metrics "webServer.web01.loadAvg" => 10.7
 # => webServer.web01.loadAvg 10.7 time.now.to_i
@@ -81,7 +81,7 @@ Adding metrics with timestamp
 ```ruby
 require 'graphite-api'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 client.metrics({
   "webServer.web01.loadAvg"  => 10.7,
@@ -95,7 +95,7 @@ Increment records
 ```ruby
 require 'graphite-api'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 client.increment("jobs_in_queue", "num_errors")
 # => jobs_in_queue 1 Time.now.to_i
@@ -115,7 +115,7 @@ Some DSL sweetness
 ```ruby
 require 'graphite-api'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 client.webServer.web01.loadAvg 10.7 
 # => webServer.web01.loadAvg 10.7 time.now.to_i
@@ -128,7 +128,7 @@ Built-in timers support
 ```ruby
 require 'graphite-api'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 # lets send the metric every 120 seconds
 client.every(120) do |c|
@@ -141,7 +141,7 @@ Built-in extension for time declarations stuff, like 2.minutes, 3.hours etc...
 require 'graphite-api'
 require 'graphite-api/core_ext/numeric'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 client.every 10.seconds do |c|
   c.metrics("webServer.web01.uptime" => `uptime`.split.first.to_i)
@@ -157,7 +157,7 @@ Make your own custom metrics daemons, using `client#join`
 require 'graphite-api'
 require 'graphite-api/core_ext/numeric'
 
-client = GraphiteAPI::Client.new( graphite: 'graphite:2003' )
+client = GraphiteAPI.new( graphite: 'graphite:2003' )
 
 client.every 26.minutes do |c|
   c.metrics("webServer.shuki.stats" => 10)
@@ -185,8 +185,6 @@ GraphiteAPI::Logger.init(
 )
 ```
 
-> more examples can be found [here](https://github.com/kontera-technologies/graphite-api/tree/master/examples).
-
 ## GraphiteAPI-Middleware Usage
 * After installing GraphiteAPI gem, the `graphite-middleware` command should be available.
 
@@ -239,15 +237,12 @@ example.middleware.value2 99 1334929231
 
 ```ruby
 require 'graphite-api'
-client = GraphiteAPI::Client.new(:graphite => 'graphite-middleware-node:2005')
+client = GraphiteAPI.new(:graphite => 'graphite-middleware-node:2005')
 client.example.middleware.value 10.2 
 client.example.middleware.value2 27
 client.bla.bla.value2 27
 ```
 
-> more examples can be found [here](https://github.com/kontera-technologies/graphite-api/tree/master/examples).
-
-
 ## Example Setup
 <br/>
 <img src="https://raw.github.com/kontera-technologies/graphite-api/master/examples/middleware_t1.png" align="center">

data/Rakefile

@@ -2,9 +2,62 @@ $:.unshift File.join(File.dirname(__FILE__), 'lib')
 Dir.chdir File.dirname __FILE__
 
 require 'graphite-api'
+require "rake/testtask"
+require 'rubygems/package_task'
 
 def message msg
   puts "*** #{msg} ***"
 end
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+task(:test => :functional) { ENV['with_coverage'] = "true" }
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "tests"
+  t.pattern = "tests/**/*_test.rb"
+end
+
+task :functional do
+  some_failed = false
+  
+  next unless ENV['SKIP_FUNC'].nil?
+
+  unless RUBY_COPYRIGHT.end_with?("Matsumoto")
+    puts("Functional tests are enabled only on MRI...")
+    next
+  end
+  
+  message "Executing GraphiteAPI Functional Tests"
+  message "( You can skip them by passing SKIP_FUNC=true )"
+
+  Dir[File.expand_path("../tests/functional/*",__FILE__)].each do |file|
+    next unless file.end_with?(".rb")
+    now = Time.now.to_i
+    name = File.basename(file)
+    message "Executing #{name}"
+    Process.waitpid(Process.spawn("ruby", File.expand_path(file)))
+    took = "took #{Time.now.to_i - now} seconds"
+    if $?.success?
+      message "[PASS] #{name}, #{took}"
+    else
+      message "[FAIL] #{name}, #{took}"
+      some_failed = true
+    end
+  end
+  message "Done Executing GraphiteAPI Functional Tests"
+  abort "Some functional tests failed..." if some_failed
+end
+
+task :default => :test
+
+task :gem => [:test,:clobber_package]
+
+GraphiteAPI::GemSpec = eval File.read 'graphite-api.gemspec'
+
+Gem::PackageTask.new(GraphiteAPI::GemSpec) do |p|
+  p.gem_spec = GraphiteAPI::GemSpec
+end
+
+task :install => [:gem] do
+   sh "gem install pkg/graphite-api"
+   Rake::Task['clobber_package'].execute
+end

data/lib/graphite-api.rb

@@ -1,13 +1,13 @@
 require 'zscheduler'
 
 module GraphiteAPI
-  ROOT = File.expand_path(File.dirname(__FILE__))
+  ROOT = File.expand_path File.dirname __FILE__
+
   require "#{ROOT}/graphite-api/version"
 
   autoload :Version,    "#{ROOT}/graphite-api/version"
   autoload :Client,     "#{ROOT}/graphite-api/client"
   autoload :Cache,      "#{ROOT}/graphite-api/cache"
-  autoload :Reactor,    "#{ROOT}/graphite-api/reactor"
   autoload :Connector,  "#{ROOT}/graphite-api/connector"
   autoload :Middleware, "#{ROOT}/graphite-api/middleware"
   autoload :Runner,     "#{ROOT}/graphite-api/runner"
@@ -20,4 +20,8 @@ module GraphiteAPI
     GraphiteAPI::VERSION
   end
   
+  def self.new options
+    Client.new options
+  end
+  
 end

data/lib/graphite-api/buffer.rb

@@ -31,10 +31,7 @@ module GraphiteAPI
       @options = options
       @queue = Queue.new
       @streamer = Hash.new {|h,k| h[k] = ""}
-
-      if options[:cache]
-        @cache = Cache::Memory.new options
-      end
+      @cache = Cache::Memory.new options if options[:cache]
     end
     
     private_reader :queue, :options, :streamer, :cache
@@ -91,7 +88,7 @@ module GraphiteAPI
     
     def inspect
       "#<GraphiteAPI::Buffer:%s @quque#size=%s @streamer=%s>" % 
-        [object_id,queue.size,streamer]
+        [ object_id, queue.size, streamer]
     end
     
     private

data/lib/graphite-api/client.rb

@@ -1,63 +1,17 @@
-# -----------------------------------------------------
-# Graphite Client
-# Send metrics to graphite (or to some kind of middleware/proxy) 
-# -----------------------------------------------------
-# Usage
-#
-#  client = GraphiteAPI::Client.new(  
-#   :graphite => "graphite.example.com:2003",
-#   :prefix   => ["example","prefix"], # add example.prefix to each key
-#   :slice    => 60.seconds            # results are aggregated in 60 seconds slices
-#   :interval => 60.seconds            # send to graphite every 60 seconds
-#  )
-#  
-#  client.webServer.web01.loadAvg 10.7 
-#  # => example.prefix.webServer.web01.loadAvg 10.7 time.now.to_i
-
-#  client.metrics "webServer.web01.loadAvg" => 10.7
-#  # => example.prefix.webServer.web01.loadAvg 10.7 time.now.to_i
-#  
-#  client.metrics({
-#   "webServer.web01.loadAvg"  => 10.7,
-#   "webServer.web01.memUsage" => 40
-#  },Time.at(1326067060))
-#  # => example.prefix.webServer.web01.loadAvg  10.7 1326067060
-#  # => example.prefix.webServer.web01.memUsage 40 1326067060
-# 
-#  #  Timers
-# client.every 10.seconds do |c|
-#   c.webServer.web01.uptime `uptime`.split.first.to_i
-#   # => example.prefix.webServer.web01.uptime 40 1326067060
-# end
-# 
-# client.every 52.minutes do |c|
-#   c.abcd.efghi.jklmnop.qrst 12 
-#   # => example.prefix.abcd.efghi.jklmnop.qrst 12 1326067060
-# end
-# 
-# client.join # wait...
-# -----------------------------------------------------
-
 require File.expand_path '../utils', __FILE__
 
 module GraphiteAPI
   class Client
     include Utils
 
-    private_reader :options, :buffer, :connectors, :direct_send
+    private_reader :options, :buffer, :connectors
 
     def initialize opt
       @options = build_options validate opt.clone
       @buffer  = GraphiteAPI::Buffer.new options
       @connectors = GraphiteAPI::Connector::Group.new options
-      @direct_send = @options[:interval] == 0
-
-      if direct_send
-        options[:slice] = 1
-      else
-        every(options.fetch(:interval),&method(:send_metrics))
-      end
-
+      
+      every options[:interval], &method(:send_metrics) if !options[:direct]
     end
 
     def_delegator Zscheduler, :loop, :join
@@ -68,8 +22,9 @@ module GraphiteAPI
     end
 
     def metrics metric, time = Time.now 
+      return if metric.empty?
       buffer.push :metric => metric, :time => time
-      send_metrics if direct_send
+      send_metrics if options[:direct]
     end
 
     alias_method :add_metrics, :metrics
@@ -104,26 +59,21 @@ module GraphiteAPI
     protected
 
     class Proxy
-      include Utils
-
       def initialize client
-        @client = client
-        @keys = []
+        @client, @keys = client, []
       end
 
-      private_reader :client, :keys
-
       def method_missing m, *args, &block
-        keys.push m
-        if keys.size > 10 # too deep
-          super
+        if @keys.push(m).size > 10 
+          super # too deep
         elsif args.any?
-          client.metrics(Hash[keys.join("."),args.first],*args[1..-1])
+          @client.metrics Hash[
+            @keys.join('.'), args.first
+          ], *args[1..-1]
         else
           self
         end
       end
-
     end
 
     def validate options
@@ -136,6 +86,8 @@ module GraphiteAPI
       default_options.tap do |options_hash|
         options_hash[:backends].push expand_host opt.delete :graphite
         options_hash.merge! opt
+        options_hash[:direct] = options_hash[:interval] == 0
+        options_hash[:slice] = 1 if options_hash[:direct]
       end
     end
 

data/lib/graphite-api/connector.rb

@@ -13,34 +13,23 @@ require 'socket'
 module GraphiteAPI
   class Connector
     class Group
-      include Utils
-
-      private_reader :options, :connectors
-
       def initialize options
-        @options = options
         @connectors = options[:backends].map { |o| Connector.new(*o) }
       end
 
       def publish messages
-        debug [:connector_group,:publish,messages.size, @connectors]
-        Array(messages).each { |msg| connectors.map {|c| c.puts msg} }
+        Logger.debug [:connector_group, :publish, messages.size, @connectors]
+        Array(messages).each { |msg| @connectors.map {|c| c.puts msg} }
       end
-
     end
-
-    include Utils
     
     def initialize host, port
-      @host = host
-      @port = port
+      @host, @port = host, port
     end
     
-    private_reader :host, :port
-    
     def puts message
       begin
-        debug [:connector,:puts,[host,port].join(":"),message]
+        Logger.debug [:connector,:puts,[@host, @port].join(":"),message]
         socket.puts message + "\n"
       rescue Errno::EPIPE, Errno::EINVAL
         @socket = nil
@@ -56,8 +45,8 @@ module GraphiteAPI
     
     def socket
       if @socket.nil? || @socket.closed?
-        debug [:connector,[host,port]]
-        @socket = ::TCPSocket.new host, port
+        Logger.debug [:connector,[@host,@port]]
+        @socket = ::TCPSocket.new @host, @port
       end
       @socket
     end

data/lib/graphite-api/middleware.rb

@@ -66,7 +66,7 @@ module GraphiteAPI
         end
 
         # Send metrics to graphite every X seconds
-        Zscheduler.every(options[:interval],:on_shutdown => true) do
+        Zscheduler.every(options[:interval], :on_shutdown => true) do
           group.publish buffer.pull :string if buffer.new_records?
         end
 

data/lib/graphite-api/runner.rb

@@ -11,12 +11,12 @@ module GraphiteAPI
     
     def run
       Logger.init Hash[[:std,:level].zip options.values_at(:log_file, :log_level) ]
-      options[:daemonize] ? daemonize(options[:pid]) { run! } : run!
+      options[:daemonize] ? daemonize(options[:pid], &method(:run!)) : run!
     end
 
     private
     
-    def daemonize pid
+    def daemonize pid, &block
       block_given? or raise ArgumentError.new "the block is missing..."
 
       fork do
@@ -27,7 +27,7 @@ module GraphiteAPI
         STDOUT.reopen('/dev/null','a')
         STDERR.reopen('/dev/null','a')
         File.open(pid,'w') { |f| f.write(Process.pid) } rescue nil
-        yield
+        block.call
       end
     end
     

data/lib/graphite-api/version.rb

@@ -1,3 +1,3 @@
 module GraphiteAPI
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphite-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -66,8 +66,6 @@ files:
 - lib/graphite-api/utils.rb
 - lib/graphite-api/version.rb
 - lib/graphite-api.rb
-- tasks/build.rake
-- tasks/tests.rake
 homepage: http://www.kontera.com
 licenses: []
 post_install_message: 

data/tasks/build.rake

@@ -1,32 +0,0 @@
-require 'rubygems/package_task'
-
-GraphiteAPI::GemSpec = Gem::Specification.new do |s|
-  s.name                  = "graphite-api"
-  s.version               = GraphiteAPI.version
-  s.platform              = Gem::Platform::RUBY
-  s.summary               = "Graphite Ruby Client"
-  s.description           = "Graphite API - A Simple ruby client, aggregator daemon and API tools"
-  s.author                = "Eran Barak Levi"
-  s.email                 = 'eran@kontera.com'
-  s.homepage              = 'http://www.kontera.com'
-  s.executables           = %w(graphite-middleware)
-  s.required_ruby_version = '>= 1.8.7'
-  s.rubyforge_project     = "graphite-api"
-  s.files                 = %w(README.md Rakefile) + Dir.glob("{bin,lib,test,tasks}/**/*")
-  s.require_path          = "lib"
-  s.bindir                = "bin"
-
-  s.add_dependency 'eventmachine','>= 0.3.3'
-  s.add_dependency 'zscheduler',  '>= 0.0.3'
-end
-
-task :gem => [:test,:clobber_package]
-
-Gem::PackageTask.new(GraphiteAPI::GemSpec) do |p|
-  p.gem_spec = GraphiteAPI::GemSpec
-end
-
-task :install => [:gem] do
-   sh "gem install pkg/graphite-api"
-   Rake::Task['clobber_package'].execute
-end

data/tasks/tests.rake

@@ -1,42 +0,0 @@
-require "rake/testtask"
-
-task(:test => :functional) { ENV['with_coverage'] = "true" }
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "tests"
-  t.pattern = "tests/**/*_test.rb"
-end
-
-
-task :functional do
-  some_failed = false
-  
-  next unless ENV['SKIP_FUNC'].nil?
-
-  unless RUBY_COPYRIGHT.end_with?("Matsumoto")
-    puts("Functional tests are enabled only on MRI...")
-    next
-  end
-  
-  message "Executing GraphiteAPI Functional Tests"
-  message "( You can skip them by passing SKIP_FUNC=true )"
-
-  Dir[File.expand_path("../../tests/functional/*",__FILE__)].each do |file|
-    next unless file.end_with?(".rb")
-    now = Time.now.to_i
-    name = File.basename(file)
-    message "Executing #{name}"
-    Process.waitpid(Process.spawn("ruby", File.expand_path(file)))
-    took = "took #{Time.now.to_i - now} seconds"
-    if $?.success?
-      message "[PASS] #{name}, #{took}"
-    else
-      message "[FAIL] #{name}, #{took}"
-      some_failed = true
-    end
-  end
-  message "Done Executing GraphiteAPI Functional Tests"
-  abort "Some functional tests failed..." if some_failed
-end
-
-task :default => :test