solid_queue_autoscaler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ba25b2ae8e389c0cc4da50d7587f93df6b6eeb404ffe4d810ff8e4b574354dd
+  data.tar.gz: 73da42d85f85f71efcaa913467dffaf1aac049d2a0c12fd3a52965600f682be6
+SHA512:
+  metadata.gz: df644086ce41dd9ac5f7788551db7eec3fff37bfae9b81ead46d41d8850a49beaa72b0a8299a3c32171f2c8a321b0ff64ec969b4a00ad19cd9d8422b87358fc8
+  data.tar.gz: 22d75c0d678297d5ca8ac2e8c1265c2adc95b4f398a9daa4bd7a349d3ebbb3142e1753f6ec8732e88790bd97c95d6da5448549e2468e3814bfc711f502731363

data/CHANGELOG.md

@@ -0,0 +1,189 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-01-16
+
+### Changed
+
+- **Renamed gem** from `solid_queue_heroku_autoscaler` to `solid_queue_autoscaler` to better reflect multi-platform support (Heroku, Kubernetes, custom adapters)
+- **Renamed module** from `SolidQueueHerokuAutoscaler` to `SolidQueueAutoscaler`
+- Version reset to 1.0.0 for the new gem name
+
+### Migration from solid_queue_heroku_autoscaler
+
+1. Update your Gemfile:
+   ```ruby
+   # Old
+   gem "solid_queue_heroku_autoscaler"
+   # New
+   gem "solid_queue_autoscaler"
+   ```
+
+2. Update your initializer:
+   ```ruby
+   # Old
+   SolidQueueHerokuAutoscaler.configure do |config|
+   # New
+   SolidQueueAutoscaler.configure do |config|
+   ```
+
+3. Update any rake task references:
+   ```bash
+   # Old
+   rake solid_queue_heroku_autoscaler:scale
+   # New  
+   rake solid_queue_autoscaler:scale
+   ```
+
+## [0.2.1] - 2025-01-16
+
+### Fixed
+
+- **Adapter symbol support**: Fixed `config.adapter = :heroku` and `config.adapter = :kubernetes` not working correctly. The adapter setter now properly converts symbols to adapter instances.
+- Also supports `config.adapter = :k8s` as an alias for `:kubernetes`
+
+## [0.2.0] - 2025-01-20
+
+### Added
+
+- **Dashboard UI**: Web-based dashboard for monitoring autoscaler events and status
+  - Overview page with real-time metrics, worker status, and recent events
+  - Workers page with detailed status, configuration, and cooldown info
+  - Events log with filtering by worker type
+  - Manual scale trigger from the UI
+- **ScaleEvent model**: Tracks all scaling decisions in the database
+- **Event recording configuration**: `record_events` and `record_all_events` options
+- **New rake tasks**: `events`, `cleanup_events` for managing scale event history
+- **Dashboard generator**: `rails generate solid_queue_autoscaler:dashboard`
+- **Ruby 3.4 support**: Added CI testing for Ruby 3.4
+
+## [0.1.0] - 2025-01-19
+
+### Added
+
+#### Core Features
+- **Metrics-based autoscaling** for Solid Queue workers on Heroku and Kubernetes
+- **Queue depth monitoring** - Scale based on number of pending jobs
+- **Latency monitoring** - Scale based on oldest job age
+- **Throughput tracking** - Monitor jobs processed per minute
+
+#### Scaling Strategies
+- **Fixed scaling** - Add/remove a fixed number of workers per scaling event
+- **Proportional scaling** - Scale workers proportionally based on load level
+
+#### Multi-Worker Support
+- **Named configurations** - Configure multiple worker types independently
+- **Per-worker cooldowns** - Each worker type has its own cooldown tracking
+- **Unique advisory locks** - Parallel scaling of different worker types
+- **Queue filtering** - Assign specific queues to each worker configuration
+
+#### Infrastructure Adapters
+- **Heroku adapter** - Scale dynos via Heroku Platform API
+- **Kubernetes adapter** - Scale deployments via Kubernetes API
+- **Pluggable architecture** - Easy to add custom adapters
+
+#### Safety Features
+- **PostgreSQL advisory locks** - Singleton execution across multiple dynos
+- **Configurable cooldowns** - Prevent rapid scaling oscillations
+- **Separate scale-up/down cooldowns** - Fine-tune scaling behavior
+- **Min/max worker limits** - Prevent over/under-provisioning
+- **Dry-run mode** - Test scaling decisions without making changes
+
+#### Persistence
+- **Database-backed cooldown tracking** - Survives dyno restarts
+- **Migration generator** - Easy setup of state table
+- **Fallback to in-memory** - Works without migration
+
+#### Rails Integration
+- **Railtie with rake tasks** - `scale`, `scale_all`, `metrics`, `formation`, `cooldown`, `reset_cooldown`, `workers`
+- **Configuration initializer generator** - Quick setup
+- **ActiveJob integration** - `AutoscaleJob` for recurring execution
+- **Solid Queue recurring job support** - Run autoscaler on schedule
+
+#### Developer Experience
+- **Comprehensive test suite** - 356 RSpec examples
+- **RuboCop configuration** - Clean, consistent code style
+- **GitHub Actions CI** - Automated testing on Ruby 3.1, 3.2, 3.3
+- **Detailed logging** - Track all scaling decisions and actions
+
+### Configuration Options
+
+```ruby
+SolidQueueAutoscaler.configure(:worker_name) do |config|
+  # Heroku settings
+  config.heroku_api_key = ENV['HEROKU_API_KEY']
+  config.heroku_app_name = ENV['HEROKU_APP_NAME']
+  config.process_type = 'worker'
+
+  # Kubernetes settings (alternative to Heroku)
+  # config.adapter_class = SolidQueueAutoscaler::Adapters::Kubernetes
+  # config.kubernetes_deployment = 'my-worker'
+  # config.kubernetes_namespace = 'production'
+
+  # Worker limits
+  config.min_workers = 1
+  config.max_workers = 10
+
+  # Scaling strategy (:fixed or :proportional)
+  config.scaling_strategy = :fixed
+
+  # Scale-up thresholds
+  config.scale_up_queue_depth = 100
+  config.scale_up_latency_seconds = 300
+  config.scale_up_increment = 1
+
+  # Proportional scaling settings
+  config.scale_up_jobs_per_worker = 50
+  config.scale_up_latency_per_worker = 60
+
+  # Scale-down thresholds
+  config.scale_down_queue_depth = 10
+  config.scale_down_latency_seconds = 30
+  config.scale_down_decrement = 1
+
+  # Cooldowns
+  config.cooldown_seconds = 120
+  config.scale_up_cooldown_seconds = 60
+  config.scale_down_cooldown_seconds = 180
+
+  # Queue filtering
+  config.queues = ['default', 'mailers']
+
+  # Behavior
+  config.dry_run = false
+  config.enabled = true
+
+  # Custom table prefix for Solid Queue tables
+  config.table_prefix = 'solid_queue_'
+end
+```
+
+### Usage Examples
+
+```ruby
+# Scale default worker
+SolidQueueAutoscaler.scale!
+
+# Scale specific worker type
+SolidQueueAutoscaler.scale!(:critical_worker)
+
+# Scale all configured workers
+SolidQueueAutoscaler.scale_all!
+
+# Get metrics for a worker
+metrics = SolidQueueAutoscaler.metrics(:default)
+
+# List registered workers
+SolidQueueAutoscaler.registered_workers
+```
+
+[1.0.0]: https://github.com/reillyse/solid_queue_autoscaler/releases/tag/v1.0.0
+[0.2.1]: https://github.com/reillyse/solid_queue_heroku_autoscaler/releases/tag/v0.2.1
+[0.2.0]: https://github.com/reillyse/solid_queue_heroku_autoscaler/releases/tag/v0.2.0
+[0.1.0]: https://github.com/reillyse/solid_queue_heroku_autoscaler/releases/tag/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 reillyse
+
+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.