chillout 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 658b6a7781d10cb43a0d4b337823465ed2be5b0f
-  data.tar.gz: 71bf4f623d9ed3f1db59443a84b5b2737c5ad190
+  metadata.gz: 6631dcadcf73b03ed3a10a4ef2e7d79ac081c3cf
+  data.tar.gz: e2097e2a4d295b7fd0f6c36f6eac008aad94523c
 SHA512:
-  metadata.gz: 03b4744020e8157adb20fbd5a418d9679c1be269dcc597d5e67d2b198ac03102aa534ad94962c7aa46c5154fc292c3fe38b6d7a44380138626bb8fa255bbab89
-  data.tar.gz: 57a7ab5198b538415f0d1e2eea38f8b1542b5aa9a05cc380181a38b2dfd7fda26fdb390e958dbb9049e21c535d3fcf126812e678d59970ab150778598f536045
+  metadata.gz: d10872b0af3d30b51ef10dfaa6530e177cc1d3f329ea39a621127d691dc10d9befc1a73e4fc2e3029fa06c0605df6fc51369bf0d662f0f3babd603a8ec6fe61b
+  data.tar.gz: b1a7b075053a58cb0e06e7f75cac2f6c6c4ca255c7a8abe9056eae3c05ea9549ece21bc5341ff6ac263631f479466d4474f8c1571ec77f5b0e2024a2079639b7

data/.travis.yml

@@ -10,7 +10,7 @@ env:
 - SAMPLE_APP=rails_4_0_0
 - SAMPLE_APP=rails_4_0_13
 - SAMPLE_APP=rails_4_1_0
-- SAMPLE_APP=rails_4_1_16
+- SAMPLE_APP=rails_4_1_16 SIDEKIQ_SUPPORTED=true
 - SAMPLE_APP=rails_4_2_0 SIDEKIQ_SUPPORTED=true
 - SAMPLE_APP=rails_4_2_8 SIDEKIQ_SUPPORTED=true
 - SAMPLE_APP=rails_5_0_3 SIDEKIQ_SUPPORTED=true
@@ -24,7 +24,7 @@ matrix:
   - rvm: 2.4.1
     env: SAMPLE_APP=rails_4_1_0
   - rvm: 2.4.1
-    env: SAMPLE_APP=rails_4_1_16
+    env: SAMPLE_APP=rails_4_1_16 SIDEKIQ_SUPPORTED=true
   - rvm: 2.4.1
     env: SAMPLE_APP=rails_4_2_0 SIDEKIQ_SUPPORTED=true
   - rvm: 2.1.10
@@ -34,6 +34,10 @@ matrix:
   - rvm: 2.1.10
     env: SAMPLE_APP=rails_5_1_1 SIDEKIQ_SUPPORTED=true
   include:
+  - rvm: 2.1.10
+    env: SIDEKIQ_VERSION=3.5.3 SAMPLE_APP=rails_4_1_16 SIDEKIQ_SUPPORTED=true
+  - rvm: 2.1.10
+    env: SIDEKIQ_VERSION=4.0 SAMPLE_APP=rails_4_1_16 SIDEKIQ_SUPPORTED=true
   - rvm: 2.4.1
     env: SAMPLE_APP=rails_4_2_8 STRATEGY=active_job SIDEKIQ_SUPPORTED=true
   - rvm: 2.4.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # chillout gem changes
 
+0.8.7
+-----
+
+- Introduced sidekiq jobs monitoring.
+
+
 0.8.6
 -----
 

data/Gemfile

@@ -8,5 +8,7 @@ gemspec
 if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2')
   gem "rack", "1.6"
   gem "activejob", "= 4.2.8"
-  gem "sidekiq", "~> 4.2"
+  gem "sidekiq", ENV['SIDEKIQ_VERSION'] || "~> 4.2"
+else
+  gem "sidekiq", ENV['SIDEKIQ_VERSION'] || ">= 5"
 end

data/lib/chillout/middleware/sidekiq.rb

@@ -1,18 +1,72 @@
 module Chillout
   module Middleware
 
+    class SidekiqJobMeasurement
+      attr_reader :retriable, :queue, :started,
+        :finished, :delay, :duration, :success
+
+      def initialize(job, queue, started, finished, success)
+        @class     = job["class"].to_s
+        @retriable = job["retry"].to_s
+        @queue     = queue
+        @started   = started.utc
+        @finished  = finished.utc
+        enqueued_at = job["enqueued_at"] || @finished.to_f
+        @delay = 1000.0 * (@finished.to_f - enqueued_at)
+        @duration = 1000.0 * (@finished.to_f - @started.to_f)
+        @success = success.to_s
+      end
+
+      def job_class
+        @class
+      end
+
+      def as_measurements()
+        [{
+          series: "sidekiq_jobs",
+          tags: {
+            class: @class,
+            retriable: @retriable,
+            queue: @queue,
+            success: @success.to_s,
+          },
+          timestamp: @finished.iso8601,
+          values: {
+            finished: 1,
+            duration: @duration.to_f,
+            delay: @delay.to_f
+          },
+        }]
+      end
+    end
+
     class SidekiqCreationsMonitor
       def initialize(options)
         @client = options.fetch(:client)
       end
 
