statue 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4babeecc571be33fbda04a81c3eabc6455368aff
-  data.tar.gz: 6bced52052f52e3611df23562825e570a548d1d1
+  metadata.gz: c1e8d8ac15844fcc7be73f711dbef4dd68f674f4
+  data.tar.gz: bb8f101f7b34197ef55c1ae9a1b796117fe73948
 SHA512:
-  metadata.gz: b73f850044ca23086c8f837fc3f969d94121390139292ab94ac28956a686567e27784b066ad000151629ba0f76492746dc127cb310f84a95609b5f8fe9f70087
-  data.tar.gz: bde0b2df82abc4ccc570bd87254cb176c435dbb3799cc24484622a502134b48351806be9ae3333e43b77d52940faddae1265d5c889543b56017948853d7024ad
+  metadata.gz: df3750b4897fa143ec1f3c7eebf519e5f2d9fe698979843b3ec400d353dd5d85e2fcd5587af94d38bce454bfd1fae166e3e3234c5a7ae74465a7a22d19456b44
+  data.tar.gz: d91000f02e854e6619666adfa9ea12c04685bc32463c8a7ebc694ce5722a95c310bafc95b310175b37a0d98b8f28a5c86fcd5f42618eb653f650dcfe2182af08

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.2.0
+- 2.1.6
+- jruby-9.1.8.0
+bundler_args: --binstubs
+script: bin/rake test

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-## [0.3.0] - Unreleased
+## [0.4.0] - 2017-03-13
+
+### Feature
+
+- Added `SidekiqStatistics` middleware support
+- To integrate it with your middleware, just add it to your sidekiq's initializer like follows:
+
+```ruby
+  config.server_middleware do |chain|
+    chain.add Statue::SidekiqStatistics::SidekiqMiddleware
+  end
+```
+
+## [0.3.0] - 2017-03-13
 
 ### Feature
 

data/README.md

@@ -1,5 +1,7 @@
 # Statue
 
