yabeda-activejob 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b5abdf29dc1f2bea57820def73dbfe9ecb2eabdcff95a863e13c463fa332794
-  data.tar.gz: d2341ad286ddd4a66f29eafadfacf0d30bb83c844b685f1bd09a7fe302eb33e9
+  metadata.gz: 3cd5ae2317f42f9d4e2a5b44bba2d44b792e07f9e55a7992af2e37dabbd6333f
+  data.tar.gz: 4da6bb136cb5a1ab33a7f3927b79f4a9a50a1188e32340d459ebdcfbf9ca2ca6
 SHA512:
-  metadata.gz: 485073cf7a4925fc68cfce465507ec6890ed2b15edf69ca919ac0044b6013b4e872380252d83dfbdb0c1f743d71f60a8ce81c84811676c03709316759023f8af
-  data.tar.gz: ab25a166ad4c2474e704554f1dbec5d8b8e90a325d99b751a118c6041f876ee60139d75e80c8a797b3022aa46963978d34e9caa5376d9ef42cf228c267a35ff4
+  metadata.gz: 2f73db31ff848abc54d5e43fb664cb28c5de70b7a5697a349d952bdf1a7e2e605eb8ebdb98edb31c90f0c8832c59162e29d278ae6846c73d0829be4a20ea3a54
+  data.tar.gz: 5c86775ae9e1811f2fd2e1e9558eeb9fb681635af322180e2d3828d3f7ab2be235b6ea579fb5f13c95324b32fe0e2a14fefa9d5240daffe018b4a3e910f5cea2

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,84 @@ 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
+```
 
-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: 
+If using with resque:
 ```ruby
-# config/initializers/yabeda.rb
-  Yabeda::ActiveJob.install!
+# 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: 
+
+```ruby
+# 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. 
 
 ## 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.2.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/yabeda/activejob.rb

@@ -18,6 +18,8 @@ module Yabeda
 
         counter :executed_total, tags: %i[queue activejob executions],
                                  comment: "A counter of the total number of activejobs executed."
+        counter :enqueued_total, tags: %i[queue activejob executions],
+                                 comment: "A counter of the total number of activejobs enqueued."
         counter :success_total, tags: %i[queue activejob executions],
                                 comment: "A counter of the total number of activejobs successfully processed."
         counter :failed_total, tags: %i[queue activejob executions failure_reason],
@@ -35,13 +37,11 @@ module Yabeda
 
         # job complete event
         ActiveSupport::Notifications.subscribe "perform.active_job" do |*args|
-          ::Rails.logger.debug("JOB COMPLETE")
-
           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(
@@ -58,24 +58,38 @@ module Yabeda
         # start job event
         ActiveSupport::Notifications.subscribe "perform_start.active_job" do |*args|
           event = ActiveSupport::Notifications::Event.new(*args)
-          ::Rails.logger.debug("JOB START")
 
           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,
           }
-          ::Rails.logger.info(labels.inspect)
 
           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?
+        end
+
+        ActiveSupport::Notifications.subscribe "enqueue.active_job" do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+
+          labels = {
+            activejob: event.payload[:job].class.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)
         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.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Fullscript
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-22 00:00:00.000000000 Z
+date: 2022-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails