yabeda-activejob 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08158815f9482115a22e494dd4f3b65fd296adb566f1b641f3fa39b15d232bcd'
-  data.tar.gz: 5d57d4ee2d12c75453f852422d044728cff9d7631928f04a76886d321b425bd0
+  metadata.gz: 3da58bbe370af6fa52cd9021520491f692d4310ea5dcd93d27b0f78eaf5c940b
+  data.tar.gz: b3a955f99cfe4482a9cd1da53720967ee508e3b62bbe430a16eaf46e583e00d1
 SHA512:
-  metadata.gz: ea6312266b05349917950bae645a413a257e3ed970ec4b9a5b82d0a177487a6dea3529a144849e489bd37c4aff4ea21a53058d4857226b3f154816c7e551f069
-  data.tar.gz: 7e60c91f4613c747e8572ddbebbad53c7c42613845e3dadb7d3df3b89486ebd332fa9f90bf993d2da4a72b87f917f4ffa4ca98397cdb03f3dac0eb65e4eb8ea2
+  metadata.gz: 9264ea6fc38f7c9aa81543e17dca965a4a68e141bddfaa578e51859a8177d70e1cee195f088f0f9964a70077411f1717478489581a1f2b3b4124d16a893d1b40
+  data.tar.gz: c7b404f2a8a05c024df6c81d6720dccfaa6a55ba64fcc9e73ada1035720a29fa2903d1e39ff6377f5a73e89b469781c8a5d6a54fed5d91b5b54be7c9a280b82f

data/README.md