+![Build Status](https://travis-ci.org/restorando/statue.svg?branch=master)
+
     / ___)(_  _)/ _\(_  _)/ )( \(  __)
     \___ \  )( /    \ )(  ) \/ ( ) _)
     (____/ (__)\_/\_/(__) \____/(____)

data/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +8,22 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('rake', 'rake')
+load Gem.bin_path("rake", "rake")

data/lib/statue/sidekiq_statistics.rb

@@ -0,0 +1,73 @@
+require 'statue'
+
+module Statue
+  # This module simplifies the job statistics tracking using Statue
+  # * Provides a SidekiqMiddleware (to track performance and latency)
+  # * Provides a method for tracking other middleware events (eg. throttling, deadline)
+  #
+  # The current set of metrics are:
+  #
+  # * count job.<queue>.<job_name>.(success|failure):
+  #   depending if the job succeeded or failed
+  # * count job.<queue>.<job_name>.throttled:
+  #   only if the job was throttled by sidekiq-throttler
+  # * count job.<queue>.<job_name>.overdue:
+  #   only if the deadline from run_deadline_middleware was reached
+  # * count job.<queue>.<job_name>.retry:
+  #   only if the job corresponds to a retry for a previously failed job
+  # * duration job.<queue>.<job_name>.latency:
+  #   time difference between now and when the job last entered the queue
+  # * duration job.<queue>.<job_name>:
+  #   job run duration (reported only if the job doesn't fail)
+  module SidekiqStatistics
+    def self.count_event(event, worker, message)
+      Statue.report_increment("#{job_metric_name(worker, message)}.#{event}")
+    end
+
+    def self.job_metric_name(worker, message)
+      job_name = if worker.respond_to?(:job_name)
+        worker.job_name(*message["args"])
+      elsif message.dig("args", 0, "job_class")
+        # search for the class name that resides in the message received
+        message.dig("args", 0, "job_class")
+      else
+        worker.class.name.gsub(/::/, "-")
+      end
+      "job.#{message["queue"]}.#{job_name}"
+    end
+
+    # Middleware for tracking common job run metrics
+    class SidekiqMiddleware
+      def call(worker, message, _queue)
+        job_metric_name = Statue::SidekiqStatistics.job_metric_name(worker, message)
+
+        if message["retry_count"]
+          # Count retried jobs
+          Statue.report_increment("#{job_metric_name}.retry")
+        else
+          # Track latency for new jobs only (we can't know since when the failed job is waiting)
+          enqueued_at = Time.at(message["enqueued_at"])
+          Statue.report_duration("#{job_metric_name}.latency", Time.now - enqueued_at)
+        end
+
+        Statue.report_duration(job_metric_name) do
+          Statue.report_success_or_failure(job_metric_name) do
+            yield
+            true # We only count exceptions as failure
+          end
+        end
+      end
+    end
+
+    # This module is prepended in sidekiq-throttler rate_limit class
+    # Wraps the exceeded block with a block that also counts the job as beeing throttled
+    module ThrottlingExceeded
+      def exceeded(&block)
+        super do |*args|
+          yield(*args)
+          Statue::SidekiqStatistics.count_event("throttled", worker, "queue" => queue, "args" => payload)
+        end
+      end
+    end
+  end
+end

data/lib/statue/version.rb

@@ -1,3 +1,3 @@
 module Statue
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/statue.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack", "~> 1.6"
   spec.add_development_dependency "rack-test", "~> 0.6.3"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "sidekiq", "~> 3.2"
 end

data/test/sidekiq_statistics_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+require 'statue/sidekiq_statistics'
+require 'sidekiq/testing'
+
+describe Statue::SidekiqStatistics do
+  let(:metrics) { Statue.backend.captures }
+
+  Sidekiq::Testing.inline!
+
+  after do
+    Statue.backend.captures.clear
+  end
+
+  class FooJob
+    include Sidekiq::Worker
+
+    def job_name(*_args)
+      self.class.name.gsub(/::/, "-")
+    end
+
+    attr_accessor :should_fail
+
+    def perform
+      raise "fail" if should_fail
+    end
+  end
+
+  it "allows arbitrary event counting" do
+    Statue::SidekiqStatistics.count_event("test", FooJob.new, "queue" => "queue")
+
+    assert_equal(metrics.size, 1)
+    assert_equal(metrics.first.name, "job.queue.FooJob.test")
+    assert_equal(metrics.first.type, :c)
+  end
+
+  describe "Sidekiq Middleware" do
+    let(:worker)     { FooJob.new }
+    let(:middleware) { Statue::SidekiqStatistics::SidekiqMiddleware.new }
+    let(:msg)        { { "enqueued_at" => Time.now.to_f, "queue" => "default" } }
+
+    it "tracks job performance" do
+      Statue::Clock.stub :duration_in_ms, 5 do
+        middleware.call(worker, msg, msg["queue"]) { nil }
+
+        performance = metrics.find { |m| m.name == "job.default.FooJob" }
+        assert_equal(performance.type, :ms)
+        assert_equal(performance.value, 5)
+      end
+    end
+
+    it "counts block call always as a success" do
+      middleware.call(worker, msg, msg["queue"]) { false }
+
+      success = metrics.find { |m| m.name == "job.default.FooJob.success" }
+      assert_equal(success.type, :c)
+    end
+
+    it "counts exceptions as job failure" do
+      assert_raises("a") {
+        middleware.call(worker, msg, msg["queue"]) { raise "a" }
+      }
+
+      success = metrics.find { |m| m.name == "job.default.FooJob.success" }
+      assert_nil(success)
+
+      failure = metrics.find { |m| m.name == "job.default.FooJob.failure" }
+      assert_equal(failure.type, :c)
+    end
+
+    it "counts retries as job failure" do
+      msg["retry_count"] = 1
+      middleware.call(worker, msg, msg["queue"]) { true }
+
+      retry_metric = metrics.find { |m| m.name == "job.default.FooJob.retry" }
+      assert_equal(retry_metric.type, :c)
+    end
+
+    it "tracks queue latency" do
+      # Time.now - 1 minute
+      msg["enqueued_at"] = Time.now - 60
+
+      middleware.call(worker, msg, msg["queue"]) { nil }
+
+      latency = metrics.find { |m| m.name == "job.default.FooJob.latency" }
+      assert_equal(latency.type, :ms)
+      assert_in_delta(latency.value, 60, delta = 0.001)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statue
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Juan Barreneche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Track application metrics to Statsie
 email:
 - devs@restorando.com
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -103,10 +118,12 @@ files:
 - lib/statue/clock.rb
 - lib/statue/metric.rb
 - lib/statue/rack_statistics.rb
+- lib/statue/sidekiq_statistics.rb
 - lib/statue/stopwatch.rb
 - lib/statue/version.rb
 - statue.gemspec
 - test/rack_statistics_test.rb
+- test/sidekiq_statistics_test.rb
 - test/statue_test.rb
 - test/stopwatch_test.rb
 - test/test_helper.rb
@@ -130,13 +147,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easily track application metrics into Statsie
 test_files:
 - test/rack_statistics_test.rb
+- test/sidekiq_statistics_test.rb
 - test/statue_test.rb
 - test/stopwatch_test.rb
 - test/test_helper.rb
-has_rdoc: