jobtick 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef3818e1dd990c8e9eb1a46b5ed83dcd91fa62e7487adecc999173a855de990a
-  data.tar.gz: 1f5fa1a374a40d710d6ba193e46b0adef866546ec9f4e7b192d4801040c9975f
+  metadata.gz: 9fbf13c9887fe65ec082ad5a3515ec3d2767330318e9fbeafca2731f6ea7e1f3
+  data.tar.gz: 7c1624eaa666bdec4318d087f7d4bd264f6abbe03091ad9746d88a001f2e1bf2
 SHA512:
-  metadata.gz: af465b7b4d392967a684e066c018d8f288b032a22590aa37f66e332b293fb0fb9c2964dc6e43ec5513b89d7e99150542cb0c475fd48b1dfe1dc25c582bd65dcd
-  data.tar.gz: 1c42f458a2ba090e5afca3de65dba113e0fdf1c0db466fe411b97cdc068cba45a65c913bacce13bfa05ebe4724fd001f8fee9568fbd72da2490f0714f5c3e45d
+  metadata.gz: 7b1b71c36e97bd70144c69118d7af1af461424529fc92bfa7926bc2289fcecd65e92ad7ac49652dcd413244e4258dbdf9087424dd44ee5b392909fb4be771f8d
+  data.tar.gz: 7f32abaf56da135c05d76dd5f1b77043d29bf6f99c919059b138367a1e21abd06460eaa5496f42655026e23f17f740b044e6c46f249849cf27fde2f9c46deea5

data/README.md

@@ -61,21 +61,6 @@ No changes to individual job files. No manual monitor creation. No names to keep
 
 ## What gets monitored
 
-### Whenever (`config/schedule.rb`)
-
-```ruby
-# Your existing schedule.rb — no changes needed
-every 1.day, at: '2:00 am' do
-  runner 'InvoiceJob.perform_later'
-end
-
-every :hour do
-  runner 'SyncInventoryJob.perform_later'
-end
-```
-
-JobTick reads this file at deploy time and creates a monitor for each job automatically.
-
 ### Solid Queue (`config/recurring.yml`)
 
 ```yaml
@@ -89,12 +74,17 @@ sync_exchange_rates:
   schedule: every hour
 ```
 
-Each entry becomes a monitor. If `NightlyReportJob` doesn't run within its expected window, you get an alert.
+At boot, JobTick reads this file and registers a monitor for each entry. It then installs an `around_perform` hook into `ActiveJob::Base` so every job execution automatically sends `started`, `completed`, and `failed` pings. No changes to your job files.
 
 ### Sidekiq periodic jobs
 
+Supports both **sidekiq-cron** and **Sidekiq::Periodic**:
+
 ```ruby
-# Your existing Sidekiq config — no changes needed
+# sidekiq-cron — loaded from config/sidekiq_cron.yml or in an initializer
+Sidekiq::Cron::Job.create(name: 'Nightly Cleanup', cron: '0 2 * * *', class: 'NightlyCleanupWorker')
+
+# Sidekiq::Periodic
 Sidekiq.configure_server do |config|
   config.periodic do |mgr|
     mgr.register('0 * * * *', HourlyDigestWorker)
@@ -103,6 +93,30 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+JobTick installs a server middleware that wraps every job execution. For native Sidekiq workers (`Sidekiq::Worker` subclasses) pings are sent by the middleware. For Active Job workers dispatched through Sidekiq, pings are sent by the `around_perform` hook instead, so nothing is double-counted.
+
+### Whenever (`config/schedule.rb`)
+
+Whenever schedules jobs as cron shell commands, so there is no Ruby hook point to instrument automatically. One setup step is required: run the generator and update your `config/schedule.rb` to use the `jobtick_runner` and `jobtick_rake` job types instead of the built-in `runner` and `rake`:
+
+```
+bundle exec rake jobtick:whenever:setup
+```
+
+This prints the two `job_type` definitions to add to the top of your schedule file, then use them in place of the standard types:
+
+```ruby
+every 1.day, at: '2:00 am' do
+  jobtick_runner 'InvoiceJob.perform_later', monitor_key: 'whenever.invoice_job'
+end
+
+every :hour do
+  jobtick_rake 'reports:sync', monitor_key: 'whenever.reports_sync'
+end
+```
+
+The job types wrap execution with `curl` pings to the JobTick API, so no changes to individual job classes are needed.
+
 ---
 
 ## What you get
@@ -121,7 +135,7 @@ end
 
 ## Requirements
 
-- Ruby >= 3.2
+- Ruby >= 3.3
 - Rails >= 7.0
 - One or more of: Whenever, Solid Queue, Sidekiq
 

data/lib/jobtick/hooks/active_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JobTick
+  module Hooks
+    module ActiveJob
+      def self.included(base)
+        base.around_perform do |job, block|
+          key = JobTick.monitor_key_for(job.class.name)
+          next block.call unless key
+
+          JobTick::Monitor.run(key) { block.call }
+        end
+      end
+    end
+  end
+end

data/lib/jobtick/middleware/sidekiq.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module JobTick
+  module Middleware
+    class Sidekiq
+      def call(_worker, job, _queue, &)
+        # Active Job wrappers are handled by the around_perform hook
+        return yield if job["wrapped"]
+
+        key = JobTick.monitor_key_for(job["class"])
+        return yield unless key
+
+        JobTick::Monitor.run(key, &)
+      end
+
+      def self.install
+        ::Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add(JobTick::Middleware::Sidekiq)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jobtick/parsers/sidekiq.rb

@@ -2,6 +2,10 @@
 
 module JobTick
   module Parsers
+    def self.slugify(str)
+      str.downcase.gsub(/[^a-z0-9]+/, "_").gsub(/\A_+|_+\z/, "")
+    end
+
     class Sidekiq
       def self.parse
         return [] unless defined?(::Sidekiq)
@@ -16,7 +20,7 @@ module JobTick
 
       def self.parse_cron_jobs
         ::Sidekiq::Cron::Job.all.map do |job|
-          { key: "sidekiq.#{slugify(job.name)}", schedule: job.cron, source: "sidekiq", task: job.klass }
+          { key: "sidekiq.#{Parsers.slugify(job.name)}", schedule: job.cron, source: "sidekiq", task: job.klass }
         end
       end
       private_class_method :parse_cron_jobs
@@ -24,17 +28,12 @@ module JobTick
       def self.parse_periodic_jobs
         periodic = sidekiq_periodic_config
         (periodic || []).map do |klass, opts|
-          { key: "sidekiq.#{slugify(klass.to_s)}", schedule: opts[:cron] || opts[:every].to_s,
+          { key: "sidekiq.#{Parsers.slugify(klass.to_s)}", schedule: opts[:cron] || opts[:every].to_s,
             source: "sidekiq", task: klass.to_s }
         end
       end
       private_class_method :parse_periodic_jobs
 
-      def self.slugify(str)
-        str.downcase.gsub(/[^a-z0-9]+/, "_").gsub(/\A_+|_+\z/, "")
-      end
-      private_class_method :slugify
-
       def self.sidekiq_periodic_config
         if ::Sidekiq.respond_to?(:default_configuration)
           ::Sidekiq.default_configuration[:periodic]

data/lib/jobtick/parsers/whenever.rb

@@ -26,9 +26,7 @@ module JobTick
       end
 
       def self.job_key(job)
-        task = job[:task].to_s.strip
-        slug = task.downcase.gsub(/[^a-z0-9]+/, "_").gsub(/\A_+|_+\z/, "")
-        "whenever.#{slug}"
+        "whenever.#{Parsers.slugify(job[:task].to_s.strip)}"
       end
       private_class_method :job_key
     end

data/lib/jobtick/railtie.rb

@@ -7,6 +7,9 @@ module JobTick
         next unless JobTick.config.enabled
 
         JobTick::Registry.sync
+
+        ::ActiveJob::Base.include(JobTick::Hooks::ActiveJob) if defined?(::ActiveJob::Base)
+        JobTick::Middleware::Sidekiq.install if defined?(::Sidekiq)
       end
     end
 

data/lib/jobtick/registry.rb

@@ -9,6 +9,10 @@ module JobTick
         Parsers::Sidekiq.parse
       ].flatten.compact
 
+      JobTick.monitor_map = monitors.each_with_object({}) do |m, map|
+        map[m[:task]] = m[:key] if m[:task]
+      end
+
       return [] if monitors.empty?
 
       app_name = Rails.application.class.module_parent_name if defined?(Rails)

data/lib/jobtick/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JobTick
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/jobtick.rb

@@ -9,6 +9,8 @@ require_relative "jobtick/parsers/whenever"
 require_relative "jobtick/parsers/solid_queue"
 require_relative "jobtick/parsers/sidekiq"
 require_relative "jobtick/registry"
+require_relative "jobtick/hooks/active_job"
+require_relative "jobtick/middleware/sidekiq"
 require_relative "jobtick/railtie" if defined?(Rails::Railtie)
 
 module JobTick
@@ -31,9 +33,20 @@ module JobTick
       defined?(Rails) ? Rails.logger : Logger.new($stdout)
     end
 
+    def monitor_map
+      @monitor_map ||= {}
+    end
+
+    attr_writer :monitor_map
+
+    def monitor_key_for(class_name)
+      monitor_map[class_name]
+    end
+
     def reset!
       @config = nil
       @client = nil
+      @monitor_map = {}
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jobtick
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Clearstack Labs
@@ -39,6 +39,8 @@ files:
 - lib/jobtick.rb
 - lib/jobtick/client.rb
 - lib/jobtick/configuration.rb
+- lib/jobtick/hooks/active_job.rb
+- lib/jobtick/middleware/sidekiq.rb
 - lib/jobtick/monitor.rb
 - lib/jobtick/parsers/sidekiq.rb
 - lib/jobtick/parsers/solid_queue.rb