hirefire-resource 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bf414cb7e6529a04049ad3e7a7575a1932ec91fc8be57d8a2ce1ccc0922ab49
-  data.tar.gz: 8c78e71660e89df170ca061a328bfaff3d19714d55bf3a8fac04a59fbd9f2569
+  metadata.gz: bf1b333fe0b454c20c681c25fcc71f0f848f241421ceedde11e30ba5f29a467f
+  data.tar.gz: 76cd10b7c38c130405db1988267cb861c9b0a4ca69a38b8e30404dbc92d576f1
 SHA512:
-  metadata.gz: 2f84e86124b9467d166a839b3c90fd979ac13ccb4f50005dfa0e61e77763191206714a569fe59ea991da41b287d3a165a4740ea49f603ecc65caebc2d924c654
-  data.tar.gz: ce69dbda35b2762f727caa5e0d9fb5c76b3890ffa33cec9c20e46cc021d5b54f5842f337fc7264b00453dcf7074c3befd0db1970f89964ffb3703944d1837bb5
+  metadata.gz: cab33d00cef820b5f895638e5b905c2ae30fcda10de6d890a168bfa4635643fdb6a2a074ebe1863476d8086c8615974dc0123e0b890e4dd147aea2c135107db7
+  data.tar.gz: df331cea509df6b7c1f58c8d65471479157dd4ce43179d5150b9cfe61144d2d9f1dd7da50cdd455ad28245dafbe748b671a1af72cdccf85846ce304ee25657d7

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+## v0.8.0/Master
+
+* Add GoodJob macro for `good_job` adapter. https://github.com/bensheldon/good_job
+
+## v0.7.5
+
+* Fix compatibility issue with Que 1.x (backwards-compatible with Que 0.x).
+
+## v0.7.4
+
+* Attempt to fix an issue where the STDOUT IO Stream has been closed for an unknown reason.
+  * This resulted in errors in an application with `log_queue_metrics` enabled after a random period of time.
+
+## v0.7.3
+
+* Added priority queue support for bunny message count.
+  * Allows for passing in the `x-max-priority` option when opening up a queue to check the messages remaining.
+  * Usage: `HireFire::Macro::Bunny.queue(queue, amqp_url: url, "x-max-priority": 10 )`
+
+## v0.7.2
+
+* Changed Que macro to query take into account scheduled jobs.
+
+## v0.7.1
+
+* Made entire library threadsafe.
+
+## v0.7.0
+
+* Made `HireFire::Resource.log_queue_metrics` optional. This is now disabled by default.
+  * Enable by setting `log_queue_metrics = true`.
+  * Required when using the `Manager::Web::Logplex::QueueTime` autoscaling strategy.

data/README.md

@@ -6,13 +6,14 @@ Load-based scaling, schedule-based scaling, dyno crash recovery, for [Heroku](ht
 
 It supports practically any worker library. We provide out-of-the-box support for:
 
+* Sidekiq
 * Delayed Job
 * Resque
+* GoodJob
 * Qu
+* Que
 * QueueClassic
-* Sidekiq
 * Bunny
-* Que
 
 *Note that you can write your own worker queue logic for almost any other worker library as well.
 HireFire can scale multiple individual worker libraries at the same time, as well as multiple individual queues for any worker library.*

data/hirefire-resource.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name = "hirefire-resource"
-  gem.version = "0.7.1"
+  gem.version = "0.8.0"
   gem.platform = Gem::Platform::RUBY
   gem.authors = "Michael van Rooijen"
   gem.email = "michael@hirefire.io"
@@ -10,6 +10,12 @@ Gem::Specification.new do |gem|
   gem.summary = "Autoscaling for your Heroku dynos"
   gem.description = "Load- and schedule-based scaling for web- and worker dynos"
   gem.licenses = ["Apache License"]
+  gem.metadata = {
+    "homepage_uri" => "https://www.hirefire.io",
+    "changelog_uri" => "https://github.com/hirefire/hirefire-resource/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/hirefire/hirefire-resource/",
+    "bug_tracker_uri" => "https://github.com/hirefire/hirefire-resource/issues",
+  }
 
   gem.files = %x[git ls-files].split("\n")
   gem.executables = ["hirefire", "hirefireapp"]

data/lib/hirefire-resource.rb

@@ -6,9 +6,8 @@ HIREFIRE_PATH = File.expand_path("../hirefire", __FILE__)
   require "#{HIREFIRE_PATH}/#{file}"
 end
 
-%w[delayed_job resque sidekiq qu qc bunny que].each do |file|
+%w[delayed_job resque sidekiq qu qc bunny que good_job].each do |file|
   require "#{HIREFIRE_PATH}/macro/#{file}"
 end
 
 require "#{HIREFIRE_PATH}/railtie" if defined?(Rails::Railtie)
-

data/lib/hirefire/macro/bunny.rb

@@ -70,11 +70,15 @@ module HireFire
 
       def count_messages(channel, queue_names, options)
         queue_names.inject(0) do |sum, queue_name|
-          queue = channel.queue(queue_name, :durable => options[:durable])
+          if options.key?(:'x-max-priority')
+            queue = channel.queue(queue_name, :durable   => options[:durable],
+                                              :arguments => {"x-max-priority" => options[:'x-max-priority']})
+          else
+            queue = channel.queue(queue_name, :durable => options[:durable])
+          end
           sum + queue.message_count
         end
       end
     end
   end
 end
-

data/lib/hirefire/macro/good_job.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module HireFire
+  module Macro
+    module GoodJob
+      extend self
+
+      # Queries the PostgreSQL database through GoodJob in order to
+      # count the amount of jobs in the specified queue.
+      #
+      # @example Queue Macro Usage
+      #   HireFire::Macro::GoodJob.queue # counts all queues.
+      #   HireFire::Macro::GoodJob.queue("email") # counts the `email` queue.
+      #
+      # @param [String] queue the queue name to count. (default: nil # gets all queues)
+      # @return [Integer] the number of jobs in the queue(s).
+      #
+      def queue(*queues)
+        scope = ::GoodJob::Job.only_scheduled
+        scope = scope.where(queue_name: queues) if queues.any?
+        scope.count
+      end
+    end
+  end
+end

data/lib/hirefire/macro/que.rb

@@ -4,14 +4,8 @@ module HireFire
   module Macro
     module Que
       QUERY =  %{
-SELECT count(*)                                                          AS total,
-       count(locks.job_id)                                               AS running,
-       coalesce(sum((error_count > 0 AND locks.job_id IS NULL)::int), 0) AS failing,
-       coalesce(sum((error_count = 0 AND locks.job_id IS NULL)::int), 0) AS scheduled
-FROM que_jobs LEFT JOIN (
-  SELECT (classid::bigint << 32) + objid::bigint AS job_id
-  FROM pg_locks WHERE locktype = 'advisory'
-) locks USING (job_id) }.freeze
+SELECT count(*) AS total
+FROM que_jobs WHERE run_at < now() }.freeze
 
       extend self
 
@@ -25,10 +19,17 @@ FROM que_jobs LEFT JOIN (
       # @param [String] queue the queue name to count. (default: nil # gets all queues)
       # @return [Integer] the number of jobs in the queue(s).
       #
-      def queue(queue = nil)
-        query = queue ? "#{QUERY} WHERE queue = '#{queue}'" : QUERY
+      def queue(*queues)
+        query = case
+        when queues.none? then QUERY
+        when queues.one? then "#{QUERY} AND queue = '#{queues.first}'"
+        else
+          queue_names = queues.map { |queue| "'#{queue}'" }.join(', ')
+          %Q{#{QUERY} AND queue IN (#{queue_names})}
+        end
+
         results = ::Que.execute(query).first
-        results["total"].to_i - results["failing"].to_i
+        (results[:total] || results["total"]).to_i
       end
     end
   end

data/lib/hirefire/middleware.rb

@@ -19,7 +19,7 @@ module HireFire
     #
     # When HireFire::Resource.log_queue_metrics is enabled, and the HTTP_X_REQUEST_START
     # header has been injected at the Heroku Router layer, queue time information will be
-    # logged to STDOUT. This data can be used by the HireFire Logdrain with the
+    # logged to $stdout. This data can be used by the HireFire Logdrain with the
     # Web.Logplex.QueueTime autoscaling strategy.
     #
     # Important: Don't set/update instance variables within this- or any underlying methods.
@@ -90,14 +90,10 @@ module HireFire
     # @return [String] in application/json format.
     #
     def build_info_response
-      entry_builder = lambda do |config|
+      entries = HireFire::Resource.dynos.map do |config|
         %({"name":"#{config[:name]}","quantity":#{config[:quantity].call || "null"}})
       end
 
-      entries = HireFire::Resource.dynos.inject([]) do |buffer, config|
-        buffer << entry_builder.call(config)
-      end
-
       status                   = 200
       headers                  = Hash.new
       headers["Content-Type"]  = "application/json"
@@ -107,7 +103,7 @@ module HireFire
       [status, headers, [body]]
     end
 
-    # Writes the Heroku Router queue time to STDOUT if a String was provided.
+    # Writes the Heroku Router queue time to $stdout if a String was provided.
     #
     # @param [String] the timestamp from HTTP_X_REQUEST_START.
     #
@@ -115,12 +111,12 @@ module HireFire
       HireFire::Resource.log_queue_metrics && value && log_queue(value)
     end
 
-    # Writes the Heroku Router queue time to STDOUT.
+    # Writes the Heroku Router queue time to $stdout.
     #
     # @param [String] the timestamp from HTTP_X_REQUEST_START.
     #
     def log_queue(value)
-      STDOUT.puts("[hirefire:router] queue=#{get_queue(value)}ms")
+      puts("[hirefire:router] queue=#{get_queue(value)}ms")
     end
 
     # Calculates the difference, in milliseconds, between the

data/lib/hirefire/resource.rb

@@ -4,7 +4,7 @@ module HireFire
   module Resource
     extend self
 
-    # This option, when enabled, will write queue metrics to STDOUT,
+    # This option, when enabled, will write queue metrics to $stdout,
     # and is only required when using the Web.Logplex.QueueTime strategy.
     #
     # @param [Boolean] Whether or not the queue metrics should be logged.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Michael van Rooijen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies: []
 description: Load- and schedule-based scaling for web- and worker dynos
 email: michael@hirefire.io
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
@@ -29,6 +30,7 @@ files:
 - lib/hirefire/cli.rb
 - lib/hirefire/macro/bunny.rb
 - lib/hirefire/macro/delayed_job.rb
+- lib/hirefire/macro/good_job.rb
 - lib/hirefire/macro/qc.rb
 - lib/hirefire/macro/qu.rb
 - lib/hirefire/macro/que.rb
@@ -40,8 +42,12 @@ files:
 homepage: https://www.hirefire.io
 licenses:
 - Apache License
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://www.hirefire.io
+  changelog_uri: https://github.com/hirefire/hirefire-resource/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/hirefire/hirefire-resource/
+  bug_tracker_uri: https://github.com/hirefire/hirefire-resource/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Autoscaling for your Heroku dynos
 test_files: []