inst-jobs-statsd 1.2.2 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f299ba77daf29bef9b9a2f8f52710fd23029d3f122d723ec8c19518389ba10cf
-  data.tar.gz: 38df7c0062ee2c19622e19e24377d853e05c55eb3d59253f470fb40668afb2c1
+  metadata.gz: a5903c772d523ffc042f3c178230cfb16973ca1d233c3b00c2e1c7b15ce05889
+  data.tar.gz: a6b313b2539a309361b8d40c0d30b9f7e4de617aa014abe6499503e7cbec147f
 SHA512:
-  metadata.gz: f45e0aea9f8e01b3e592754fd596d03a1123d74958803f3b6250964adbaa132fe1d5467fad6a9ac330b68f9df0225e9a1851662a08f29834d769d5020c3b3c47
-  data.tar.gz: a1376daa61d0e4db5911c707dc2524af23fabca7788ee626cbfa7d0ca06fd6f77003d7ea2cbda9acff13bd4c0283f52f89ba4b3d64d9608a4a921db2eff96811
+  metadata.gz: 02c42027da50b1ab69fdfc8a4045ce106efd6b9d1b17d6df122c443136fd4541f70e1632f79855db0e6e19a2b4bf1d09db7aa33747f27d99f2960d1ca57f0f52
+  data.tar.gz: 7a873df94b01d909e262ca4d53b6a632d77c606771da12cebb83e905e251f32c6627cce1da50c7a630ddbcc05372b24ff72432d6aeef804dd56ff867d24837b9

data/lib/inst-jobs-statsd.rb

@@ -10,7 +10,6 @@ require_relative 'inst_jobs_statsd/naming'
 
 require_relative 'inst_jobs_statsd/stats/counters'
 require_relative 'inst_jobs_statsd/stats/counters/failed'
-require_relative 'inst_jobs_statsd/stats/counters/orphaned'
 require_relative 'inst_jobs_statsd/stats/counters/run'
 
 require_relative 'inst_jobs_statsd/stats/periodic'

data/lib/inst_jobs_statsd/default_tracking.rb

@@ -7,8 +7,8 @@ module InstJobsStatsd
     end
 
     module ClassMethods
-      def track_jobs
-        @jobs_tracker ||= JobsTracker.new
+      def track_jobs(enable_periodic_queries: true)
+        @jobs_tracker ||= JobsTracker.new(enable_periodic_queries: enable_periodic_queries)
       end
     end
   end

data/lib/inst_jobs_statsd/jobs_tracker.rb

@@ -1,21 +1,22 @@
 module InstJobsStatsd
   class JobsTracker
-    def self.track
-      @current_tracking = new
+    def self.track(enable_periodic_queries: true)
+      @current_tracking = new(enable_periodic_queries: enable_periodic_queries)
       yield
       tracking = @current_tracking
       @current_tracking = nil
       tracking
     end
 
-    def initialize
+    def initialize(enable_periodic_queries: true)
       Stats::Counters::Failed.enable
-      Stats::Counters::Orphaned.enable
       Stats::Counters::Run.enable
 
-      Stats::Periodic::Failed.enable
-      Stats::Periodic::Queue.enable
-      Stats::Periodic::Run.enable
+      if enable_periodic_queries
+        Stats::Periodic::Failed.enable
+        Stats::Periodic::Queue.enable
+        Stats::Periodic::Run.enable
+      end
 
       Stats::Timing::Failed.enable
       Stats::Timing::Perform.enable

data/lib/inst_jobs_statsd/naming.rb

@@ -8,6 +8,10 @@ module InstJobsStatsd
       BASENAME
     end
 
+    def self.configure(strand_filter: nil)
+      @strand_filter = strand_filter
+    end
+
     def self.qualified_names(stat_name, job)
       names = ["#{basename}.#{stat_name}"]
       tagged = tagged_stat(names[0], job)
@@ -31,14 +35,23 @@ module InstJobsStatsd
     end
 
     def self.dd_job_tags(job)
-      return {} unless job
-      return {} unless job.tag
-      return {} if job.tag =~ /Class:0x/
+      tags = dd_region_tags
+      return tags unless job
+      tags = custom_tags(job, tags)
+      return tags unless job.tag
+      return tags if job.tag =~ /Class:0x/
 
       method_tag, obj_tag = split_to_tag(job)
       tag = obj_tag
       tag = [obj_tag, method_tag].join('.') if method_tag.present?
-      {tag: tag}
+      tags[:tag] = tag
+      tags
+    end
+
+    def self.custom_tags(job, tags)
+      tags[:jobshard] = job.shard.id if job.respond_to?(:shard)
+      tags[:strand] = job.strand if job&.strand && @strand_filter&.call(job)
+      tags
     end
 
     # this converts Foo#bar" or "Foo.bar" into "Foo and "bar",
@@ -67,6 +80,11 @@ module InstJobsStatsd
       end
     end
 
+    def self.dd_region_tags
+      return {} unless ENV['INST_JOBS_STATSD_NAMESPACE']
+      {namespace: ENV['INST_JOBS_STATSD_NAMESPACE']}
+    end
+
     private
 
     def self.split_to_tag(job)

data/lib/inst_jobs_statsd/version.rb

@@ -1,3 +1,3 @@
 module InstJobsStatsd
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.4.1'.freeze
 end

data/spec/factories/jobs.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
   class JobFixture
-    attr_accessor :tag, :run_at
+    attr_accessor :tag, :run_at, :strand
   end
 
   factory :job_fixture, aliases: [:job] do

data/spec/gemfiles/42.gemfile

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gemspec :path=>"../../"
 
-gem "rails", "~> 4.2.5"
-gem "after_transaction_commit", "<2"
-gem 'test_after_commit', '0.4.1'
+gem "rails", "~> 4.2.11"
+gem "pg", "~> 0.21.0"
+gem "after_transaction_commit", "< 2"
+gem "test_after_commit", "1.1.0"

data/spec/gemfiles/51.gemfile

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gemspec :path=>"../../"
 
-gem "rails", "~> 5.1.0"
-gem 'sinatra', "2.0.0.beta2"
-gem 'sinatra-contrib', "2.0.0.beta2"
+gem "rails", "~> 5.1.7"
+gem "sinatra", "~> 2.0.8"
+gem "sinatra-contrib", "~> 2.0.8"
+gem "sprockets", "~> 3.7" # 4.0+ requires Ruby 2.5

data/spec/gemfiles/60.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec :path=>"../../"
+
+gem "rails", "~> 6.0"
+gem "sinatra", "~> 2.0.8"
+gem "sinatra-contrib", "~> 2.0.8"

data/spec/inst_jobs_statsd/jobs_tracker_spec.rb

@@ -13,7 +13,6 @@ RSpec.describe InstJobsStatsd::JobsTracker do
   describe '.initialize' do
     it 'enables everything' do
       expect(InstJobsStatsd::Stats::Counters::Failed).to receive(:enable)
-      expect(InstJobsStatsd::Stats::Counters::Orphaned).to receive(:enable)
       expect(InstJobsStatsd::Stats::Counters::Run).to receive(:enable)
 
       expect(InstJobsStatsd::Stats::Periodic::Failed).to receive(:enable)

data/spec/inst_jobs_statsd/naming_spec.rb

@@ -40,5 +40,17 @@ RSpec.describe InstJobsStatsd::Naming do
       it { should include 'delayedjob.wut.region_name' }
       it { should include 'delayedjob.wut.region_name.tag.a_tag_name' }
     end
