cloud66 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 354105873b589769eefa61120e7a7762cb6477097554a0c2aa5f1131d09a78c0
+  data.tar.gz: 3fe5d67f8d5bbab66998ea17547403d2bbcb907120275d096e1ec4003468768c
+SHA512:
+  metadata.gz: b901bbe9aa20b23d021ebdddb5add70aaaaeed1dc3756e201e231db63d9b291b9a4d3e48bc31f326a3d6ec985d868e0e28d8554f4e4ac499c949f895bebe8c48
+  data.tar.gz: 989bf075cb02ae0e9b6b618f03bb460df72cbb7b423794277206a622eaa742e9ca6ff20eaa19a8af09ad5de9df2717e096c62e96c3c5f8c989b46333483c71d1

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 1.0.0
+Initial release.

data/README.md

@@ -0,0 +1,44 @@
+# Cloud66
+This gem provides various integrations with Cloud 66.
+
+## Usage
+### Queue Metrics Endpoint
+By default, this gem will expose a metrics endpoint in your application at `/cloud66/metrics/queue`, which is only accessible through internal requests to `127.0.0.1` or `::1`.
+
+This endpoint will detect which supported queue frameworks your application uses, and then expose some useful metrics:
+- How many jobs are waiting in a given queue
+- How many jobs are currently being processed in a given queue
+
+The supported queue frameworks are:
+- [Sidekiq](https://github.com/sidekiq/sidekiq)
+- [Resque](https://github.com/resque/resque)
+- [Delayed Job](https://github.com/collectiveidea/delayed_job) (via the [ActiveRecord backend](https://github.com/collectiveidea/delayed_job_active_record))
+
+### Configuration
+You can configure this gem by creating a file in your Rails initializers (e.g. `config/initializers/cloud66.rb`) and adding the following (values shown are the defaults):
+```ruby
+Cloud66.configure do |config|
+  config.engine_automount = true
+  config.engine_automount_endpoint = "/cloud66"
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "cloud66"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cloud66
+```
+
+## License
+The gem is available as open source under the terms of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,8 @@
+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"

data/app/controllers/cloud66/application_controller.rb

@@ -0,0 +1,4 @@
+module Cloud66
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/cloud66/metrics_controller.rb

@@ -0,0 +1,7 @@
+module Cloud66
+  class MetricsController < ApplicationController
+    def queue
+      render json: ::Cloud66::Metrics::Manager.metrics_array
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Cloud66::Engine.routes.draw do
+  get "metrics/queue", to: "metrics#queue"
+end

data/lib/cloud66/configuration.rb

@@ -0,0 +1,13 @@
+module Cloud66
+  class Configuration
+    # Determines whether the engine is auto-mounted.
+    attr_accessor :engine_automount
+    # Determines the endpoint to which the engine is auto-mounted to.
+    attr_accessor :engine_automount_endpoint
+
+    def initialize
+      self.engine_automount = true
+      self.engine_automount_endpoint = "/cloud66"
+    end
+  end
+end

data/lib/cloud66/engine.rb

@@ -0,0 +1,15 @@
+module Cloud66
+  class Engine < ::Rails::Engine
+    isolate_namespace Cloud66
+
+    initializer "cloud66.configuration" do |app|
+      if Cloud66.configuration.engine_automount
+        app.routes.append do
+          constraints(ip: /127\.0\.0\.1|::1/) do
+            mount Cloud66::Engine => Cloud66.configuration.engine_automount_endpoint
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloud66/metrics/delayed_job_active_record.rb

@@ -0,0 +1,43 @@
+require "cloud66/metrics/framework_base"
+
+module Cloud66
+  module Metrics
+    class DelayedJobActiveRecord < FrameworkBase
+      class << self
+        protected
+
+        def detected_concrete
+          return ::Gem.loaded_specs["delayed_job"] &&
+                 ::Gem.loaded_specs["delayed_job_active_record"] &&
+                 ::Object.const_defined?(:Delayed) &&
+                 ::Delayed.const_defined?(:Job) &&
+                 ::Delayed.const_defined?(:Worker) &&
+                 ::Delayed::Worker.respond_to?(:backend) &&
+                 ::Delayed::Worker.backend = :active_record
+        end
+
+        def name_concrete
+          return "delayed_job_active_record"
+        end
+
+        def queue_array_concrete
+          delayed_job_pending = ::Delayed::Job.where(failed_at: nil, locked_at: nil).group(:queue).count
+          delayed_job_working = ::Delayed::Job.where(failed_at: nil).where.not(locked_at: nil).group(:queue).count
+
+          result = []
+          delayed_job_queue_names = delayed_job_pending.keys | delayed_job_working.keys
+          delayed_job_queue_names.each do |queue_name|
+            result << {
+              "backend" => name,
+              "queue" => queue_name,
+              "waiting" => delayed_job_pending[queue_name] || 0,
+              "processing" => delayed_job_working[queue_name] || 0,
+            }
+          end
+
+          return result
+        end
+      end
+    end
+  end
+end

data/lib/cloud66/metrics/framework_base.rb

@@ -0,0 +1,35 @@
+module Cloud66
+  module Metrics
+    class FrameworkBase
+      def self.detected?
+        return @detected unless @detected.nil?
+        @detected = detected_concrete
+        return @detected
+      end
+
+      def self.name
+        return name_concrete
+      end
+
+      def self.queue_array
+        return queue_array_concrete
+      end
+
+      class << self
+        protected
+
+        def detected_concrete
+          raise ::Cloud66::NotImplemented
+        end
+
+        def name_concrete
+          raise ::Cloud66::NotImplemented
+        end
+
+        def queue_array_concrete
+          raise ::Cloud66::NotImplemented
+        end
+      end
+    end
+  end
+end

data/lib/cloud66/metrics/manager.rb

@@ -0,0 +1,26 @@
+require "cloud66/metrics/sidekiq"
+require "cloud66/metrics/resque"
+require "cloud66/metrics/delayed_job_active_record"
+
+module Cloud66
+  module Metrics
+    class Manager
+      QUEUE_FRAMEWORKS = [
+        ::Cloud66::Metrics::Sidekiq,
+        ::Cloud66::Metrics::Resque,
+        ::Cloud66::Metrics::DelayedJobActiveRecord,
+      ].freeze
+
+      def self.metrics_array
+        result = []
+        QUEUE_FRAMEWORKS.each do |framework|
+          next unless framework.detected?
+
+          result += framework.queue_array
+        end
+
+        return result
+      end
+    end
+  end
+end

data/lib/cloud66/metrics/resque.rb

@@ -0,0 +1,43 @@
+require "cloud66/metrics/framework_base"
+
+module Cloud66
+  module Metrics
+    class Resque < FrameworkBase
+      class << self
+        protected
+
+        def detected_concrete
+          return ::Gem.loaded_specs.key?("resque") &&
+                 ::Object.const_defined?(:Resque) &&
+                 ::Resque.respond_to?(:queues) &&
+                 ::Resque.respond_to?(:working) &&
+                 ::Resque.respond_to?(:size)
+        end
+
+        def name_concrete
+          return "resque"
+        end
+
+        def queue_array_concrete
+          resque_pending = ::Resque.queues.map { |queue_name| [queue_name, ::Resque.size(queue_name)] }.to_h
+
+          resque_working_array = ::Resque.working.map { |worker| worker.job["queue"] }.compact
+          resque_working = ::Hash.new(0).tap { |h| resque_working_array.each { |queue| h[queue] += 1 } }
+
+          result = []
+          resque_queue_names = resque_pending.keys | resque_working.keys
+          resque_queue_names.each do |queue_name|
+            result << {
+              "backend" => name,
+              "queue" => queue_name,
+              "waiting" => resque_pending[queue_name] || 0,
+              "processing" => resque_working[queue_name] || 0,
+            }
+          end
+
+          return result
+        end
+      end
+    end
+  end
+end

data/lib/cloud66/metrics/sidekiq.rb

@@ -0,0 +1,41 @@
+require "cloud66/metrics/framework_base"
+
+module Cloud66
+  module Metrics
+    class Sidekiq < FrameworkBase
+      class << self
+        protected
+
+        def detected_concrete
+          return ::Gem.loaded_specs.key?("sidekiq") &&
+                 ::Object.const_defined?(:Sidekiq) &&
+                 ::Sidekiq.const_defined?(:Queue) &&
+                 ::Sidekiq.const_defined?(:WorkSet)
+        end
+        def name_concrete
+          return "sidekiq"
+        end
+
+        def queue_array_concrete
+          sidekiq_pending = ::Sidekiq::Queue.all.map { |q| [q.name, q.size] }.to_h
+
+          sidekiq_working_array = ::Sidekiq::WorkSet.new.map { |_, _, work| work["queue"] }
+          sidekiq_working = ::Hash.new(0).tap { |h| sidekiq_working_array.each { |queue| h[queue] += 1 } }
+
+          result = []
+          sidekiq_queue_names = sidekiq_pending.keys | sidekiq_working.keys
+          sidekiq_queue_names.each do |queue_name|
+            result << {
+              "backend" => name,
+              "queue" => queue_name,
+              "waiting" => sidekiq_pending[queue_name] || 0,
+              "processing" => sidekiq_working[queue_name] || 0,
+            }
+          end
+
+          return result
+        end
+      end
+    end
+  end
+end

data/lib/cloud66/metrics.rb

@@ -0,0 +1,9 @@
+require "cloud66/metrics/sidekiq"
+require "cloud66/metrics/resque"
+require "cloud66/metrics/delayed_job_active_record"
+require "cloud66/metrics/manager"
+
+module Cloud66
+  module Metrics
+  end
+end

data/lib/cloud66/version.rb

@@ -0,0 +1,3 @@
+module Cloud66
+  VERSION = "1.0.0"
+end

data/lib/cloud66.rb

@@ -0,0 +1,17 @@
+require "cloud66/version"
+require "cloud66/engine"
+require "cloud66/configuration"
+require "cloud66/metrics"
+
+module Cloud66
+  class Error < StandardError; end
+  class NotImplemented < Error; end
+
+  def self.configuration
+    @configuration ||= Cloud66::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: cloud66
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cloud 66
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Cloud 66 Ruby plugin
+email:
+- eng@cloud66.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- app/controllers/cloud66/application_controller.rb
+- app/controllers/cloud66/metrics_controller.rb
+- config/routes.rb
+- lib/cloud66.rb
+- lib/cloud66/configuration.rb
+- lib/cloud66/engine.rb
+- lib/cloud66/metrics.rb
+- lib/cloud66/metrics/delayed_job_active_record.rb
+- lib/cloud66/metrics/framework_base.rb
+- lib/cloud66/metrics/manager.rb
+- lib/cloud66/metrics/resque.rb
+- lib/cloud66/metrics/sidekiq.rb
+- lib/cloud66/version.rb
+homepage: https://www.cloud66.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.cloud66.com
+  source_code_uri: https://github.com/cloud66-oss/cloud66-rails
+  changelog_uri: https://github.com/cloud66-oss/cloud66-rails/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Cloud 66 Ruby plugin
+test_files: []