mini_graphite 0.0.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6a5d36496ba99732fa43057a862b1c0583fe551
-  data.tar.gz: 9c26d7b512a3777b73dfaa5c7ef542a112650393
+  metadata.gz: 92947456f8f553f0a525e9d8f97acbe1f2773e6a
+  data.tar.gz: 05a251b574bda29749c5c0517a686b198d4681fe
 SHA512:
-  metadata.gz: 7927a29a703f55f6f35db557cdaf49856fe9f055953ecdd03dde95272f040c9e7d4be691d17bdce56033268873c03f43211618384b1d3fa22cf88bea6b22c2bf
-  data.tar.gz: 3e8247385c1f9d482bf7bb51a554049f2422e4f0798d92a7b4d8a179c567243aafc943faea4a917851b0491b750a733fe1b35028ec46640611a0d0f9cd30c9da
+  metadata.gz: 4128d24584db3382ff7bf91003f438d9a8f4598bfc06b631298ee09567068709c4ea52e0bb9434afc07d62b40a1427b9ebb07a67ff136c7154a489bd31122b68
+  data.tar.gz: 24f18c3064f099276adcab1e9379e90b94bd8a7cecae34d123a6482d49a45065388dc5c6aa3b53b3af568827dd4351ff713c24b813c77026e1fbe4fb89a53e83

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p247
+2.3.1

data/README.md

@@ -22,6 +22,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Config
+
     Dalia::MiniGraphite.config({
       :graphite_host => "my.graphite.server.com",
       :graphite_port => 2003, # default 2003
@@ -31,25 +33,51 @@ Or install it yourself as:
       :debug_mode => true # default false
     })
 
+### Simple signals
+
     Dalia::MiniGraphite.datapoint("my.key", 120, Time.now) # to Graphite
     Dalia::MiniGraphite.counter("my.key", 120) # to StatSD
 
+### Block wrapper benchmark
+
+     result =
+       Dalia::MiniGraphite.benchmark_wrapper("key_prefix", [send_result={true,false}]) do
+         sleep(1)
+         "RESULT"
+       end
+
+     puts result # => RESULT
 
 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
+- *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
+
+### Routes reporter for Sinatra
+
+The rack middleware must be added to the Rack chain in config.ru passing along with it a block with  config options:
+
+- *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.
+
+If the requested url doesn't match any configured regular expression the Graphite metrics will not be sent.
+
+Example:
 
-    result =
-      Dalia::MiniGraphite.benchmark_wrapper("key_prefix") do
-        sleep(1)
-        "RESULT"
-      end
+    # config.ru
 
-    puts result # => RESULT
+    use Dalia::MiniGraphite::RoutesReporter do
+      set_graphite_key "app.my_app.production.routes.active_surveys", /active_surveys\/this_should_be_a_password/
+      set_graphite_key "app.my_app.production.routes.get_surveys", /\:offer_click_id\/\:panel_user_id\/\:panel_user_id_kind/
+      set_graphite_key "app.my_app.production.routes.error", /error/
+      set_graphite_key "app.my_app.production.routes.homepage", /\/$/
+    end
 
+    run MyApp::App
 
 ## Contributing
 

data/lib/mini_graphite/routes_reporter.rb

@@ -0,0 +1,34 @@
+module Dalia
+  module MiniGraphite
+    class RoutesReporter
+      def initialize(app, &routes_block)
+        @app = app
+        @routes = {}
+        instance_eval(&routes_block) if block_given?
+      end
+
+      def call(env)
+        start_time = Time.now
+        status, headers, body  = @app.call(env)
+        time_taken = (1000 * (Time.now - start_time))
+
+        current_route = env["sinatra.route"]
+        route = @routes.select { |graphite_key, route_regexp| current_route =~ route_regexp}
+
+        if route
+          graphite_key = route.keys.first
+
+          Dalia::MiniGraphite.counter("#{graphite_key}.count") if graphite_key
+          Dalia::MiniGraphite.counter("#{graphite_key}.duration", time_taken) if graphite_key
+        end
+
+        [status, headers, body]
+      end
+
+      private
+        def set_graphite_key(graphite_key, route_regexp)
+          @routes[graphite_key] = route_regexp
+        end
+    end
+  end
+end

data/lib/mini_graphite/version.rb

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

data/lib/mini_graphite.rb

@@ -1,5 +1,6 @@
 require_relative "mini_graphite/version"
 require_relative "mini_graphite/logger"
+require_relative "mini_graphite/routes_reporter"
 require "benchmark"
 
 require "socket"
@@ -36,7 +37,7 @@ module Dalia
       send_udp(signal) if !opts[:mock_mode]
     end
 
-    def self.benchmark_wrapper(key)
+    def self.benchmark_wrapper(key, send_result = false)
       counter("#{key}.ini")
 
       result = nil
@@ -46,9 +47,8 @@ module Dalia
           result = yield
         end
 
-      counter("#{key}.count")
       counter("#{key}.time", time * 1000)
-
+      counter("#{key}.result", result) if send_result
       counter("#{key}.end")
 
       result

data/minigraphite.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rack"
 end

data/test/minigraphite_test.rb

@@ -61,8 +61,8 @@ class MiniGraphiteTest < MiniTest::Unit::TestCase
 
   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.result").never
     Dalia::MiniGraphite.expects(:counter).with("key_prefix.end")
 
     result =
@@ -74,4 +74,19 @@ class MiniGraphiteTest < MiniTest::Unit::TestCase
     assert_equal("RESULT", result)
   end
 
+  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.end")
+
+    result =
+      Dalia::MiniGraphite.benchmark_wrapper("key_prefix", true) do
+        sleep(1)
+        "RESULT"
+      end
+
+    assert_equal("RESULT", result)
+  end
+
 end

data/test/routes_reporter_test.rb

@@ -0,0 +1,44 @@
+require "minitest/autorun"
+require "mocha/setup"
+require "rack"
+
+require_relative "../lib/mini_graphite"
+
+class RoutesReporter < Minitest::Test
+  def setup
+    @app = Proc.new do |env|
+      ['200', {'Content-Type' => 'text/html'}, ['Test App']]
+    end
+
+    routes_block = Proc.new do
+      set_graphite_key "app.test_app.test.routes.active_surveys", /active_surveys\/this_should_be_a_password/
+      set_graphite_key "app.test_app.test.routes.get_surveys", /\:offer_click_id\/\:panel_user_id\/\:panel_user_id_kind/
+      set_graphite_key "app.test_app.test.routes.error", /error/
+      set_graphite_key "app.test_app.test.routes.homepage", /\/$/
+    end
+
+    @graphite_routes_reporter = Dalia::MiniGraphite::RoutesReporter.new(@app, &routes_block)
+    @request = Rack::MockRequest.new(@graphite_routes_reporter)
+  end
+
+  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")
+    @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")
+    @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")
+    @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")
+    @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

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: mini_graphite
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Sevastianos Komianos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple wrapper for Graphite and Statsd
@@ -73,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,10 +96,12 @@ files:
 - ci_script.sh
 - lib/mini_graphite.rb
 - lib/mini_graphite/logger.rb
+- lib/mini_graphite/routes_reporter.rb
 - lib/mini_graphite/version.rb
 - minigraphite.gemspec
 - test/logger_test.rb
 - test/minigraphite_test.rb
+- test/routes_reporter_test.rb
 homepage: https://github.com/DaliaResearch/MiniGraphite
 licenses:
 - MIT
@@ -96,20 +112,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple wrapper for Graphite and Statsd
 test_files:
 - test/logger_test.rb
 - test/minigraphite_test.rb
+- test/routes_reporter_test.rb