@@ -5,12 +5,12 @@
 
 Yabeda metrics around rails activejobs. The motivation came from wanting something similar to [yabeda-sidekiq](https://github.com/yabeda-rb/yabeda-sidekiq) for
 resque but decided to generalize even more with just doing it on the activejob level since that is likely more in use
-than just resque. and could implement a lot of the general metrics needed without having to leverage your used adapters
-implementation and oh the redis calls. 
-The intent is to have this plugin with an exporter such as [prometheus](https://github.com/yabeda-rb/yabeda-prometheus). 
+than just resque. and could implement a lot of the general metrics needed without having to leverage the adapter
+implementation and, oh the redis calls. 
 
-## Usage
-How to use my plugin.
+Sample [Grafana dashboard](https://grafana.com/grafana/dashboards/17303) ID: [17303](https://grafana.com/grafana/dashboards/17303)
+
+The intent is to have this plugin with an exporter such as [prometheus](https://github.com/yabeda-rb/yabeda-prometheus).
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,22 +21,99 @@ gem 'yabeda-activejob'
 # gem 'yabeda-prometheus'
 ```
 
+And then execute:
+
+    $ bundle
 ### Registering metrics on server process start
+Depending on your activejob adapter the installation process may be different for you. If using sidekiq:
+```ruby
+# config/initializers/sidekiq or elsewhere
+Sidekiq.configure_server do |_config|
+    Yabeda::ActiveJob.install!
+end
+```
+
+If using with resque:
+```ruby
+# config/initializers/yabeda.rb or elsewhere
+Yabeda::ActiveJob.install!
+```
+If using resque you may need to use [yabeda-prometheus-mmap](https://github.com/yabeda-rb/yabeda-prometheus-mmap) or set your storage type to direct file store so that the metrics are available
+to your collector. 
+
+To set your storage type to direct file store you can do the following in your yabeda initializer: 
 
-Currently, yabeda-activejob does not automatically install on your rails server (this will be added in the future). For now to install
-you can do the following: 
 ```ruby
-# config/initializers/yabeda.rb
-  Yabeda::ActiveJob.install!
+# config/initializers/yabeda.rb or elsewhere
+Prometheus::Client.config.data_store = Prometheus::Client::DataStores::DirectFileStore.new(dir: "/tmp")
 ```
 
+**Note** if using direct file datastore it must be called before registering any metrics. 
+
+If using `resque` with prometheus and scraping your resque process via the `/metrics` endpoint is unfeasible consider setting up a
+push gateway. Once set up, you can use the `after_event_block` to push metrics to your push gateway after every event is
+complete.
+
+````ruby
+Yabeda.configure do
+   Yabeda::ActiveJob.after_event_block = Proc.new do |event|
+      # do your pushing or any custom code here
+   end
+   Yabeda::ActiveJob.install!
+end
+````
+
+**Note**: Since the notifications are registered on install make sure to setup your after_event_block before calling install!
+
 ## Metrics
 
-- Total jobs processed: `activejob.executed_total`
-- Total successful jobs processed: `activejob.success_total`
-- Total failed jobs processed: `activejob.failed_total`
+- Total enqueued jobs: `activejob.enqueued_total` segmented by: queue, activejob(job class name), executions(number of executions)
+- Total jobs processed: `activejob.executed_total` segmented by: queue, activejob(job class name), executions(number of executions)
+- Total successful jobs processed: `activejob.success_total` segmented by: queue, activejob(job class name), executions(number of executions)
+- Total failed jobs processed: `activejob.failed_total` segmented by: queue, activejob(job class name), executions(number of executions), failure_reason(error class)
 - Job runtime: `activejob.runtime` (in seconds)
 - Job latency: `activejob.latency` (in seconds)
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Fullscript/yabeda-activejob.
+
+### Releasing
+
+1. Bump version number in `lib/yabeda/activejob/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::ActiveJob::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/activejob/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/activejob/version.rb -e "puts Gem::Version.new(Yabeda::ActiveJob::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Yabeda-sidekiq]: https://github.com/yabeda-rb/yabeda-sidekiq "Inspiration for this gem"
+[yabeda]: https://github.com/yabeda-rb/yabeda
+[yabeda-prometheus]: https://github.com/yabeda-rb/yabeda-prometheus

data/lib/yabeda/activejob/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module ActiveJob
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/yabeda/activejob.rb

@@ -2,6 +2,7 @@
 
 require "yabeda"
 require "yabeda/activejob/version"
+require "active_support"
 
 module Yabeda
   # Small set of metrics on activejob jobs
@@ -11,6 +12,8 @@ module Yabeda
       30, 60, 120, 300, 1800, 3600, 21_600, # In cases jobs are very long-running
     ].freeze
 
+    mattr_accessor :after_event_block, default: proc { |_event| }
+
     # rubocop: disable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
     def self.install!
       Yabeda.configure do
@@ -40,8 +43,8 @@ module Yabeda
           event = ActiveSupport::Notifications::Event.new(*args)
           labels = {
             activejob: event.payload[:job].class.to_s,
-            queue: event.payload[:job].instance_variable_get(:@queue_name).to_s,
-            executions: event.payload[:job].instance_variable_get(:@executions).to_s,
+            queue: event.payload[:job].queue_name.to_s,
+            executions: event.payload[:job].executions.to_s,
           }
           if event.payload[:exception].present?
             activejob_failed_total.increment(
@@ -53,6 +56,7 @@ module Yabeda
 
           activejob_executed_total.increment(labels)
           activejob_runtime.measure(labels, Yabeda::ActiveJob.ms2s(event.duration))
+          Yabeda::ActiveJob.after_event_block.call(event) if Yabeda::ActiveJob.after_event_block.respond_to?(:call)
         end
 
         # start job event
@@ -61,12 +65,14 @@ module Yabeda
 
           labels = {
             activejob: event.payload[:job].class.to_s,
-            queue: event.payload[:job].instance_variable_get(:@queue_name),
-            executions: event.payload[:job].instance_variable_get(:@executions).to_s,
+            queue: event.payload[:job].queue_name,
+            executions: event.payload[:job].executions.to_s,
           }
 
           labels.merge!(event.payload.slice(*Yabeda.default_tags.keys - labels.keys))
-          activejob_latency.measure(labels, Yabeda::ActiveJob.job_latency(event))
+          job_latency = Yabeda::ActiveJob.job_latency(event)
+          activejob_latency.measure(labels, job_latency) if job_latency.present?
+          Yabeda::ActiveJob.after_event_block.call(event) if Yabeda::ActiveJob.after_event_block.respond_to?(:call)
         end
 
         ActiveSupport::Notifications.subscribe "enqueue.active_job" do |*args|
@@ -74,19 +80,22 @@ module Yabeda
 
           labels = {
             activejob: event.payload[:job].class.to_s,
-            queue: event.payload[:job].instance_variable_get(:@queue_name),
-            executions: event.payload[:job].instance_variable_get(:@executions).to_s,
+            queue: event.payload[:job].queue_name,
+            executions: event.payload[:job].executions.to_s,
           }
 
           labels.merge!(event.payload.slice(*Yabeda.default_tags.keys - labels.keys))
           activejob_enqueued_total.increment(labels)
+          Yabeda::ActiveJob.after_event_block.call(event) if Yabeda::ActiveJob.after_event_block.respond_to?(:call)
         end
       end
     end
     # rubocop: enable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
 
     def self.job_latency(event)
-      enqueue_time = event.payload[:job].instance_variable_get(:@enqueued_at)
+      enqueue_time = event.payload[:job].enqueued_at
+      return nil unless enqueue_time.present?
+
       enqueue_time = Time.parse(enqueue_time).utc
       perform_at_time = Time.parse(event.end.to_s).utc
       (perform_at_time - enqueue_time)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-activejob
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fullscript
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-29 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails