mini_graphite 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96afb08d730f3a00ba47725ce3b39eae492368e4
-  data.tar.gz: 1b2a2350de858f406a671e2e4e2390e6f66b001e
+  metadata.gz: d6a5d36496ba99732fa43057a862b1c0583fe551
+  data.tar.gz: 9c26d7b512a3777b73dfaa5c7ef542a112650393
 SHA512:
-  metadata.gz: 09f08e5c5fd678fb01bd59c7faf730022fc9aaed46d9f2cb70eb890b72dd993de8978e80591b566b8e37e9a2af8f8f96ed3af6184621672f62c3ede42078f62f
-  data.tar.gz: bfcc21cfeca12874cf435d9491bf6434e1613324392e69abe2692a84e625288f1fa97a173c9639c09e843cc928eef1889ee0693a11e0cb4c42962d8abbd4cf30
+  metadata.gz: 7927a29a703f55f6f35db557cdaf49856fe9f055953ecdd03dde95272f040c9e7d4be691d17bdce56033268873c03f43211618384b1d3fa22cf88bea6b22c2bf
+  data.tar.gz: 3e8247385c1f9d482bf7bb51a554049f2422e4f0798d92a7b4d8a179c567243aafc943faea4a917851b0491b750a733fe1b35028ec46640611a0d0f9cd30c9da

data/README.md

@@ -2,6 +2,10 @@
 
 Simple wrapper for Graphite and Statsd
 
+## Instructions
+
+Check the `test` folder for examples, if you need more explanations please contact us.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +22,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    Dalia::MiniGraphite.config({
+      :graphite_host => "my.graphite.server.com",
+      :graphite_port => 2003, # default 2003
+      :statsd_host => "my.graphite.server.com",
+      :statsd_port => 8125, # default 8125
+      :mock_mode => false, # default false
+      :debug_mode => true # default false
+    })
+
+    Dalia::MiniGraphite.datapoint("my.key", 120, Time.now) # to Graphite
+    Dalia::MiniGraphite.counter("my.key", 120) # to StatSD
+
+
+This will send 4 signals:
+
+- key_prefix.ini            # At the begining of the block
+- key_prefix.count          # At the begining of the block, keep it for compatibility
+- key_prefix.time, ~1000    # At the end of the block, with the Benchmark.realtime result of the execution
+- key_prefix.end            # At the end of the block
+
+    result =
+      Dalia::MiniGraphite.benchmark_wrapper("key_prefix") do
+        sleep(1)
+        "RESULT"
+      end
+
+    puts result # => RESULT
+
 
 ## Contributing
 

data/lib/mini_graphite.rb

@@ -1,61 +1,80 @@
 require_relative "mini_graphite/version"
 require_relative "mini_graphite/logger"
+require "benchmark"
 
 require "socket"
 
 module Dalia
-	module MiniGraphite
-		DEFAULTS = {
-			:graphite_host => "graphite.host.com",
-			:graphite_port => 2003,
-			:statsd_host => "statsd.host.com",
-			:statsd_port => 8125,
-			:mock_mode => false,
-			:debug_mode => false
-		}
-
-		def self.config(opts = {})
-			@opts = DEFAULTS.merge(opts)
-			@logger = Dalia::MiniGraphite::Logger.new(opts[:debug_mode])
-			logger.debug("Initalized with opts")
-			logger.debug(opts.inspect)
-		end
-
-		def self.datapoint(key, value = 1, timestamp = Time.now)
-			signal = "#{key} #{value} #{timestamp.to_i}"
-			logger.debug("Sending datapoint: '#{signal}'")
-
-			send_tcp(signal) if !opts[:mock_mode]
-		end
-
-		def self.counter(key, value = 1)
-			signal = "#{key}:#{value}|c"
-			logger.debug("Sending counter: '#{signal}'")
-
-			send_udp(signal) if !opts[:mock_mode]
-		end
-
-	private
-
-		def self.opts
-			@opts
-		end
-
-		def self.logger
-			@logger
-		end
-
-		def self.send_tcp(message)
-			socket = TCPSocket.new(opts[:graphite_host], opts[:graphite_port])
-			socket.print("#{message}\n")
-			socket.close
-		end
-
-		def self.send_udp(message)
-			socket = UDPSocket.new
-			socket.send(message, 0, opts[:statsd_host], opts[:statsd_port])
-			socket.close
-		end
-
-	end
+  module MiniGraphite
+    DEFAULTS = {
+      :graphite_host => "graphite.host.com",
+      :graphite_port => 2003,
+      :statsd_host => "statsd.host.com",
+      :statsd_port => 8125,
+      :mock_mode => false,
+      :debug_mode => false
+    }
+
+    def self.config(opts = {})
+      @opts = DEFAULTS.merge(opts)
+      @logger = Dalia::MiniGraphite::Logger.new(opts[:debug_mode])
+      logger.debug("Initalized with opts")
+      logger.debug(opts.inspect)
+    end
+
+    def self.datapoint(key, value = 1, timestamp = Time.now)
+      signal = "#{key} #{value} #{timestamp.to_i}"
+      logger.debug("Sending datapoint: '#{signal}'")
+
+      send_tcp(signal) if !opts[:mock_mode]
+    end
+
+    def self.counter(key, value = 1)
+      signal = "#{key}:#{value}|c"
+      logger.debug("Sending counter: '#{signal}'")
+
+      send_udp(signal) if !opts[:mock_mode]
+    end
+
+    def self.benchmark_wrapper(key)
+      counter("#{key}.ini")
+
+      result = nil
+
+      time =
+        Benchmark.realtime do
+          result = yield
+        end
+
+      counter("#{key}.count")
+      counter("#{key}.time", time * 1000)
+
+      counter("#{key}.end")
+
+      result
+    end
+
+  private
+
+    def self.opts
+      @opts
+    end
+
+    def self.logger
+      @logger
+    end
+
+    def self.send_tcp(message)
+      socket = TCPSocket.new(opts[:graphite_host], opts[:graphite_port])
+      socket.print("#{message}\n")
+      socket.close
+    end
+
+    def self.send_udp(message)
+      socket = UDPSocket.new
+      socket.send(message, 0, opts[:statsd_host], opts[:statsd_port])
+      socket.close
+    end
+
+  end
 end

