inst-jobs-statsd 2.1.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d2f71f91477c6e30a43226165ea6506e6e7b186f3fcf4876ce3b99d8595cd1
-  data.tar.gz: a57c33ba7eb726155f0aa767a18dffc7cfb39f0faae21c51133d233076f7954d
+  metadata.gz: d5760a670863e6b529a17f1443c45b360ed9762b35ad9fe432a4bd66c5b3e90d
+  data.tar.gz: 0efe20cd91f2dcb8cb55b5f4df13c372aa2f1b60ff2401c5379a453ed16e1bae
 SHA512:
-  metadata.gz: 7a692a9342cceb3ab900493cda108515956203e30d83acd048b96f3da2a9978f59ea711196aac5ed1c0156001847bd06548a36cd2b8e395be80a2309f077a620
-  data.tar.gz: 70018e665a4e434fc6828391d0f67f753fb09569db8991baee0d44bfa72c73b9b3e770d5ecf8d6e0f1173961497ca586c96c552c10dfdef746c97157aea501e1
+  metadata.gz: 1a35e512b5a4b8a1e87205fa97a03922d70b95298635dda6d5778e9bcd110bb02b74dfd36791a963ca169dddbaafcac448c2e33beb1d640b27955f793138d990
+  data.tar.gz: bd8808fa5e79266049f4cc9852df42c8bea046fc19d96c0402831df006e1c2a982a8d0475f12ac603bc0b0baf7224585546f78b79b3a650611f06d67cc1fe283

data/lib/inst-jobs-statsd.rb

@@ -1,25 +1,29 @@
-require 'inst-jobs'
-require 'inst_statsd'
+# frozen_string_literal: true
 
-require_relative 'inst_jobs_statsd/version'
+require "inst-jobs"
+require "inst_statsd"
 
-require_relative 'inst_jobs_statsd/default_tracking'
-require_relative 'inst_jobs_statsd/jobs_tracker'
+require_relative "inst_jobs_statsd/version"
 
-require_relative 'inst_jobs_statsd/naming'
+require_relative "inst_jobs_statsd/default_tracking"
+require_relative "inst_jobs_statsd/jobs_tracker"
 
-require_relative 'inst_jobs_statsd/stats/counters'
-require_relative 'inst_jobs_statsd/stats/counters/failed'
-require_relative 'inst_jobs_statsd/stats/counters/run'
+require_relative "inst_jobs_statsd/naming"
 
-require_relative 'inst_jobs_statsd/stats/periodic'
-require_relative 'inst_jobs_statsd/stats/periodic/failed'
-require_relative 'inst_jobs_statsd/stats/periodic/queue'
-require_relative 'inst_jobs_statsd/stats/periodic/run'
+require_relative "inst_jobs_statsd/stats/counters"
+require_relative "inst_jobs_statsd/stats/counters/create"
+require_relative "inst_jobs_statsd/stats/counters/run"
+require_relative "inst_jobs_statsd/stats/counters/complete"
 
-require_relative 'inst_jobs_statsd/stats/timing'
-require_relative 'inst_jobs_statsd/stats/timing/failed'
-require_relative 'inst_jobs_statsd/stats/timing/perform'
-require_relative 'inst_jobs_statsd/stats/timing/pop'
+require_relative "inst_jobs_statsd/stats/periodic"
+require_relative "inst_jobs_statsd/stats/periodic/failed"
+require_relative "inst_jobs_statsd/stats/periodic/queue"
+require_relative "inst_jobs_statsd/stats/periodic/run"
 
-::InstStatsd::DefaultTracking.include InstJobsStatsd::DefaultTracking
+require_relative "inst_jobs_statsd/stats/timing"
+require_relative "inst_jobs_statsd/stats/timing/failed"
+require_relative "inst_jobs_statsd/stats/timing/perform"
+require_relative "inst_jobs_statsd/stats/timing/pop"
+require_relative "inst_jobs_statsd/ext/job"
+
+InstStatsd::DefaultTracking.include InstJobsStatsd::DefaultTracking

data/lib/inst_jobs_statsd/default_tracking.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Defines InstStatsd::DefaultTracking.track_jobs
 # to be consistent with InstStatsd::DefaultTracking.track_sql etc
 module InstJobsStatsd
@@ -8,7 +10,7 @@ module InstJobsStatsd
 
     module ClassMethods
       def track_jobs(enable_periodic_queries: true)
-        @jobs_tracker ||= JobsTracker.new(enable_periodic_queries: enable_periodic_queries)
+        @jobs_tracker ||= JobsTracker.new(enable_periodic_queries: enable_periodic_queries) # rubocop:disable Naming/MemoizedInstanceVariableName
       end
     end
   end

data/lib/inst_jobs_statsd/ext/job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module InstJobsStatsd
+  module Ext
+    module Job
+      def fail!
+        failed_job = super
+        InstJobsStatsd::Stats::Counters.report_count(:failed, 1, job: failed_job)
+        failed_job
+      end
+    end
+  end
+end

data/lib/inst_jobs_statsd/jobs_tracker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   class JobsTracker
     def self.track(enable_periodic_queries: true)
@@ -9,8 +11,10 @@ module InstJobsStatsd
     end
 
     def initialize(enable_periodic_queries: true)
-      Stats::Counters::Failed.enable
+      Stats::Counters::Create.enable
       Stats::Counters::Run.enable
+      Stats::Counters::Complete.enable
+      ::Delayed::Job.prepend InstJobsStatsd::Ext::Job
 
       if enable_periodic_queries
         Stats::Periodic::Failed.enable

data/lib/inst_jobs_statsd/naming.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Naming
-    BASENAME = 'delayedjob'.freeze
+    BASENAME = "delayedjob"
 
     # The root prefix for all stat names
     # TODO: Make this configurable
@@ -8,10 +10,6 @@ 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)
@@ -37,29 +35,27 @@ module InstJobsStatsd
     def self.dd_job_tags(job)
       tags = dd_region_tags
       return tags unless job
-      tags = custom_tags(job, tags)
+
+      tags[:cluster] = job.current_shard&.database_server&.id if job.respond_to?(:current_shard)
+      tags[:priority] = job.priority
+      tags.compact!
+
       return tags unless job.tag
-      return tags if job.tag =~ /Class:0x/
+      return tags if job.tag.include?("Class:0x")
 
       method_tag, obj_tag = split_to_tag(job)
       tag = obj_tag
-      tag = [obj_tag, method_tag].join('.') if method_tag.present?
+      tag = [obj_tag, method_tag].join(".") if method_tag.present?
       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",
     # and makes sure the values are valid to be used for statsd names
     def self.job_tags(job)
       return unless job
       return unless job.tag
-      return if job.tag =~ /Class:0x/
+      return if job.tag.include?("Class:0x")
 
       method_tag, obj_tag = split_to_tag(job)
       tags = [obj_tag]
@@ -70,28 +66,27 @@ module InstJobsStatsd
     # We are using all existing stat names here because we do not want
     # to break existing dependencies on the non-regioned data
     def self.region_tags(stat_names)
-      return unless ENV['INST_JOBS_STATSD_NAMESPACE']
+      return unless ENV["INST_JOBS_STATSD_NAMESPACE"]
 
       stat_names.map do |name|
         name
-          .split('.')
-          .insert(2, ENV['INST_JOBS_STATSD_NAMESPACE'])
-          .join('.')
+          .split(".")
+          .insert(2, ENV["INST_JOBS_STATSD_NAMESPACE"])
+          .join(".")
       end
     end
 
     def self.dd_region_tags
-      return {} unless ENV['INST_JOBS_STATSD_NAMESPACE']
-      {namespace: ENV['INST_JOBS_STATSD_NAMESPACE']}
-    end
+      return {} unless ENV["INST_JOBS_STATSD_NAMESPACE"]
 
-    private
+      { namespace: ENV["INST_JOBS_STATSD_NAMESPACE"] }
+    end
 
     def self.split_to_tag(job)
       obj_tag, method_tag = job.tag.split(/[\.#]/, 2).map do |v|
-        InstStatsd::Statsd.escape(v).gsub('::', '-')
+        InstStatsd::Statsd.escape(v).gsub("::", "-")
       end
-      return method_tag, obj_tag
+      [method_tag, obj_tag]
     end
   end
 end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module InstJobsStatsd
+  module Stats
+    module Counters
+      module Complete
+        def self.enable
+          enable_complete_count
+        end
+
+        def self.enable_complete_count
+          Delayed::Worker.lifecycle.after(:perform) do |_worker, job|
+            report_complete_count(job)
+          end
+        end
+
+        def self.report_complete_count(job)
+          Counters.report_count(:complete, 1, job: job)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module InstJobsStatsd
+  module Stats
+    module Counters
+      module Create
+        def self.enable
+          enable_create_count
+        end
+
+        def self.enable_create_count
+          Delayed::Worker.lifecycle.after(:create) do |_, result:|
+            report_create_count(result)
+          end
+        end
+
+        def self.report_create_count(job)
+          Counters.report_count(:create, 1, job: job)
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Counters

data/lib/inst_jobs_statsd/stats/counters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Counters

data/lib/inst_jobs_statsd/stats/periodic/failed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Periodic

data/lib/inst_jobs_statsd/stats/periodic/queue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Periodic
@@ -35,7 +37,7 @@ module InstJobsStatsd
           jobs_run_at = queued_jobs_scope.limit(10_000).pluck(:run_at)
           age_secs = jobs_run_at.map { |t| Delayed::Job.db_time_now - t }
           Periodic.report_gauge(:queue_age_total, age_secs.sum)
-          Periodic.report_gauge(:queue_age_max, age_secs.max)
+          Periodic.report_gauge(:queue_age_max, age_secs.max || 0)
         end
 
         def self.queued_jobs_scope

data/lib/inst_jobs_statsd/stats/periodic/run.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Periodic
@@ -26,7 +28,7 @@ module InstJobsStatsd
           jobs_run_at = running_jobs_scope.limit(10_000).pluck(:run_at)
           age_secs = jobs_run_at.map { |t| Delayed::Job.db_time_now - t }
           Periodic.report_gauge(:run_age_total, age_secs.sum)
-          Periodic.report_gauge(:run_age_max, age_secs.max)
+          Periodic.report_gauge(:run_age_max, age_secs.max || 0)
         end
 
         def self.running_jobs_scope

data/lib/inst_jobs_statsd/stats/periodic.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Periodic
       def self.enable_callbacks
-        @instance ||= Callbacks.new
+        @instance ||= Callbacks.new # rubocop:disable Naming/MemoizedInstanceVariableName
       end
 
       def self.add(proc)
         return unless @instance
+
         @instance.add(proc)
       end
 
@@ -72,6 +75,7 @@ module InstJobsStatsd
         # When the required interval of time has passed, execute the given block
         def tick
           return unless Delayed::Job.db_time_now >= @next_run
+
           update_next_run
           yield
         end
@@ -83,7 +87,7 @@ module InstJobsStatsd
         # from the target interval as much as possible
         def update_next_run
           ticks = ((Delayed::Job.db_time_now - @start_time) / @min_interval).floor
-          @next_run = @start_time + (ticks + 1) * @min_interval
+          @next_run = @start_time + ((ticks + 1) * @min_interval)
         end
       end
     end

data/lib/inst_jobs_statsd/stats/timing/failed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Timing

data/lib/inst_jobs_statsd/stats/timing/perform.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Timing

data/lib/inst_jobs_statsd/stats/timing/pop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Timing

data/lib/inst_jobs_statsd/stats/timing.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
   module Stats
     module Timing
-      def self.report_timing(stat, job: nil, timing: nil, sample_rate: 1)
+      def self.report_timing(stat, job: nil, timing: nil, sample_rate: 1, &block)
         stats = Naming.qualified_names(stat, job)
 
-        if block_given?
-          InstStatsd::Statsd.time(stats, sample_rate, short_stat: stat, tags: Naming.dd_job_tags(job)) { yield }
+        if block
+          InstStatsd::Statsd.time(stats, sample_rate, short_stat: stat, tags: Naming.dd_job_tags(job), &block)
         else
           InstStatsd::Statsd.timing(stats, timing, sample_rate, short_stat: stat, tags: Naming.dd_job_tags(job))
         end
@@ -13,12 +15,14 @@ module InstJobsStatsd
 
       def self.report_job_timing_queued(job)
         return unless job
+
         time_in_queue = ((Delayed::Job.db_time_now - job.run_at) * 1000).round
         report_timing(:queue, job: job, timing: time_in_queue)
       end
 
       def self.report_job_timing_failed(job)
         return unless job
+
         time_to_failure = ((Delayed::Job.db_time_now - job.run_at) * 1000).round
         report_timing(:failed_after, job: job, timing: time_to_failure)
       end

data/lib/inst_jobs_statsd/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module InstJobsStatsd
-  VERSION = '2.1.0'.freeze
+  VERSION = "3.0.2"
 end