sidekiq_publisher 1.6.4 → 1.7.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '067609f016376825479264cb9151d9dd8d306cdbbc019b2f2dbe08fa503eb01e'
-  data.tar.gz: 6b93fa60214589688a2e6e993bebbb92ba1d321f67dd9a6497a654b5e1cde438
+  metadata.gz: 857fd87d65ea4d55711d45e269148eeb0b14454a27ae4315c507815b22c86ea4
+  data.tar.gz: 7d3d092e6e2df1c64734c6a60a8bc8b084fba68c8e684f4e0e578c99fdea117b
 SHA512:
-  metadata.gz: 35eecd771b2561add98ffc2efa8661800e2b60bb6664918cd6de09906a6839bf515c4cff640e317ba16903b7ad4b36ceccfbbf894dcfaa2d2c1b8709b2615a9a
-  data.tar.gz: 508cb5e0d9e9af56c3a068c87520f1085b85dda2477fb49a467a00d9fc846b885f27c5ceffc732a4dd5e06a981ed247b76af0a33bfa86daa7ef64c45d3e8e7eb
+  metadata.gz: 2938169bd4db7a074936bc48f46456c4ec2700a5bfc60adf4039ffc87666f3ba99f5c42504e72dfa34c55fc71568f4e7ef695489d3c9165db66c996a3a6363bb
+  data.tar.gz: da2bbee1abf0fb70a7afb05b48d5c7c692ea9911ae5b26f35500eb69792a54872213d509c7842564bcc5b659c1070415cb0bd52d71e4cfcdb5acb6705a2fafa3

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @ezcater/core-platform @tjwp

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # sidekiq_publisher
 
+## v1.7.0 (unreleased)
+- Add instrumentation using `ActiveSupport::Notifications`.
+- Reimplement `metrics_reporter` and `exception_reporter` support using
+  `ActiveSupport::Subscriber`.
+- Add optional integration with Datadog APM.
+
 ## v1.6.4
 - Expand sidekiq support to v5.0.x-v6.x.x.
 

data/Dockerfile

@@ -0,0 +1,4 @@
+FROM ezcater-production.jfrog.io/ruby:f08726283c
+RUN mkdir /usr/src/gem
+WORKDIR /usr/src/gem
+ADD . /usr/src/gem

data/README.md

@@ -72,6 +72,34 @@ SidekiqPublisher::ReportUnpublishedCount.call
 It is recommended to call this method periodically using something like
 cron or [clockwork](https://github.com/Rykian/clockwork).
 
+## Instrumentation
+
+Instrumentation of this library is implemented using
+[ActiveSupport::Notifications](https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html).
+
+The support for the configurable [metrics_reporter](lib/sidekiq_publisher/metrics_reporter.rb) and
+[exception_reporter](lib/sidekiq_publisher/exception_reporter.rb) options is implemented using
+[ActiveSupport::Subscriber](https://api.rubyonrails.org/classes/ActiveSupport/Subscriber.html).
+
+If an alternate integration is required for metrics or error reporting then it can be implemented using outside this
+library based on these examples.
+
+### Tracing
+
+The instrumentation in the library also supports integration with application tracing products, such as
+[Datadog APM](https://www.datadoghq.com/product/apm/).
+
+There is an optional integration with Datadog APM that can be required:
+
+```ruby
+require "sidekiq_publisher/datadog_apm"
+```
+
+This file must be required in addition including the `sidekiq_publisher` gem or requiring `sidekiq_publisher`.
+
+This integration covers all of the sections of the library that are instrumented and serves an
+[example](lib/sidekiq_publisher/datadog_apm) for implementing trace reporting for other products outside this library.
+
 ## Usage
 
 ### ActiveJob Adapter

data/docker-compose.yml

@@ -0,0 +1,43 @@
+version: "3.4"
+volumes:
+  bundle-volume:
+  shared-volume:
+x-environment: &default-environment
+  PRYRC: /usr/src/app/.docker-pryrc
+  BUNDLE_IGNORE_CONFIG: 1
+  BUNDLE_DISABLE_SHARED_GEMS: "true"
+  PGUSER: postgres
+  PGHOST: sidekiq-publisher-postgres
+  PGPORT: 5432
+  PGDATABASE: sidekiq_publisher_test
+  REDIS_URL: redis://sidekiq-publisher-redis:6379
+x-service: &default-service
+  build:
+    context: .
+    args:
+      - BUNDLE_EZCATER__JFROG__IO
+  volumes:
+    - .:/usr/src/gem
+    - bundle-volume:/usr/local/bundle:delegated
+    - shared-volume:/usr/src/shared:delegated
+  tty: true
+  stdin_open: true
+services:
+  sidekiq-publisher-redis:
+    container_name: sidekiq-publisher-redis_1
+    image: redis:5.0.9-alpine
+  sidekiq-publisher-postgres:
+    container_name: sidekiq-publisher-postgres_1
+    image: postgres:11.6
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: sidekiq_publisher_test
+  sidekiq-publisher-console:
+    <<: *default-service
+    container_name: sidekiq-publisher-console_1
+    environment:
+      <<: *default-environment
+    command: bash
+    depends_on:
+      - sidekiq-publisher-redis
+      - sidekiq-publisher-postgres

data/lib/sidekiq_publisher.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require "active_support"
 require "sidekiq_publisher/version"
+require "sidekiq_publisher/instrumenter"
+require "sidekiq_publisher/metrics_reporter"
+require "sidekiq_publisher/exception_reporter"
 require "sidekiq_publisher/report_unpublished_count"
 require "sidekiq_publisher/job"
 require "sidekiq_publisher/worker"

data/lib/sidekiq_publisher/datadog_apm.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "active_support/subscriber"
+require "ddtrace"
+
+module SidekiqPublisher
+  module DatadogAPM
+    class << self
+      attr_writer :service
+
+      def service
+        @service || "sidekiq-publisher"
+      end
+    end
+
+    class Subscriber
+      def self.subscribe_to(pattern)
+        ActiveSupport::Notifications.subscribe(pattern, new)
+      end
+
+      def finish(_name, _id, payload)
+        finish_span(payload)
+      end
+
+      private
+
+      def start_span(operation, payload)
+        # Internal sanity check
+        raise "Fix operation name: #{operation}" if operation.end_with?("sidekiq_publisher")
+
+        payload[:datadog_span] = Datadog.tracer.trace(operation, service: service)
+      end
+
+      def finish_span(payload)
+        payload[:datadog_span]&.set_error(payload[:exception_object]) if payload.key?(:exception_object)
+        payload[:datadog_span]&.finish
+      end
+
+      def service
+        SidekiqPublisher::DatadogAPM.service
+      end
+    end
+
+    class ListenerSubscriber < Subscriber
+      def start(_name, _id, payload)
+        start_span("listener.timeout", payload)
+      end
+
+      subscribe_to "timeout.listener.sidekiq_publisher"
+    end
+
+    class RunnerSubscriber < Subscriber
+      def start(name, _id, payload)
+        op_name = name.split(".").first
+        start_span("publisher.#{op_name}", payload)
+      end
+
+      subscribe_to "start.publisher.sidekiq_publisher"
+      subscribe_to "notify.publisher.sidekiq_publisher"
+      subscribe_to "timeout.publisher.sidekiq_publisher"
+    end
+
+    class PublisherSubscriber < Subscriber
+      def start(name, _id, payload)
+        op_name = name.split(".").first
+        start_span("publisher.#{op_name}", payload)
+      end
+
+      def finish(name, id, payload)
+        payload[:datadog_span]&.set_tag(:published_count, payload[:published_count]) if payload.key?(:published_count)
+        super
+      end
+
+      subscribe_to "publish_batch.publisher.sidekiq_publisher"
+      subscribe_to "enqueue_batch.publisher.sidekiq_publisher"
+    end
+
+    class JobSubscriber < Subscriber
+      def start(_name, _id, payload)
+        start_span("job.purge", payload)
+      end
+
+      def finish(_name, _id, payload)
+        payload[:datadog_span]&.set_tag(:purged_count, payload[:purged_count]) if payload.key?(:purged_count)
+
+        super
+      end
+
+      subscribe_to "purge.job.sidekiq_publisher"
+    end
+
+    # This subscriber is different from the classes above because it is an ActiveSupport::Subscriber
+    # and responds to the error(.publisher.sidekiq_publisher) event.
+    class PublisherErrorSubscriber < ActiveSupport::Subscriber
+      def error(event)
+        Datadog.tracer.active_span&.set_error(event.payload[:exception_object])
+      end
+
+      attach_to "publisher.sidekiq_publisher"
+    end
+  end
+end

data/lib/sidekiq_publisher/exception_reporter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/subscriber"
+
+module SidekiqPublisher
+  module ExceptionReporter
+    class PublisherErrorSubscriber < ActiveSupport::Subscriber
+      def error(event)
+        SidekiqPublisher.exception_reporter&.call(event.payload[:exception_object])
+      end
+
+      attach_to "publisher.sidekiq_publisher"
+    end
+  end
+end

data/lib/sidekiq_publisher/instrumenter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+
+module SidekiqPublisher
+  class Instrumenter
+    NAMESPACE = "sidekiq_publisher"
+
+    def instrument(event_name, payload = {}, &block)
+      ActiveSupport::Notifications.instrument("#{event_name}.#{NAMESPACE}", payload, &block)
+    end
+  end
+end

data/lib/sidekiq_publisher/job.rb

@@ -39,11 +39,12 @@ module SidekiqPublisher
       where(id: ids).update_all(published_at: Time.now.utc)
     end
 
-    def self.purge_expired_published!
+    def self.purge_expired_published!(instrumenter: Instrumenter.new)
       SidekiqPublisher.logger.info("#{name} purging expired published jobs.")
-      count = purgeable.delete_all
+      count = instrumenter.instrument("purge.job") do |notification|
+        notification[:purged_count] = purgeable.delete_all
+      end
       SidekiqPublisher.logger.info("#{name} purged #{count} expired published jobs.")
-      SidekiqPublisher.metrics_reporter.try(:count, "sidekiq_publisher.purged", count)
     end
 
     def self.unpublished_batches(batch_size: SidekiqPublisher.batch_size)

data/lib/sidekiq_publisher/metrics_reporter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "active_support/subscriber"
+
+module SidekiqPublisher
+  module MetricsReporter
+    class Subscriber < ActiveSupport::Subscriber
+      private
+
+      def count(metric, value)
+        SidekiqPublisher.metrics_reporter&.try(:count, metric, value) unless value.nil?
+      end
+    end
+
+    class PublisherSubscriber < Subscriber
+      def enqueue_batch(event)
+        count("sidekiq_publisher.published", event.payload[:published_count])
+      end
+
+      attach_to "publisher.sidekiq_publisher"
+    end
+
+    class JobSubscriber < Subscriber
+      def purge(event)
+        count("sidekiq_publisher.purged", event.payload[:purged_count])
+      end
+
+      attach_to "job.sidekiq_publisher"
+    end
+
+    class UnpublishedSubscriber < Subscriber
+      def unpublished(event)
+        SidekiqPublisher.metrics_reporter&.
+          try(:gauge, "sidekiq_publisher.unpublished_count", event.payload[:unpublished_count])
+      end
+
+      attach_to "reporter.sidekiq_publisher"
+    end
+  end
+end

data/lib/sidekiq_publisher/publisher.rb

@@ -5,26 +5,31 @@ require "active_support/core_ext/object/try"
 
 module SidekiqPublisher
   class Publisher
-    def initialize
+    def initialize(instrumenter: Instrumenter.new)
+      @instrumenter = instrumenter
       @client = SidekiqPublisher::Client.new
       @job_class_cache = {}
     end
 
     def publish
       Job.unpublished_batches do |batch|
-        items = batch.map do |job|
-          {
-            "jid" => job[:job_id],
-            "class" => lookup_job_class(job[:job_class]),
-            "args" => job[:args],
-            "at" => job[:run_at],
-            "queue" => job[:queue],
-            "wrapped" => job[:wrapped],
-            "created_at" => job[:created_at].to_f,
-          }.tap(&:compact!)
-        end
+        instrumenter.instrument("publish_batch.publisher") do
+          items = batch.map do |job|
+            {
+              "jid" => job[:job_id],
+              "class" => lookup_job_class(job[:job_class]),
+              "args" => job[:args],
+              "at" => job[:run_at],
+              "queue" => job[:queue],
+              "wrapped" => job[:wrapped],
+              "created_at" => job[:created_at].to_f,
+            }.tap(&:compact!)
+          end
 
-        publish_batch(batch, items)
+          instrumenter.instrument("enqueue_batch.publisher") do |notification|
+            enqueue_batch(batch, items, notification)
+          end
+        end
       end
       purge_expired_published_jobs
     rescue StandardError => ex
@@ -33,16 +38,16 @@ module SidekiqPublisher
 
     private
 
-    attr_reader :client, :job_class_cache
+    attr_reader :client, :job_class_cache, :instrumenter
 
-    def publish_batch(batch, items)
+    def enqueue_batch(batch, items, notification)
       pushed_count = client.bulk_push(items)
       published_count = update_jobs_as_published!(batch)
     rescue StandardError => ex
       failure_warning(__method__, ex)
     ensure
       published_count = update_jobs_as_published!(batch) if pushed_count.present? && published_count.nil?
-      metrics_reporter.try(:count, "sidekiq_publisher.published", published_count) if published_count.present?
+      notification[:published_count] = published_count if published_count.present?
     end
 
     def lookup_job_class(name)
@@ -56,7 +61,7 @@ module SidekiqPublisher
     end
 
     def purge_expired_published_jobs
-      Job.purge_expired_published! if perform_purge?
+      Job.purge_expired_published!(instrumenter: instrumenter) if perform_purge?
     end
 
     def perform_purge?
@@ -64,17 +69,13 @@ module SidekiqPublisher
     end
 
     def failure_warning(method, ex)
-      logger.warn("#{self.class.name}: msg=\"#{method} failed\" error=#{ex.class} error_msg=#{ex.message.inspect}\n"\
-                  "#{ex.backtrace.join("\n")}")
-      SidekiqPublisher.exception_reporter&.call(ex)
+      logger.warn("#{self.class.name}: msg=\"#{method} failed\" error=#{ex.class} error_msg=#{ex.message.inspect}\n")
+      instrumenter.instrument("error.publisher",
+                              exception_object: ex, exception: [ex.class.name, ex.message])
     end
 
     def logger
       SidekiqPublisher.logger
     end
-
-    def metrics_reporter
-      SidekiqPublisher.metrics_reporter
-    end
   end
 end

data/lib/sidekiq_publisher/report_unpublished_count.rb

@@ -2,10 +2,9 @@
 
 module SidekiqPublisher
   module ReportUnpublishedCount
-    def self.call
-      SidekiqPublisher.metrics_reporter.
-        gauge("sidekiq_publisher.unpublished_count",
-              SidekiqPublisher::Job.unpublished.count)
+    def self.call(instrumenter: Instrumenter.new)
+      instrumenter.instrument("unpublished.reporter",
+                              unpublished_count: SidekiqPublisher::Job.unpublished.count)
     end
   end
 end

data/lib/sidekiq_publisher/runner.rb

@@ -7,12 +7,13 @@ module SidekiqPublisher
     LISTENER_TIMEOUT_SECONDS = 60
     CHANNEL_NAME = "sidekiq_publisher_job"
 
-    def self.run
-      new.run
+    def self.run(instrumenter = Instrumenter.new)
+      new(instrumenter).run
     end
 
-    def initialize
-      @publisher = Publisher.new
+    def initialize(instrumenter = Instrumenter.new)
+      @instrumenter = instrumenter
+      @publisher = Publisher.new(instrumenter: @instrumenter)
     end
 
     def run
@@ -20,24 +21,32 @@ module SidekiqPublisher
         CHANNEL_NAME,
         listen_timeout: LISTENER_TIMEOUT_SECONDS
       ) do |listener|
-        listener.on_start { publisher.publish }
-        listener.on_notify { publisher.publish }
+        listener.on_start { call_publish("start") }
+        listener.on_notify { call_publish("notify") }
         listener.on_timeout { listener_timeout }
       end
     end
 
     private
 
-    attr_reader :publisher
+    attr_reader :publisher, :instrumenter
 
-    def listener_timeout
-      if Job.unpublished.exists?
-        SidekiqPublisher.logger&.warn(
-          "#{self.class.name}: msg='publishing pending jobs at timeout'"
-        )
+    def call_publish(event)
+      instrumenter.instrument("#{event}.publisher") do
         publisher.publish
-      else
-        Job.purge_expired_published!
+      end
+    end
+
+    def listener_timeout
+      instrumenter.instrument("timeout.listener") do
+        if Job.unpublished.exists?
+          SidekiqPublisher.logger&.warn(
+            "#{self.class.name}: msg='publishing pending jobs at timeout'"
+          )
+          call_publish("timeout")
+        else
+          Job.purge_expired_published!(instrumenter: instrumenter)
+        end
       end
     end
   end

data/lib/sidekiq_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  VERSION = "1.6.4"
+  VERSION = "1.7.0.rc0"
 end

data/sidekiq_publisher.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "ddtrace", ">= 0.39.0"
   spec.add_development_dependency "ezcater_matchers"
   spec.add_development_dependency "ezcater_rubocop", "1.0.2"
   spec.add_development_dependency "factory_bot"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0.rc0
 platform: ruby
 authors:
 - ezCater, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.39.0
 - !ruby/object:Gem::Dependency
   name: ezcater_matchers
   requirement: !ruby/object:Gem::Requirement
@@ -268,11 +282,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/CODEOWNERS"
 - Appraisals
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
+- docker-compose.yml
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_5.2_sidekiq_5.0.gemfile
@@ -288,7 +305,11 @@ files:
 - lib/generators/sidekiq_publisher/templates/create_sidekiq_publisher_jobs.rb
 - lib/sidekiq_publisher.rb
 - lib/sidekiq_publisher/client.rb
+- lib/sidekiq_publisher/datadog_apm.rb
+- lib/sidekiq_publisher/exception_reporter.rb
+- lib/sidekiq_publisher/instrumenter.rb
 - lib/sidekiq_publisher/job.rb
+- lib/sidekiq_publisher/metrics_reporter.rb
 - lib/sidekiq_publisher/publisher.rb
 - lib/sidekiq_publisher/railtie.rb
 - lib/sidekiq_publisher/report_unpublished_count.rb
@@ -304,7 +325,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -315,12 +336,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Publisher for enqueuing jobs to Sidekiq
 test_files: []