yabeda-activejob 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75adb58471b09079b2c7137a9e6d245ca34a87f5943bddbcca8488aa8a7fed21
+  data.tar.gz: 4eaff38047f48d812c9ec216520d1d180e04ee0a1c28fed56a74af3dff1cb31d
+SHA512:
+  metadata.gz: 722e179fb2e42ea0724f83fa58e4f078419ea6b213570ba651abbde64f79516999fd8de3b10c8ff6adb79191bacaf5d4a7b17c1aef360ce400be5ecae8ba5703
+  data.tar.gz: 1b53949b9e40c84df03d36065be01efa4b321b9f9e261f9dd3b4b774a0cfd1cdd53ede740fb2a1b2b06537991f1cb9c1350cee8bf2723ecc9b2ff3ada67774bd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Josh Etsenake
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Yabeda::ActiveJob
+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). 
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-activejob'
+# Then add monitoring system adapter, e.g.:
+# gem 'yabeda-prometheus'
+```
+
+### Registering metrics on server process start
+
+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!
+```
+
+## Metrics
+
+- Total jobs processed: `activejob.job_executed_total`
+- Total successful jobs processed: `activejob.job_success_total`
+- Total failed jobs processed: `activejob.job_failed_total`
+- Job runtime: `activejob.job_runtime` (in seconds)
+- Job latency: `activejob.job_latency` (in seconds)
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/tasks/yabeda/activejob_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :yabeda_activejob do
+#   # Task goes here
+# end

data/lib/yabeda/activejob/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module ActiveJob
+    VERSION = "0.1.0"
+  end
+end

data/lib/yabeda/activejob.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "yabeda/activejob/version"
+
+module Yabeda
+  # Small set of metrics on activejob jobs
+  module ActiveJob
+    LONG_RUNNING_JOB_RUNTIME_BUCKETS = [
+      0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard (from Prometheus)
+      30, 60, 120, 300, 1800, 3600, 21_600, # In cases jobs are very long-running
+    ].freeze
+
+    # rubocop: disable Metrics/MethodLength, Metrics/BlockLength, Metrics/AbcSize
+    def self.install!
+      Yabeda.configure do
+        group :activejob
+
+        counter :job_executed_total, tags: %i[queue activejob executions],
+                                     comment: "A counter of the total number of activejobs executed."
+        counter :job_success_total, tags: %i[queue activejob executions],
+                                    comment: "A counter of the total number of activejobs successfully processed."
+        counter :job_failed_total, tags: %i[queue activejob executions failure_reason],
+                                   comment: "A counter of the total number of jobs failed for an activejob."
+
+        histogram :job_runtime, comment: "A histogram of the activejob execution time.",
+                                unit: :seconds, per: :activejob,
+                                tags: %i[queue activejob executions],
+                                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+
+        histogram :job_latency, comment: "The job latency, the difference in seconds between enqueued and running time",
+                                unit: :seconds, per: :activejob,
+                                tags: %i[queue activejob executions],
+                                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+
+        # 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,
+          }
+          if event.payload[:exception].present?
+            activejob_job_failed_total.increment(
+              labels.merge(failure_reason: event.payload[:exception].join(",")),
+            )
+          else
+            activejob_job_success_total.increment(labels)
+          end
+
+          activejob_job_executed_total.increment(labels)
+          activejob_job_runtime.measure(labels, Yabeda::ActiveJob.ms2s(event.duration))
+        end
+
+        # start job event
+        ActiveSupport::Notifications.subscribe "perform_start.active_job" do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          ::Rails.logger.debug("JOB START")
+          puts "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,
+          }
+          ::Rails.logger.info(labels.inspect)
+
+          labels.merge!(event.payload.slice(*Yabeda.default_tags.keys - labels.keys))
+          activejob_job_latency.measure(labels, Yabeda::ActiveJob.job_latency(event))
+        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 = Time.parse(enqueue_time).utc
+      perform_at_time = Time.parse(event.end.to_s).utc
+      (perform_at_time - enqueue_time)
+    end
+
+    def self.ms2s(milliseconds)
+      (milliseconds.to_f / 1000).round(3)
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-activejob
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fullscript
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Prometheus exporter for collecting metrics around your activejobs
+email:
+- josh.etsenake@fullscript.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/yabeda/activejob_tasks.rake
+- lib/yabeda/activejob.rb
+- lib/yabeda/activejob/version.rb
+homepage: https://github.com/Fullscript/yabeda-activejob
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Fullscript/yabeda-activejob
+  source_code_uri: https://github.com/Fullscript/yabeda-activejob
+  changelog_uri: https://github.com/Fullscript/yabeda-activejob/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Yabeda Prometheus exporter for monitoring your activejobs
+test_files: []