yabeda-faktory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55956bd3203ea456ae3a1ebb26eff3d9c41eb8d3f6fed2e00d73b4488da92ff5
+  data.tar.gz: 84285a3ada7acb8beb7cffdd4c3e31305430f67b5748c33357ded16684e704b4
+SHA512:
+  metadata.gz: 951c17ba207068f89c0ac48896b297f4ff7a7032841b67009798601c2f92a920f21724ee371d6da206fec255642b8e9a9fa6a42877b7bf1a5be885c54904e8a0
+  data.tar.gz: b1fd9f6d27f8dc06016de59331afbdbb57e3f84c785f87ba2064ed8af5f97ceadf364f510575299200c254756889350e5cd423621ba04ce32eef2ddab83f7a3a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## 0.1.0 - 2020-04-17
+
+ - Initial release of yabeda-faktory gem. [@Envek]
+
+[@Envek]: https://github.com/Envek "Andrey Novikov"

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yabeda-faktory.gemspec
+gemspec
+
+gem "faktory_worker_ruby", github: "contribsys/faktory_worker_ruby" # See https://github.com/contribsys/faktory_worker_ruby/pull/48
+
+group :development, :test do
+  gem "pry"
+  gem "pry-inline"
+  gem "pry-byebug", platform: :mri
+end

data/Gemfile.lock