-      def call(_worker, _job, _queue)
+      def call(_worker, job, queue)
+        started = Time.now.utc
+        success = false
         yield
+        success = true
       ensure
+        enqueue(queue, job, started, success)
+      end
+
+      def enqueue(_queue, job, started, success)
+        finished = Time.now.utc
         if creations = Chillout.creations
           Chillout.creations = nil
           @client.enqueue(creations)
         end
+        @client.enqueue(SidekiqJobMeasurement.new(
+          job,
+          _queue,
+          started,
+          finished,
+          success
+        ))
       end
     end
 

data/lib/chillout/version.rb

@@ -1,3 +1,3 @@
 module Chillout
-  VERSION = "0.8.6"
+  VERSION = "0.8.7"
 end

data/test/acceptance/sidekiq_workers_send_metrics_test.rb

@@ -8,15 +8,32 @@ class SidekiqWorkersSendMetricsTest < AcceptanceTestCase
     test_endpoint = TestEndpoint.new(port: 8081)
 
     test_endpoint.listen
-    test_sidekiq_worker.boot(chillout_port: 8081)
     test_sidekiq_worker.push_job
+    test_sidekiq_worker.boot(chillout_port: 8081)
 
     if ENV['STRATEGY'] != 'active_job'
       assert test_endpoint.has_received_information_about_startup
     end
     assert test_endpoint.has_one_creation_for_entity_resource
+
+    assert sidekiq = test_endpoint.has_one_sidekiq_metric
+    assert_equal "CreateEntityJob", sidekiq.fetch("tags").fetch("class")
+    assert_equal "default", sidekiq.fetch("tags").fetch("queue")
+    assert_equal "true", sidekiq.fetch("tags").fetch("retriable")
+    assert_equal "true", sidekiq.fetch("tags").fetch("success")
+
+    assert sidekiq.fetch("timestamp")
+
+    assert_equal 1, sidekiq.fetch("values").fetch("finished")
+    assert_operator 90, :>, sidekiq.fetch("values").fetch("duration")
+    assert_operator  0, :<, sidekiq.fetch("values").fetch("duration")
+    assert_operator 8000, :>, sidekiq.fetch("values").fetch("delay")
+    assert_operator  200, :<, sidekiq.fetch("values").fetch("delay")
   ensure
-    test_sidekiq_worker.shutdown if test_sidekiq_worker
+    if test_sidekiq_worker
+      test_sidekiq_worker.clear_jobs
+      test_sidekiq_worker.shutdown
+    end
   end
 
 end if ENV['SIDEKIQ_SUPPORTED']

data/test/middleware/sidekiq_test.rb

@@ -24,8 +24,13 @@ module Chillout
         end
       end
 
-      def test_enqueues_and_clears_creations
+      def test_enqueues_stats_and_clears_creations
         @client.expects(:enqueue).with(FakeJob::MOCK_CREATIONS)
+        @client.expects(:enqueue).with do |measurement|
+          SidekiqJobMeasurement === measurement &&
+            measurement.success == "true" &&
+            measurement.job_class == "Chillout::Middleware::SidekiqTest::FakeJob"
+        end
         Sidekiq::Testing.inline! { FakeJob.perform_async }
         assert_nil Chillout.creations
       end
@@ -35,11 +40,35 @@ module Chillout
         def perform; end
       end
 
-      def test_does_nothing_when_no_creations
+      def test_enqueues_stats_only_when_no_creations
+        @client.expects(:enqueue).with do |measurement|
+          SidekiqJobMeasurement === measurement
+        end
         Sidekiq::Testing.inline! { EmptyJob.perform_async }
         assert_nil Chillout.creations
       end
 
+      class ErrorJob
+        Doh = Class.new(StandardError)
+        include Sidekiq::Worker
+        def perform
+          raise Doh
+        end
+      end
+
+      def test_enqueues_stats_even_on_failure
+        @client.expects(:enqueue).with do |measurement|
+          SidekiqJobMeasurement === measurement &&
+            measurement.success == "false"
+        end
+        Sidekiq::Testing.inline! do
+          assert_raises(ErrorJob::Doh) do
+            ErrorJob.perform_async
+          end
+        end
+        assert_nil Chillout.creations
+      end
+
     end
   end
 end

data/test/support/rails_4_1_16/Gemfile

@@ -3,3 +3,8 @@ source 'https://rubygems.org'
 gem 'rails', '4.1.16'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2')
