queue_pulse 0.1.0

data/lib/queue_pulse.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "logger"
+
+require_relative "queue_pulse/version"
+require_relative "queue_pulse/memory_store"
+require_relative "queue_pulse/configuration"
+require_relative "queue_pulse/alert"
+require_relative "queue_pulse/state"
+require_relative "queue_pulse/source"
+require_relative "queue_pulse/source/solid_queue"
+require_relative "queue_pulse/checks/base"
+require_relative "queue_pulse/checks/failures"
+require_relative "queue_pulse/checks/queue_latency"
+require_relative "queue_pulse/checks/queue_depth"
+require_relative "queue_pulse/checks/stuck_jobs"
+require_relative "queue_pulse/checks/worker_liveness"
+require_relative "queue_pulse/notifiers/base"
+require_relative "queue_pulse/notifiers/test"
+require_relative "queue_pulse/notifiers/slack"
+require_relative "queue_pulse/notifiers/webhook"
+require_relative "queue_pulse/notifiers/email"
+require_relative "queue_pulse/monitor"
+require_relative "queue_pulse/poller"
+
+# QueuePulse — immediate alerting + metrics for Solid Queue.
+#
+# Reads Solid Queue's existing tables (read-only, no migration) and notifies you
+# the moment background jobs fail, stall, back up, or workers die.
+module QueuePulse
+  class Error < StandardError; end
+
+  class << self
+    # Configure QueuePulse, typically from config/initializers/queue_pulse.rb
+    #
+    #   QueuePulse.configure do |config|
+    #     config.add_notifier QueuePulse::Notifiers::Slack.new(webhook_url: ENV["SLACK_WEBHOOK_URL"])
+    #     config.queue_latency_threshold = 120
+    #   end
+    def configure
+      yield config if block_given?
+      config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def reset_config!
+      @config = Configuration.new
+    end
+
+    def logger
+      config.logger
+    end
+
+    # Run one full monitoring pass and deliver any alerts.
+    # Fully exception-isolated: never raises into the host app.
+    #
+    # @param source [QueuePulse::Source] optional override (used in tests)
+    # @return [Array<QueuePulse::Alert>] the alerts that were delivered
+    def check!(source: nil)
+      return [] unless config.enabled
+
+      Monitor.new(config: config, source: source).run
+    rescue StandardError => e
+      logger.error("[QueuePulse] check! failed: #{e.class}: #{e.message}")
+      []
+    end
+  end
+end
+
+require_relative "queue_pulse/check_job" if defined?(ActiveJob::Base)
+require_relative "queue_pulse/railtie" if defined?(Rails::Railtie)

data/lib/tasks/queue_pulse.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :queue_pulse do
+  desc "Run one QueuePulse monitoring pass and deliver any alerts"
+  task check: :environment do
+    alerts = QueuePulse.check!
+    puts "[QueuePulse] delivered #{alerts.size} alert(s)"
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: queue_pulse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michiya Suzuki
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solid_queue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: |
+  QueuePulse reads Solid Queue's existing tables (read-only, no migration) and
+  notifies you the moment background jobs fail, stall, back up, or workers die.
+  It fills the gap left by Mission Control Jobs, which has no alerting and no
+  historical metrics — without making you run Datadog.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/queue_pulse.rb
+- lib/queue_pulse/alert.rb
+- lib/queue_pulse/check_job.rb
+- lib/queue_pulse/checks/base.rb
+- lib/queue_pulse/checks/failures.rb
+- lib/queue_pulse/checks/queue_depth.rb
+- lib/queue_pulse/checks/queue_latency.rb
+- lib/queue_pulse/checks/stuck_jobs.rb
+- lib/queue_pulse/checks/worker_liveness.rb
+- lib/queue_pulse/configuration.rb
+- lib/queue_pulse/memory_store.rb
+- lib/queue_pulse/monitor.rb
+- lib/queue_pulse/notifiers/base.rb
+- lib/queue_pulse/notifiers/email.rb
+- lib/queue_pulse/notifiers/slack.rb
+- lib/queue_pulse/notifiers/test.rb
+- lib/queue_pulse/notifiers/webhook.rb
+- lib/queue_pulse/poller.rb
+- lib/queue_pulse/railtie.rb
+- lib/queue_pulse/source.rb
+- lib/queue_pulse/source/solid_queue.rb
+- lib/queue_pulse/state.rb
+- lib/queue_pulse/version.rb
+- lib/tasks/queue_pulse.rake
+homepage: https://github.com/michiya-59/queue_pulse
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/michiya-59/queue_pulse
+  source_code_uri: https://github.com/michiya-59/queue_pulse
+  bug_tracker_uri: https://github.com/michiya-59/queue_pulse/issues
+  changelog_uri: https://github.com/michiya-59/queue_pulse/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Immediate alerting + metrics for Solid Queue background jobs.
+test_files: []