mini_graphite 0.2.1 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92947456f8f553f0a525e9d8f97acbe1f2773e6a
-  data.tar.gz: 05a251b574bda29749c5c0517a686b198d4681fe
+  metadata.gz: 0978431fccda978ce88aa42cc663872044f184e9
+  data.tar.gz: d75a452d76d670b6595415b3488df2b6f6b41d16
 SHA512:
-  metadata.gz: 4128d24584db3382ff7bf91003f438d9a8f4598bfc06b631298ee09567068709c4ea52e0bb9434afc07d62b40a1427b9ebb07a67ff136c7154a489bd31122b68
-  data.tar.gz: 24f18c3064f099276adcab1e9379e90b94bd8a7cecae34d123a6482d49a45065388dc5c6aa3b53b3af568827dd4351ff713c24b813c77026e1fbe4fb89a53e83
+  metadata.gz: 6665b43f77ec8da1ef2e8ef350e081aecc958c96e642196d424f56f63ac3b9bdbcae2895f0a8b9b727bc1f29d355df2c43f9996d2d30b890d16a1dd3fd001900
+  data.tar.gz: 5d05a3e739bc09300b7e36f1640812fb1190f4455bb26a5ee38fa83841879e1f52429ad8011373a08e274158cae871ee79ec09949b05a76ad0abda36a7663238

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+notifications:
+  email:
+    - developers@daliaresearch.com

data/README.md

@@ -2,7 +2,7 @@
 
 Simple wrapper for Graphite and Statsd
 
-## Instructions
+## Instructions
 
 Check the `test` folder for examples, if you need more explanations please contact us.
 