+  gem "sidekiq", ENV['SIDEKIQ_VERSION'] || "~> 4.2"
+else
+  gem "sidekiq", ENV['SIDEKIQ_VERSION'] || ">= 5"
+end

data/test/support/rails_4_1_16/app/jobs/create_entity_job.rb

@@ -0,0 +1,6 @@
+class CreateEntityJob
+  include Sidekiq::Worker
+  def perform
+    Entity.create!(name: Time.current.to_s)
+  end
+end

data/test/support/rails_4_2_0/Gemfile

@@ -4,7 +4,7 @@ gem 'rails', '4.2.0'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
 if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2')
-  gem "sidekiq", "~> 4.2"
+  gem "sidekiq", ENV['SIDEKIQ_VERSION'] || "~> 4.2"
 else
-  gem 'sidekiq'
+  gem "sidekiq", ENV['SIDEKIQ_VERSION'] || ">= 5"
 end

data/test/support/rails_4_2_8/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gem 'rails', '4.2.8'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
-gem 'sidekiq'
+gem "sidekiq", ENV['SIDEKIQ_VERSION'] || ">= 5"

data/test/support/rails_5_0_3/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gem 'rails', '5.0.3'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
-gem 'sidekiq'
+gem "sidekiq", ENV['SIDEKIQ_VERSION'] || ">= 5"

data/test/support/rails_5_1_1/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gem 'rails', '5.1.1'
 gem 'sqlite3'
 gem 'chillout', :path => '../../../'
-gem 'sidekiq'
+gem "sidekiq", ENV['SIDEKIQ_VERSION'] || ">= 5"

data/test/test_helper.rb

@@ -5,6 +5,7 @@ require 'rack/test'
 require 'pathname'
 require 'bbq/spawn'
 require 'sidekiq/testing'
+require 'sidekiq/api'
 
 $LOAD_PATH << File.expand_path('../../lib', __FILE__)
 
@@ -135,6 +136,12 @@ class TestSidekiqServer
       )
     end
   end
+
+  def clear_jobs
+    Sidekiq::Testing.disable! do
+      Sidekiq::Queue.new.💣
+    end
+  end
 end
 
 class TestEndpoint
@@ -145,6 +152,7 @@ class TestEndpoint
     @metrics  = Queue.new
     @startups = Queue.new
     @port = port
+    @all_metrics = []
   end
 
   def listen
@@ -182,36 +190,33 @@ class TestEndpoint
   end
 
   def has_one_creation_for_entity_resource
-    10.times do
-      begin
-        many = metrics.pop(true)
-        metric = many["measurements"].find{|m| m["series"] == "Entity" }
-        return metric if metric
-      rescue ThreadError
-        sleep(1)
-      end
-    end
-    false
+    look_for_series("Entity")
   end
 
   def has_one_purchase
-    10.times do
-      begin
-        many = metrics.pop(true)
-        metric = many["measurements"].find{|m| m["series"] == "purchases" }
-        return metric if metric
-      rescue ThreadError
-        sleep(1)
-      end
-    end
-    false
+    look_for_series("purchases")
   end
 
   def has_one_controller_metric
+    look_for_series("request")
+  end
+
+  def has_one_sidekiq_metric
+    look_for_series("sidekiq_jobs")
+  end
+
+  private
+
+  def look_for(&search)
     10.times do
       begin
+        metric = @all_metrics.find(&search)
+        return metric if metric
+
         many = metrics.pop(true)
-        metric = many["measurements"].find{|m| m["series"] == "request" }
+        @all_metrics.concat(many["measurements"])
+
+        metric = @all_metrics.find(&search)
         return metric if metric
       rescue ThreadError
         sleep(1)
@@ -220,5 +225,8 @@ class TestEndpoint
     false
   end
 
-end
+  def look_for_series(series)
+    look_for{|m| m["series"] == series }
+  end
 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chillout
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Michal Lomnicki
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -388,6 +388,7 @@ files:
 - test/support/rails_4_1_16/app/controllers/entities_controller.rb
 - test/support/rails_4_1_16/app/controllers/purchases_controller.rb
 - test/support/rails_4_1_16/app/helpers/application_helper.rb
+- test/support/rails_4_1_16/app/jobs/create_entity_job.rb
 - test/support/rails_4_1_16/app/models/.keep
 - test/support/rails_4_1_16/app/models/concerns/.keep
 - test/support/rails_4_1_16/app/models/entity.rb
@@ -800,6 +801,7 @@ test_files:
 - test/support/rails_4_1_16/app/controllers/entities_controller.rb
 - test/support/rails_4_1_16/app/controllers/purchases_controller.rb
 - test/support/rails_4_1_16/app/helpers/application_helper.rb
+- test/support/rails_4_1_16/app/jobs/create_entity_job.rb
 - test/support/rails_4_1_16/app/models/.keep
 - test/support/rails_4_1_16/app/models/concerns/.keep
 - test/support/rails_4_1_16/app/models/entity.rb