+
+    describe '.dd_job_tags' do
+      it 'works' do
+        job = double(tag: 'Account.run_reports_later', shard: double(id: 101), strand: 'special')
+        expect(InstJobsStatsd::Naming.dd_job_tags(job)).to eq({ tag: 'Account.run_reports_later', jobshard: 101})
+      end
+
+      it 'properly munges job tags' do
+        job = double(tag: 'Quizzes::Quiz#do_something', strand: nil)
+        expect(InstJobsStatsd::Naming.dd_job_tags(job)).to eq({ tag: 'Quizzes-Quiz.do_something'})
+      end
+    end
   end
 end

data/spec/setup_test_db.rb

@@ -35,7 +35,15 @@ ActiveRecord::Base.establish_connection(connection_config)
 
 # Apply the migrations from the inst-jobs gem
 inst_jobs_spec = Gem::Specification.find_by_name('inst-jobs')
-ActiveRecord::Migrator.migrate(inst_jobs_spec.gem_dir + '/db/migrate')
-ActiveRecord::Migrator.migrate(inst_jobs_spec.gem_dir + '/spec/migrate')
+if ::Rails.version >= '6'
+  sm = ActiveRecord::Base.connection.schema_migration
+  migrations = ActiveRecord::MigrationContext.new(inst_jobs_spec.gem_dir + '/db/migrate', sm).migrations
+  ActiveRecord::Migrator.new(:up, migrations, sm).migrate
+  migrations = ActiveRecord::MigrationContext.new(inst_jobs_spec.gem_dir + '/spec/migrate', sm).migrations
+  ActiveRecord::Migrator.new(:up, migrations, sm).migrate
+else
+  ActiveRecord::Migrator.migrate(inst_jobs_spec.gem_dir + '/db/migrate')
+  ActiveRecord::Migrator.migrate(inst_jobs_spec.gem_dir + '/spec/migrate')
+end
 Delayed::Backend::ActiveRecord::Job.reset_column_information
 Delayed::Backend::ActiveRecord::Job::Failed.reset_column_information

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-if /^2\.4/ =~ RUBY_VERSION && /50\./ =~ ENV['BUNDLE_GEMFILE'] # Limit coverage to one build
+if /^2\.5/ =~ RUBY_VERSION && /51\./ =~ ENV['BUNDLE_GEMFILE'] # Limit coverage to one build
   require 'simplecov'
 
   SimpleCov.start do
@@ -6,8 +6,6 @@ if /^2\.4/ =~ RUBY_VERSION && /50\./ =~ ENV['BUNDLE_GEMFILE'] # Limit coverage t
     add_filter 'spec'
     track_files 'lib/**/*.rb'
   end
-
-  SimpleCov.minimum_coverage(100)
 end
 
 require 'inst-jobs-statsd'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inst-jobs-statsd
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.4.1
 platform: ruby
 authors:
 - Jeremy Slade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inst-jobs
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: inst_statsd
   requirement: !ruby/object:Gem::Requirement
@@ -96,16 +96,16 @@ dependencies:
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -124,16 +124,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -166,44 +166,44 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.48.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.48.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -224,14 +224,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 description: 
 email:
 - jslade@instructure.com
@@ -245,7 +245,6 @@ files:
 - lib/inst_jobs_statsd/naming.rb
 - lib/inst_jobs_statsd/stats/counters.rb
 - lib/inst_jobs_statsd/stats/counters/failed.rb
-- lib/inst_jobs_statsd/stats/counters/orphaned.rb
 - lib/inst_jobs_statsd/stats/counters/run.rb
 - lib/inst_jobs_statsd/stats/periodic.rb
 - lib/inst_jobs_statsd/stats/periodic/failed.rb
@@ -259,12 +258,11 @@ files:
 - spec/factories/jobs.rb
 - spec/factories/workers.rb
 - spec/gemfiles/42.gemfile
-- spec/gemfiles/50.gemfile
 - spec/gemfiles/51.gemfile
+- spec/gemfiles/60.gemfile
 - spec/inst_jobs_statsd/jobs_tracker_spec.rb
 - spec/inst_jobs_statsd/naming_spec.rb
 - spec/inst_jobs_statsd/stats/counters/failed_spec.rb
-- spec/inst_jobs_statsd/stats/counters/orphaned_spec.rb
 - spec/inst_jobs_statsd/stats/counters/run_spec.rb
 - spec/inst_jobs_statsd/stats/periodic/failed_spec.rb
 - spec/inst_jobs_statsd/stats/periodic/queue_spec.rb
@@ -290,15 +288,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Stats reporting for inst-jobs
@@ -313,14 +310,13 @@ test_files:
 - spec/inst_jobs_statsd/stats/periodic_spec.rb
 - spec/inst_jobs_statsd/stats/counters/failed_spec.rb
 - spec/inst_jobs_statsd/stats/counters/run_spec.rb
-- spec/inst_jobs_statsd/stats/counters/orphaned_spec.rb
 - spec/inst_jobs_statsd/stats/timing_spec.rb
 - spec/inst_jobs_statsd/jobs_tracker_spec.rb
 - spec/spec_helper.rb
 - spec/setup_test_db.rb
 - spec/matchers.rb
+- spec/gemfiles/60.gemfile
 - spec/gemfiles/42.gemfile
-- spec/gemfiles/50.gemfile
 - spec/gemfiles/51.gemfile
 - spec/factories/workers.rb
 - spec/factories/jobs.rb

data/lib/inst_jobs_statsd/stats/counters/orphaned.rb

@@ -1,34 +0,0 @@
-module InstJobsStatsd
-  module Stats
-    module Counters
-      module Orphaned
-        def self.enable
-          enable_orphaned_count
-        end
-
-        # The idea of the orphaned count: when a job finishes, if there
-        # are other jobs locked_by the *same* worker, they must have been
-        # orphaned, because they are not going to be picked up and run by
-        # the worker -- the work queue is designed to only have one job
-        # locked_by a worker at a time.
-        # This is based on the symptom seen in AMS-447, where mutliple
-        # rows of the jobs table can be (incorrectly) updated by the same
-        # query.
-        def self.enable_orphaned_count
-          Delayed::Worker.lifecycle.before(:perform) do |_worker, job|
-            report_orphaned_count(job)
-          end
-        end
-
-        def self.report_orphaned_count(job)
-          scope = Delayed::Job.where(
-            'locked_by = ? AND locked_at = ? AND id <> ?',
-            job.locked_by, job.locked_at, job.id
-          )
-          count = scope.count
-          Counters.report_count(:orphaned, count, job: job) unless count.zero?
-        end
-      end
-    end
-  end
-end

data/spec/gemfiles/50.gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec :path=>"../../"
-
-gem "rails", "~> 5.0.0"
-gem 'sinatra', "2.0.0.beta2"
-gem 'sinatra-contrib', "2.0.0.beta2"

data/spec/inst_jobs_statsd/stats/counters/orphaned_spec.rb

@@ -1,27 +0,0 @@
-RSpec.describe InstJobsStatsd::Stats::Counters::Orphaned do
-  describe '.enable' do
-    it 'enables all the things' do
-      expect(InstJobsStatsd::Stats::Counters::Orphaned).to receive(:enable_orphaned_count)
-      InstJobsStatsd::Stats::Counters::Orphaned.enable
-    end
-  end
-
-  describe '.report_orphaned_count' do
-    let(:x) { Struct.new(:perform).new(true) }
-
-    before do
-      Delayed::Worker.lifecycle.reset!
-      InstJobsStatsd::Stats::Counters::Orphaned.enable
-
-      4.times { x.send_later(:perform) }
-      Delayed::Job.order(:id).limit(3)
-                  .update_all(locked_by: 'test', locked_at: Delayed::Job.db_time_now)
-    end
-
-    it do
-      expect(InstStatsd::Statsd).to receive(:count)
-        .with(array_including(/\.orphaned$/), 2, 1, { short_stat: anything, tags: {} })
-      Delayed::Worker.lifecycle.run_callbacks(:perform, nil, Delayed::Job.first) {}
-    end
-  end
-end