@@ -27,7 +27,18 @@ Or install it yourself as:
     Dalia::MiniGraphite.config({
       :graphite_host => "my.graphite.server.com",
       :graphite_port => 2003, # default 2003
-      :statsd_host => "my.graphite.server.com",
+      :statsd_host => "my.statsd.server.com",
+      :statsd_port => 8125, # default 8125
+      :mock_mode => false, # default false
+      :debug_mode => true # default false
+    })
+
+Also support multiple servers:
+
+    Dalia::MiniGraphite.config({
+      :graphite_host => ["my.graphite1.server.com", "my.graphite2.server.com"],
+      :graphite_port => 2003, # default 2003
+      :statsd_host => ["my.statsd1.server.com", "my.statsd2.server.com", "my.statsd3.server.com"],
       :statsd_port => 8125, # default 8125
       :mock_mode => false, # default false
       :debug_mode => true # default false
@@ -36,24 +47,27 @@ Or install it yourself as:
 ### Simple signals
 
     Dalia::MiniGraphite.datapoint("my.key", 120, Time.now) # to Graphite
-    Dalia::MiniGraphite.counter("my.key", 120) # to StatSD
+    Dalia::MiniGraphite.counter("my.key", 120) # to StatSD with `c` modifyer
+    Dalia::MiniGraphite.time("my.key", 120) # to StatSD with `ms` modifyer
 
 ### Block wrapper benchmark
 
+     # Dalia::MiniGraphite.benchmark_wrapper(key_prefix, result_send_method)
      result =
-       Dalia::MiniGraphite.benchmark_wrapper("key_prefix", [send_result={true,false}]) do
+       Dalia::MiniGraphite.benchmark_wrapper("key_prefix", :length) do
          sleep(1)
          "RESULT"
        end
 
      puts result # => RESULT
 
-This will send 4 signals:
+This will send several signals:
 
-- *key_prefix.ini*            # At the begining of the block
-- *key_prefix.result*         # At the end of the block, send the block result. Only if `send_result` paramater is `true`.
-- *key_prefix.time, [ms]*     # At the end of the block, with the Benchmark.realtime result of the execution
-- *key_prefix.end*            # At the end of the block
+- *key_prefix.ini:1|c*            # At the begining of the block
+- *key_prefix.result:6|c*         # At the end of the block, send the block `result.send(result_send_method)`. Only if `result_send_method` paramater is present.
+- *key_prefix.time:1000|c*        # At the end of the block, with the Benchmark.realtime result of the execution
+- *key_prefix.end:1|c*            # At the end of the block
+- *key_prefix.time_stats:1000|ms* # At the end of the block, with the Benchmark.realtime result of the execution
 
 ### Routes reporter for Sinatra
 
@@ -61,8 +75,9 @@ The rack middleware must be added to the Rack chain in config.ru passing along w
 
 - *set_graphite_key "graphite_key", /route_regexp/*   #  The regular expression will be used to match the Sinatra route and the corresponding graphite_key will be used to build the Graphite metrics:
 
-"[graphite_key].count"  # The counter of the times a particular route is requested.
-"[graphite_key].duration" # The duration in milliseconds of each request/response cycle.
+- "[graphite\_key].count"           # The counter of the times a particular route is requested.
+- "[graphite\_key].duration"        # The duration in milliseconds of each request/response cycle.
+- "[graphite\_key].duration\_stats" # The duration in milliseconds of each request/response cycle in a "ms" metric
 
 If the requested url doesn't match any configured regular expression the Graphite metrics will not be sent.
 

data/lib/mini_graphite.rb

@@ -30,14 +30,22 @@ module Dalia
       send_tcp(signal) if !opts[:mock_mode]
     end
 
-    def self.counter(key, value = 1)
+    def self.counter(key, value = nil)
+      value ||= 1
       signal = "#{key}:#{value}|c"
       logger.debug("Sending counter: '#{signal}'")
 
       send_udp(signal) if !opts[:mock_mode]
     end
 
-    def self.benchmark_wrapper(key, send_result = false)
+    def self.time(key, value = 0)
+      signal = "#{key}:#{value}|ms"
+      logger.debug("Sending time: '#{signal}'")
+
+      send_udp(signal) if !opts[:mock_mode]
+    end
+
+    def self.benchmark_wrapper(key, result_send_method = nil)
       counter("#{key}.ini")
 
       result = nil
@@ -48,33 +56,50 @@ module Dalia
         end
 
       counter("#{key}.time", time * 1000)
-      counter("#{key}.result", result) if send_result
+      counter("#{key}.result", result.send(result_send_method)) if result_send_method
       counter("#{key}.end")
 
+      time("#{key}.time_stats", time * 1000)
+
       result
     end
 
-  private
+    def self.send_tcp(message)
+      hosts = [opts[:graphite_host]].flatten
 
-    def self.opts
-      @opts
+      hosts.each do |host|
+        send_tcp_on_host(host, opts[:graphite_port], message)
+      end
     end
 
-    def self.logger
-      @logger
+    def self.send_udp(message)
+      hosts = [opts[:statsd_host]].flatten
+
+      hosts.each do |host|
+        send_udp_on_host(host, opts[:statsd_port], message)
+      end
     end
 
-    def self.send_tcp(message)
-      socket = TCPSocket.new(opts[:graphite_host], opts[:graphite_port])
+    def self.send_tcp_on_host(host, port, message)
+      socket = TCPSocket.new(host, port)
       socket.print("#{message}\n")
       socket.close
     end
 
-    def self.send_udp(message)
+    def self.send_udp_on_host(host, port, message)
       socket = UDPSocket.new
-      socket.send(message, 0, opts[:statsd_host], opts[:statsd_port])
+      socket.send(message, 0, host, port)
       socket.close
     end
 
+  private
+
+    def self.opts
+      @opts
+    end
+
+    def self.logger
+      @logger
+    end
   end
 end

data/lib/mini_graphite/logger.rb

@@ -14,7 +14,7 @@ module Dalia
 
         result = "Dalia::MiniGraphite [#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}]: #{message}"
 
-        if defined? ::Rails
+        if defined? ::Rails.logger
           ::Rails.logger.info result
         else
           Kernel.puts result

data/lib/mini_graphite/routes_reporter.rb

@@ -20,6 +20,7 @@ module Dalia
 
           Dalia::MiniGraphite.counter("#{graphite_key}.count") if graphite_key
           Dalia::MiniGraphite.counter("#{graphite_key}.duration", time_taken) if graphite_key
+          Dalia::MiniGraphite.time("#{graphite_key}.duration_stats", time_taken) if graphite_key
         end
 
         [status, headers, body]
@@ -31,4 +32,4 @@ module Dalia
         end
     end
   end
-end
+end

data/lib/mini_graphite/version.rb

@@ -1,5 +1,5 @@
 module Dalia
   module MiniGraphite
-    VERSION = "0.2.1"
+    VERSION = "0.3.7"
   end
-end
+end

data/minigraphite.gemspec

@@ -6,8 +6,8 @@ require 'mini_graphite/version'
 Gem::Specification.new do |spec|
   spec.name          = "mini_graphite"
   spec.version       = Dalia::MiniGraphite::VERSION
-  spec.authors       = ["Sevastianos Komianos"]
-  spec.email         = ["sebastian.komianos@daliaresearch.com"]
+  spec.authors       = ["Sevastianos Komianos", "Fernando Guillen"]
+  spec.email         = ["it@daliaresearch.com"]
   spec.summary       = "Simple wrapper for Graphite and Statsd"
   spec.description   = "Simple wrapper for Graphite and Statsd"
   spec.homepage      = "https://github.com/DaliaResearch/MiniGraphite"

data/test/logger_test.rb

@@ -2,7 +2,7 @@ require "minitest/autorun"
 require "mocha/setup"
 require_relative "../lib/mini_graphite"
 
-class MiniGraphiteTest < MiniTest::Unit::TestCase
+class MiniGraphiteTest < MiniTest::Test
 
   def test_debug
     Kernel.expects(:puts).with(regexp_matches(/MESSAGE/))
@@ -17,10 +17,9 @@ class MiniGraphiteTest < MiniTest::Unit::TestCase
   end
 
   def test_debug_when_rails_actived
-    Kernel.const_set("Rails", mock(:logger => mock(:info)))
+    Rails.expects(:logger => mock(:info))
     logger = Dalia::MiniGraphite::Logger.new
     logger.debug("MESSAGE")
-    Kernel.send(:remove_const, :Rails)
   end
 
 end

data/test/minigraphite_test.rb

@@ -2,28 +2,78 @@ require "minitest/autorun"
 require "mocha/setup"
 require_relative "../lib/mini_graphite"
 
-class MiniGraphiteTest < MiniTest::Unit::TestCase
+class MiniGraphiteTest < MiniTest::Test
 
-  def test_datapoint
-    Dalia::MiniGraphite.config({ :graphite_host => "graphite.host.com", :graphite_port => 2003 })
+  def test_send_tcp_on_host
+    socket_mock = mock()
+    TCPSocket.expects(:new).with("HOST", "PORT").returns(socket_mock)
+    socket_mock.expects(:print).with("MESSAGE\n")
+    socket_mock.expects(:close)
 
+    Dalia::MiniGraphite.send_tcp_on_host("HOST", "PORT", "MESSAGE")
+  end
+
+  def test_send_udp_on_host
     socket_mock = mock()
-    TCPSocket.expects(:new).with("graphite.host.com", 2003).returns(socket_mock)
-    socket_mock.expects(:print).with("test.age 31 1357117860\n")
+    UDPSocket.expects(:new).returns(socket_mock)
+    socket_mock.expects(:send).with("MESSAGE", 0, "HOST", "PORT" )
     socket_mock.expects(:close)
 
+    Dalia::MiniGraphite.send_udp_on_host("HOST", "PORT", "MESSAGE")
+  end
+
+  def test_send_tcp
+    Dalia::MiniGraphite.config({ :graphite_host => "HOST", :graphite_port => "PORT" })
+    Dalia::MiniGraphite.expects(:send_tcp_on_host).with("HOST", "PORT", "MESSAGE")
+    Dalia::MiniGraphite.send_tcp("MESSAGE")
+  end
+
+  def test_send_tcp_when_multiple_hosts
+    Dalia::MiniGraphite.config({ :graphite_host => ["HOST1", "HOST2"], :graphite_port => "PORT" })
+
+    Dalia::MiniGraphite.expects(:send_tcp_on_host).with("HOST1", "PORT", "MESSAGE")
+    Dalia::MiniGraphite.expects(:send_tcp_on_host).with("HOST2", "PORT", "MESSAGE")
+
+    Dalia::MiniGraphite.send_tcp("MESSAGE")
+  end
+
+  def test_send_udp
+    Dalia::MiniGraphite.config({ :statsd_host => "HOST", :statsd_port => "PORT" })
+    Dalia::MiniGraphite.expects(:send_udp_on_host).with("HOST", "PORT", "MESSAGE")
+    Dalia::MiniGraphite.send_udp("MESSAGE")
+  end
+
+  def test_send_udp_when_multiple_hosts
+    Dalia::MiniGraphite.config({ :statsd_host => ["HOST1", "HOST2"], :statsd_port => "PORT" })
+
+    Dalia::MiniGraphite.expects(:send_udp_on_host).with("HOST1", "PORT", "MESSAGE")
+    Dalia::MiniGraphite.expects(:send_udp_on_host).with("HOST2", "PORT", "MESSAGE")
+
+    Dalia::MiniGraphite.send_udp("MESSAGE")
+  end
+
+  def test_datapoint
+    Dalia::MiniGraphite.config({ :graphite_host => "graphite.host.com", :graphite_port => 2003 })
+    Dalia::MiniGraphite.expects(:send_tcp).with("test.age 31 1357117860")
     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 })
+    Dalia::MiniGraphite.expects(:send_udp).with("height:231|c")
+    Dalia::MiniGraphite.counter("height", 231)
+  end
 
-    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)
+  def test_time
+    Dalia::MiniGraphite.config({ :statsd_host => "statsd.host.com", :statsd_port => 8125 })
+    Dalia::MiniGraphite.expects(:send_udp).with("my_time:231|ms")
+    Dalia::MiniGraphite.time("my_time", 231)
+  end
 
-    Dalia::MiniGraphite.counter("height", 231)
+  def test_counter_when_nil_value
+    Dalia::MiniGraphite.config({ :statsd_host => "statsd.host.com", :statsd_port => 8125 })
+    Dalia::MiniGraphite.expects(:send_udp).with("height:1|c")
+    Dalia::MiniGraphite.counter("height", nil)
   end
 
   def test_on_config_should_debug
@@ -49,13 +99,13 @@ class MiniGraphiteTest < MiniTest::Unit::TestCase
 
   def test_on_datapoint_not_send_tcp_if_mock_mode
     Dalia::MiniGraphite.config(:mock_mode => true)
-    TCPSocket.expects(:new).never
+    Dalia::MiniGraphite.expects(:send_tcp).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.expects(:send_udp).never
     Dalia::MiniGraphite.counter("test.age")
   end
 
@@ -65,6 +115,8 @@ class MiniGraphiteTest < MiniTest::Unit::TestCase
     Dalia::MiniGraphite.expects(:counter).with("key_prefix.result").never
     Dalia::MiniGraphite.expects(:counter).with("key_prefix.end")
 
+    Dalia::MiniGraphite.expects(:time).with("key_prefix.time_stats", is_a(Float))
+
     result =
       Dalia::MiniGraphite.benchmark_wrapper("key_prefix") do
         sleep(1)
@@ -77,11 +129,13 @@ class MiniGraphiteTest < MiniTest::Unit::TestCase
   def test_benchmark_wrapper_sending_result
     Dalia::MiniGraphite.expects(:counter).with("key_prefix.ini")
     Dalia::MiniGraphite.expects(:counter).with("key_prefix.time", is_a(Float))
-    Dalia::MiniGraphite.expects(:counter).with("key_prefix.result", "RESULT")
+    Dalia::MiniGraphite.expects(:counter).with("key_prefix.result", 6)
     Dalia::MiniGraphite.expects(:counter).with("key_prefix.end")
 
+    Dalia::MiniGraphite.expects(:time).with("key_prefix.time_stats", is_a(Float))
+
     result =
-      Dalia::MiniGraphite.benchmark_wrapper("key_prefix", true) do
+      Dalia::MiniGraphite.benchmark_wrapper("key_prefix", :length) do
         sleep(1)
         "RESULT"
       end

data/test/routes_reporter_test.rb

@@ -24,21 +24,25 @@ class RoutesReporter < Minitest::Test
   def test_send_routes_metrics_to_graphite
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.homepage.duration", instance_of(Float))
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.homepage.count")
+    Dalia::MiniGraphite.expects(:time).with("app.test_app.test.routes.homepage.duration_stats", instance_of(Float))
     @request.get("/", {"sinatra.route" => "/"})
 
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.get_surveys.duration", instance_of(Float))
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.get_surveys.count")
+Dalia::MiniGraphite.expects(:time).with("app.test_app.test.routes.get_surveys.duration_stats", instance_of(Float))
     @request.get("/OFFER_CLICK_ID/PANEL_USER_ID/PANEL_USER_ID_KIND", {"sinatra.route" => "/:offer_click_id/:panel_user_id/:panel_user_id_kind/"})
 
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.error.duration", instance_of(Float))
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.error.count")
+    Dalia::MiniGraphite.expects(:time).with("app.test_app.test.routes.error.duration_stats", instance_of(Float))
     @request.get("/error", {"sinatra.route" => "/error"})
 
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.active_surveys.duration", instance_of(Float))
     Dalia::MiniGraphite.expects(:counter).with("app.test_app.test.routes.active_surveys.count")
+    Dalia::MiniGraphite.expects(:time).with("app.test_app.test.routes.active_surveys.duration_stats", instance_of(Float))
     @request.get("/active_surveys/this_should_be_a_password", {"sinatra.route" => "/active_surveys/this_should_be_a_password" })
 
     Dalia::MiniGraphite.expects(:counter).never
     @request.get("/ANOTHER_URL")
   end
-end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mini_graphite
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.7
 platform: ruby
 authors:
 - Sevastianos Komianos
+- Fernando Guillen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,13 +83,14 @@ dependencies:
         version: '0'
 description: Simple wrapper for Graphite and Statsd
 email:
-- sebastian.komianos@daliaresearch.com
+- it@daliaresearch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md