data/lib/mini_graphite/logger.rb

@@ -1,28 +1,28 @@
 module Dalia
 
-	module MiniGraphite
+  module MiniGraphite
 
-		class Logger
-			attr_reader :debug_mode
+    class Logger
+      attr_reader :debug_mode
 
-		  def initialize(debug_mode = true)
-		    @debug_mode = debug_mode
-		  end
+      def initialize(debug_mode = true)
+        @debug_mode = debug_mode
+      end
 
-		  def debug(message)
-		    return unless debug_mode
+      def debug(message)
+        return unless debug_mode
 
-		    result = "Dalia::MiniGraphite [#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}]: #{message}"
+        result = "Dalia::MiniGraphite [#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}]: #{message}"
 
-		    if defined? ::Rails
-		      ::Rails.logger.info result
-		    else
-		      Kernel.puts result
-		    end
-		  end
+        if defined? ::Rails
+          ::Rails.logger.info result
+        else
+          Kernel.puts result
+        end
+      end
 
-		end
+    end
 
-	end
+  end
 
 end

data/lib/mini_graphite/version.rb

@@ -1,5 +1,5 @@
 module Dalia
   module MiniGraphite
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

data/test/logger_test.rb

@@ -4,23 +4,23 @@ require_relative "../lib/mini_graphite"
 
 class MiniGraphiteTest < MiniTest::Unit::TestCase
 
-	def test_debug
-		Kernel.expects(:puts).with(regexp_matches(/MESSAGE/))
-		logger = Dalia::MiniGraphite::Logger.new
-		logger.debug("MESSAGE")
-	end
+  def test_debug
+    Kernel.expects(:puts).with(regexp_matches(/MESSAGE/))
+    logger = Dalia::MiniGraphite::Logger.new
+    logger.debug("MESSAGE")
+  end
 
-	def test_debug_when_not_debug_mode
-		Kernel.expects(:puts).never
-		logger = Dalia::MiniGraphite::Logger.new(false)
-		logger.debug("MESSAGE")
-	end
+  def test_debug_when_not_debug_mode
+    Kernel.expects(:puts).never
+    logger = Dalia::MiniGraphite::Logger.new(false)
+    logger.debug("MESSAGE")
+  end
 
-	def test_debug_when_rails_actived
-		Kernel.const_set("Rails", mock(:logger => mock(:info)))
-		logger = Dalia::MiniGraphite::Logger.new
-		logger.debug("MESSAGE")
-		Kernel.send(:remove_const, :Rails)
-	end
+  def test_debug_when_rails_actived
+    Kernel.const_set("Rails", mock(:logger => mock(:info)))
+    logger = Dalia::MiniGraphite::Logger.new
+    logger.debug("MESSAGE")
+    Kernel.send(:remove_const, :Rails)
+  end
 
 end

data/test/minigraphite_test.rb

@@ -4,59 +4,74 @@ require_relative "../lib/mini_graphite"
 
 class MiniGraphiteTest < MiniTest::Unit::TestCase
 
-	def test_datapoint
-		Dalia::MiniGraphite.config({ :graphite_host => "graphite.host.com", :graphite_port => 2003 })
-
-		socket_mock = mock()
-		TCPSocket.expects(:new).with("graphite.host.com", 2003).returns(socket_mock)
-		socket_mock.expects(:print).with("test.age 31 1357117860\n")
-		socket_mock.expects(:close)
-
-		Dalia::MiniGraphite.datapoint("test.age", 31, Time.new(2013,1,2,10,11))
-	end
-
-	def test_counter
-		Dalia::MiniGraphite.config({ :statsd_host => "statsd.host.com", :statsd_port => 8125 })
-
-		socket_mock = mock()
-		UDPSocket.expects(:new).returns(socket_mock)
-		socket_mock.expects(:send).with("height:231|c", 0, "statsd.host.com", 8125 )
-		socket_mock.expects(:close)
-
-		Dalia::MiniGraphite.counter("height", 231)
-	end
-
-	def test_on_config_should_debug
-		Dalia::MiniGraphite::Logger.any_instance.expects(:debug).at_least_once
-		Dalia::MiniGraphite.config()
-	end
-
-	def test_on_counter_should_debug
-		Dalia::MiniGraphite.expects(:send_udp)
-		Dalia::MiniGraphite.config()
-
-		Dalia::MiniGraphite::Logger.any_instance.expects(:debug).with("Sending counter: 'test.age:31|c'")
-		Dalia::MiniGraphite.counter("test.age", 31)
-	end
-
-	def test_on_datapoint_should_debug
-		Dalia::MiniGraphite.expects(:send_tcp)
-		Dalia::MiniGraphite.config()
-
-		Dalia::MiniGraphite::Logger.any_instance.expects(:debug).with("Sending datapoint: 'test.age 31 1357117860'")
-		Dalia::MiniGraphite.datapoint("test.age", 31, Time.new(2013,1,2,10,11))
-	end
-
-	def test_on_datapoint_not_send_tcp_if_mock_mode
-		Dalia::MiniGraphite.config(:mock_mode => true)
-		TCPSocket.expects(:new).never
-		Dalia::MiniGraphite.datapoint("test.age")
-	end
-
-	def test_on_counter_not_send_udp_if_mock_mode
-		Dalia::MiniGraphite.config(:mock_mode => true)
-		UDPSocket.expects(:new).never
-		Dalia::MiniGraphite.counter("test.age")
-	end
+  def test_datapoint
+    Dalia::MiniGraphite.config({ :graphite_host => "graphite.host.com", :graphite_port => 2003 })
+
+    socket_mock = mock()
+    TCPSocket.expects(:new).with("graphite.host.com", 2003).returns(socket_mock)
+    socket_mock.expects(:print).with("test.age 31 1357117860\n")
+    socket_mock.expects(:close)
+
+    Dalia::MiniGraphite.datapoint("test.age", 31, Time.new(2013,1,2,10,11))
+  end
+
+  def test_counter
+    Dalia::MiniGraphite.config({ :statsd_host => "statsd.host.com", :statsd_port => 8125 })
+
+    socket_mock = mock()
+    UDPSocket.expects(:new).returns(socket_mock)
+    socket_mock.expects(:send).with("height:231|c", 0, "statsd.host.com", 8125 )
+    socket_mock.expects(:close)
+
+    Dalia::MiniGraphite.counter("height", 231)
+  end
+
+  def test_on_config_should_debug
+    Dalia::MiniGraphite::Logger.any_instance.expects(:debug).at_least_once
+    Dalia::MiniGraphite.config()
+  end
+
+  def test_on_counter_should_debug
+    Dalia::MiniGraphite.expects(:send_udp)
+    Dalia::MiniGraphite.config()
+
+    Dalia::MiniGraphite::Logger.any_instance.expects(:debug).with("Sending counter: 'test.age:31|c'")
+    Dalia::MiniGraphite.counter("test.age", 31)
+  end
+
+  def test_on_datapoint_should_debug
+    Dalia::MiniGraphite.expects(:send_tcp)
+    Dalia::MiniGraphite.config()
+
+    Dalia::MiniGraphite::Logger.any_instance.expects(:debug).with("Sending datapoint: 'test.age 31 1357117860'")
+    Dalia::MiniGraphite.datapoint("test.age", 31, Time.new(2013,1,2,10,11))
+  end
+
+  def test_on_datapoint_not_send_tcp_if_mock_mode
+    Dalia::MiniGraphite.config(:mock_mode => true)
+    TCPSocket.expects(:new).never
+    Dalia::MiniGraphite.datapoint("test.age")
+  end
+
+  def test_on_counter_not_send_udp_if_mock_mode
+    Dalia::MiniGraphite.config(:mock_mode => true)
+    UDPSocket.expects(:new).never
+    Dalia::MiniGraphite.counter("test.age")
+  end
+
+  def test_benchmark_wrapper
+    Dalia::MiniGraphite.expects(:counter).with("key_prefix.ini")
+    Dalia::MiniGraphite.expects(:counter).with("key_prefix.count")
+    Dalia::MiniGraphite.expects(:counter).with("key_prefix.time", is_a(Float))
+    Dalia::MiniGraphite.expects(:counter).with("key_prefix.end")
+
+    result =
+      Dalia::MiniGraphite.benchmark_wrapper("key_prefix") do
+        sleep(1)
+        "RESULT"
+      end
+
+    assert_equal("RESULT", result)
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_graphite
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Sevastianos Komianos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler