sidekiq_publisher 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ac8cc8fb68efb773bb1baebec5fea4c5f508a87b1508a7ebb67c7d2e4655abe
-  data.tar.gz: f18b4c67f4a16a50cbcc6ebac2539740d1edc5fc4669cdb46ec2d9f8594ae1c7
+  metadata.gz: 2d0e204e94d55d70449491aec30c2ba89869bc25e104a2c465f97473f9f0ee04
+  data.tar.gz: 431f718cfdfe74826a1846f23aa95ff20117e3a93da533144577bbff31453df6
 SHA512:
-  metadata.gz: '081e638e7ea4800902cef72881070fde7ea543e0d4fb9f9af6a1880ffd188902c731a75e6e2588ccbaf8c9c1fc82386c3911d280dbb7ea680a6a4f855a4ab349'
-  data.tar.gz: 5c25ec191363f939db8c271b6754922b07fe9b9ec0c17d399ea895433f5e4fd9603709deacd4509f0b2591d5e50b2eec88f61d7fa9ca8a001b8b57dbc62154b6
+  metadata.gz: 87aaa1c1591cbc35def8dcfb5b06f7314ffd2defd7b1368fda514dada0399d9bedb19c8d5816a67e416e5ce4528cddcce10d689ca3fc26ff6cae564b5f934a95
+  data.tar.gz: 4f4215086a55070cc5ce188619b2f0e2fc236fb3e9c7a831b24f65b8c0512b0f3716e0e119372a106cae28e07dba896719658c8f52f50d446d62b1a568767b9f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # sidekiq_publisher
 
+## v1.2.0
+- Add `ReportUnpublishedCount` to record a metric for the number
+  of unpublished jobs.
+
 ## v1.1.0
 - Expand sidekiq support to v5.0.x-v5.2.x.
 

data/README.md

@@ -52,6 +52,7 @@ respond to the following API:
 
 ```ruby
 count(metric_name, count)
+gauge(metric_name, count)
 ```
 
 Metrics will be reported for:
@@ -59,6 +60,18 @@ Metrics will be reported for:
 - the number of jobs published in each batch
 - the number of jobs purged
 
+#### Unpublished Jobs
+
+There is also a module that can be used to record a metric for the number of
+unpublished jobs:
+
+```ruby
+SidekiqPublisher::ReportUnpublishedCount.call
+```
+
+It is recommended to call this method periodically using something like
+cron or [clockwork](https://github.com/Rykian/clockwork).
+
 ## Usage
 
 ### ActiveJob Adapter

data/lib/sidekiq_publisher/report_unpublished_count.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SidekiqPublisher
+  module ReportUnpublishedCount
+    def self.call
+      SidekiqPublisher.metrics_reporter.
+        gauge("sidekiq_publisher.unpublished_count",
+              SidekiqPublisher::Job.unpublished.count)
+    end
+  end
+end

data/lib/sidekiq_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/sidekiq_publisher.rb

@@ -2,6 +2,7 @@
 
 require "private_attr"
 require "sidekiq_publisher/version"
+require "sidekiq_publisher/report_unpublished_count"
 require "sidekiq_publisher/job"
 require "sidekiq_publisher/worker"
 require "sidekiq_publisher/publisher"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -300,6 +300,7 @@ files:
 - lib/sidekiq_publisher/job.rb
 - lib/sidekiq_publisher/publisher.rb
 - lib/sidekiq_publisher/railtie.rb
+- lib/sidekiq_publisher/report_unpublished_count.rb
 - lib/sidekiq_publisher/runner.rb
 - lib/sidekiq_publisher/tasks.rake
 - lib/sidekiq_publisher/version.rb