@@ -0,0 +1,86 @@
+GIT
+  remote: https://github.com/contribsys/faktory_worker_ruby.git
+  revision: 154aafb79946d7d33614234dd6aaa56d10e535cd
+  specs:
+    faktory_worker_ruby (1.0.0)
+      connection_pool (~> 2.2, >= 2.2.2)
+
+PATH
+  remote: .
+  specs:
+    yabeda-faktory (0.1.0)
+      faktory_worker_ruby (~> 1.0)
+      yabeda (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      globalid (>= 0.3.6)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    byebug (11.1.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    dry-initializer (3.0.3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    pry-inline (1.0.5)
+      pry (> 0.10.0, <= 0.12.2)
+      unicode (~> 0.4.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode (0.4.4.4)
+    yabeda (0.5.0)
+      concurrent-ruby
+      dry-initializer
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activejob (>= 6.0)
+  bundler (~> 2.0)
+  faktory_worker_ruby!
+  pry
+  pry-byebug
+  pry-inline
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  yabeda-faktory!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrey Novikov
+
+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,57 @@
+# Yabeda::[Faktory]
+
+Built-in metrics for monitoring [Faktory worker for Ruby] out of the box! Part of the [yabeda] suite.
+
+## Installation
+
+```ruby
+gem 'yabeda-faktory'
+
+# Then add monitoring system adapter, e.g.:
+# gem 'yabeda-prometheus'
+
+# If you're using Railsm don't forget to add plugin for it:
+# gem 'yabeda-rails'
+# But if not then you should run `Yabeda.configure!` manually when your app is ready.
+```
+
+And then execute:
+
+    $ bundle
+
+**And that is it!** Faktory metrics are being collected!
+
+Additionally, depending on your adapter, you may want to setup metrics export. E.g. for [yabeda-prometheus]:
+
+```ruby
+# config/initializers/faktory or elsewhere
+Faktory.configure_worker do |_config|
+  Yabeda::Prometheus::Exporter.start_metrics_server!
+end
+```
+
+## Metrics
+
+ - Total number of executed jobs: `faktory_jobs_executed_total` -  (segmented by `queue`, `worker` job class name, and whether their execution was `success`ful)
+ - Time of job run: `faktory_job_execution_runtime` (seconds per job execution, segmented by `queue`, `worker` job class name, and whether their execution was `success`ful)
+ - Total number of enqueued jobs: `faktory_jobs_enqueued_total` -  (segmented by `queue`, `worker` job class name, and whether enqueue was `success`ful)
+ - Time of job run: `faktory_job_enqueue_runtime` (seconds per job enqueue, segmented by `queue`, `worker` job class name, and whether enqueue was `success`ful
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-faktory.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Faktory]: https://contribsys.com/faktory/ "Language-agnostic persistent background job server "
+[Faktory worker for Ruby]: https://github.com/contribsys/faktory_worker_ruby "Faktory worker for Ruby"
+[yabeda]: https://github.com/yabeda-rb/yabeda
+[yabeda-prometheus]: https://github.com/yabeda-rb/yabeda-prometheus

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yabeda/faktory"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yabeda/faktory.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "faktory"
+require "yabeda"
+
+require "yabeda/faktory/version"
+require "yabeda/faktory/client_middleware"
+require "yabeda/faktory/worker_middleware"
+
+module Yabeda
+  module Faktory
+    class Error < StandardError; end
+
+    JOB_ENQUEUE_TIME_BUCKETS = [
+      0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10 # standard (from Prometheus)
+    ].freeze
+
+    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 # Faktory jobs may be very long-running
+    ].freeze
+
+    Yabeda.configure do
+      group :faktory
+
+      counter :jobs_enqueued_total, tags: %i[queue worker success], comment: "A counter of the total number of jobs faktory has enqueued."
+
+      histogram :job_enqueue_runtime, comment: "A histogram of the job enqueue time.",
+                unit: :seconds, per: :job,
+                tags: %i[queue worker success],
+                buckets: JOB_ENQUEUE_TIME_BUCKETS
+
+
+      next unless ::Faktory.worker?
+
+      counter   :jobs_executed_total,  tags: %i[queue worker success], comment: "A counter of the number of jobs faktory worker has executed."
+
+      histogram :job_execution_runtime, comment: "A histogram of the job execution time.",
+                unit: :seconds, per: :job,
+                tags: %i[queue worker success],
+                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+    end
+
+    ::Faktory.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add ClientMiddleware
+      end
+    end
+
+    ::Faktory.configure_worker do |config|
+      config.client_middleware do |chain|
+        chain.add ClientMiddleware
+      end
+      config.worker_middleware do |chain|
+        chain.add WorkerMiddleware
+      end
+    end
+
+    class << self
+      def labelize(payload)
+        { queue: payload["queue"], worker: worker_class(payload) }
+      end
+
+      def worker_class(payload)
+        worker = payload["jobtype"]
+
+        if defined?(ActiveJob::QueueAdapters::FaktoryAdapter::JobWrapper)
+          if worker.is_a?(ActiveJob::QueueAdapters::FaktoryAdapter::JobWrapper) || worker == "ActiveJob::QueueAdapters::FaktoryAdapter::JobWrapper"
+            return payload.dig("custom", "wrapped").to_s
+          end
+        end
+
+        worker.to_s
+      end
+    end
+  end
+end

data/lib/yabeda/faktory/client_middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Faktory
+    # Client middleware to count number of enqueued jobs
+    class ClientMiddleware
+      def call(payload, _connection_pool)
+        success = true
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+      rescue Exception # rubocop: disable Lint/RescueException
+        success = false
+        raise
+      ensure
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+        labels = { success: success }.merge(Yabeda::Faktory.labelize(payload))
+        Yabeda.faktory.jobs_enqueued_total.increment(labels)
+        Yabeda.faktory.job_enqueue_runtime.measure(labels, elapsed.round(3))
+      end
+    end
+  end
+end

data/lib/yabeda/faktory/version.rb

@@ -0,0 +1,5 @@
+module Yabeda
+  module Faktory
+    VERSION = "0.1.0"
+  end
+end

data/lib/yabeda/faktory/worker_middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Faktory
+    # Faktory worker middleware
+    class WorkerMiddleware
+      def call(_job_instance, payload)
+        success = true
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+      rescue Exception # rubocop: disable Lint/RescueException
+        success = false
+        raise
+      ensure
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+        labels = { success: success }.merge(Yabeda::Faktory.labelize(payload))
+        Yabeda.faktory.job_execution_runtime.measure(labels, elapsed.round(3))
+        Yabeda.faktory.jobs_executed_total.increment(labels)
+      end
+    end
+  end
+end

data/yabeda-faktory.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yabeda/faktory/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "yabeda-faktory"
+  spec.version = Yabeda::Faktory::VERSION
+  spec.authors = ["Andrey Novikov"]
+  spec.email   = ["envek@envek.name"]
+
+  spec.summary = "Export performance metrics for Faktory worker for Ruby"
+  spec.description = <<~DESC
+    Yabeda plugin for easy collecting of most important Faktory Ruby worker metrics: number of executed jobs, job runtime, etc…
+  DESC
+  spec.homepage = "https://github.com/yabeda-rb/yabeda-faktory"
+  spec.license  = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yabeda-rb/yabeda-faktory"
+  spec.metadata["changelog_uri"] = "https://github.com/yabeda-rb/yabeda-faktory/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "yabeda", "~> 0.2"
+  spec.add_dependency "faktory_worker_ruby", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activejob", ">= 6.0"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-faktory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faktory_worker_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: activejob
+  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: 'Yabeda plugin for easy collecting of most important Faktory Ruby worker
+  metrics: number of executed jobs, job runtime, etc…
+
+'
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/faktory.rb
+- lib/yabeda/faktory/client_middleware.rb
+- lib/yabeda/faktory/version.rb
+- lib/yabeda/faktory/worker_middleware.rb
+- yabeda-faktory.gemspec
+homepage: https://github.com/yabeda-rb/yabeda-faktory
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yabeda-rb/yabeda-faktory
+  source_code_uri: https://github.com/yabeda-rb/yabeda-faktory
+  changelog_uri: https://github.com/yabeda-rb/yabeda-faktory/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Export performance metrics for Faktory worker for Ruby
+test_files: []