tj-scale 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e070c5d82758136d8df85df78f7f6b021f7494cfa8a2b64ff417aff9ad386333
-  data.tar.gz: d4cdd0e53528d48a634b8ee929c498cf63756ae7fd8be239ad6aaf277174052f
+  metadata.gz: bfa02cccd18ac22e845267ddac5835d60c620e793e65aa34b648d1cc7889eab3
+  data.tar.gz: 28a78e5c2643a400910aaca6d535f191f521c1633a8eaab48d28365aa40835e6
 SHA512:
-  metadata.gz: 45b1804fc8ee06924b28d7230645fcb34d2d26fa4c37a412183cbfac6ff9bf82da108876d8012f275c774fc027e312ca0095b9bb6d0b89af6303023d0ae302fa
-  data.tar.gz: 46758b912e0a3ede622ed4ceae6ddb0b78c74b6dfe2cc4022fdf484892320db56204eea15600285bd7cbb6a09286974030b5ba73f983250cf3c3194ebd24632c
+  metadata.gz: a269ea3a6087b6bdf54f40a6ac98960d7e70219049ec02dea5d7de592277fba106c5e77769277bd04b3623e356ad90a03926cb0bfcc7edef0867f37ef1bc11d3
+  data.tar.gz: e2ed378beb3196a9e9508132f04fea691a828ee6359650b8bb8e6daa96c8693199cbb091e06c8ee1d9aa31353596f7af305c23fbe7703ecbf8a35c9fceb78bb7

data/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.2] (tj-scale) - 2026-06-12
+
+### Changed
+
+- README fully updated for the `tj-scale` name: install/build/publish instructions,
+  repository URLs (`Untechnickle/tj-scale-gem`), and generic example app names.
+- Supersedes 1.0.0 and 1.0.1, which are yanked (same code, stale docs/description).
+
+## [1.0.1] (tj-scale) - 2026-06-12
+
+### Changed
+
+- Rewrote the RubyGems summary and description for the gem page (1.0.0 shipped the same code with the older description).
+
+## [1.0.0] (tj-scale) - 2026-06-12
+
+First release under the new gem name **`tj-scale`** (continues `tj-scale-ruby`, versions below).
+
 ### Changed
 
 - **Gem renamed to `tj-scale`** (was `tj-scale-ruby`); require path is now `require "tj-scale"`. Internal `TjScaleRuby` module and `lib/tj_scale_ruby/` paths are unchanged.

data/README.md

@@ -1,10 +1,10 @@
-# TjScaleRuby
+# tj-scale
 
 [![Ruby Version](https://img.shields.io/badge/ruby-%3E%3D%203.0.0-red.svg)](https://www.ruby-lang.org/)
 [![Rails Version](https://img.shields.io/badge/rails-%3E%3D%206.1-red.svg)](https://rubyonrails.org/)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.txt)
 
-TjScaleRuby is a Ruby gem that automatically monitors your background job queues — **Delayed Job or Sidekiq** — and your web traffic, and sends metrics to a remote monitoring service for auto-scaling purposes. It integrates seamlessly with Rails applications and Heroku deployments.
+TJ Scale (`tj-scale`) is a Ruby gem that automatically monitors your background job queues — **Delayed Job or Sidekiq** — and your web traffic, and sends metrics to a remote monitoring service for auto-scaling purposes. It integrates seamlessly with Rails applications and Heroku deployments.
 
 ## Features
 
@@ -28,7 +28,7 @@ The control plane lives in its own project, **`tj-scale-dashboard`** (a sibling
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "tj-scale-ruby", "~> 1.2"
+gem "tj-scale", "~> 1.0"
 ```
 
 And then execute:
@@ -40,7 +40,7 @@ $ bundle install
 Or install it yourself as:
 
 ```bash
-$ gem install tj-scale-ruby
+$ gem install tj-scale
 ```
 
 ### From Source
@@ -48,8 +48,8 @@ $ gem install tj-scale-ruby
 1. Clone the repository:
 
 ```bash
-git clone https://github.com/untechnickle/tj-scale-ruby.git
-cd tj-scale-ruby
+git clone https://github.com/Untechnickle/tj-scale-gem.git
+cd tj-scale-gem
 ```
 
 2. Install dependencies:
@@ -85,7 +85,7 @@ Build the gem, publish or reference it, add it to your Rails app, and set config
    cd /path/to/tj-scale
    git init   # if needed
    git add .
-   git commit -m "Release tj-scale-ruby"
+   git commit -m "Release tj-scale"
    ```
 
 2. **Install dependencies and verify quality**:
@@ -101,10 +101,10 @@ Build the gem, publish or reference it, add it to your Rails app, and set config
 4. **Build the package**:
 
    ```bash
-   gem build tj-scale-ruby.gemspec
+   gem build tj-scale.gemspec
    ```
 
-   This produces `tj-scale-ruby-<version>.gem` in the current directory.
+   This produces `tj-scale-<version>.gem` in the current directory.
 
 ### 3. Publish the gem (choose one)
 
@@ -114,13 +114,13 @@ Build the gem, publish or reference it, add it to your Rails app, and set config
 2. Push the file you built (version must match `VERSION`):
 
    ```bash
-   gem push tj-scale-ruby-1.0.0.gem
+   gem push tj-scale-1.0.1.gem
    ```
 
 **Private gem host**
 
 ```bash
-gem push tj-scale-ruby-1.0.0.gem --host https://your-gem-server.com
+gem push tj-scale-1.0.1.gem --host https://your-gem-server.com
 ```
 
 Configure Bundler in the app if your host needs authentication (see your provider’s docs).
@@ -130,9 +130,9 @@ Configure Bundler in the app if your host needs authentication (see your provide
 In the app’s `Gemfile`:
 
 ```ruby
-gem "tj-scale-ruby", git: "https://github.com/untechnickle/tj-scale-ruby.git", branch: "main"
+gem "tj-scale", git: "https://github.com/Untechnickle/tj-scale-gem.git", branch: "main"
 # or path for local development:
-# gem "tj-scale-ruby", path: "../tj-scale"
+# gem "tj-scale", path: "../tj-scale"
 ```
 
 Then `bundle install`.
@@ -142,7 +142,7 @@ Then `bundle install`.
 1. Open the app’s **`Gemfile`** and add (adjust version or source as above):
 
    ```ruby
-   gem "tj-scale-ruby", "~> 1.2"
+   gem "tj-scale", "~> 1.0"
    ```
 
 2. Run:
@@ -177,26 +177,26 @@ Configuration is **entirely via environment variables** (and Heroku **config var
 
 Heroku sets **`DYNO`** (for example `web.1`, `worker.1`) and typically **`HEROKU_APP_NAME`**; do not set **`DYNO`** manually in production.
 
-**Example: `revize-prod` (web) and `revize-prod-mirror` (workers)**
+**Example: `my-app-web` (web) and `my-app-workers` (workers)**
 
 Use the same token on both apps if one backend handles scaling.
 
 ```bash
-# revize-prod — reporter on web.1, scale web dynos
+# my-app-web — reporter on web.1, scale web dynos
 heroku config:set TJ_SCALE_API_TOKEN=your_token \
   TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics \
-  TJ_SCALE_TARGET_APP=revize-prod \
+  TJ_SCALE_TARGET_APP=my-app-web \
   TJ_SCALE_TARGET_PROCESS=web \
   TJ_SCALE_MONITOR_PROCESS=web \
-  -a revize-prod
+  -a my-app-web
 
-# revize-prod-mirror — reporter on worker.1, scale worker dynos
+# my-app-workers — reporter on worker.1, scale worker dynos
 heroku config:set TJ_SCALE_API_TOKEN=your_token \
   TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics \
-  TJ_SCALE_TARGET_APP=revize-prod-mirror \
+  TJ_SCALE_TARGET_APP=my-app-workers \
   TJ_SCALE_TARGET_PROCESS=worker \
   TJ_SCALE_MONITOR_PROCESS=worker \
-  -a revize-prod-mirror
+  -a my-app-workers
 ```
 
 On the **web** app, enable **`TJ_SCALE_ENABLE_QUEUE_TIME_MIDDLEWARE=1`** (and restart) so `queue_time_ms` is populated from Heroku’s router; the web dyno does not need a shared Delayed Job DB for that path.
@@ -214,7 +214,7 @@ The gem POSTs JSON with **`timestamp`**, **`heroku_app`**, **`target_process`**,
 
 ### 7. Verify
 
-- At least one **web** dyno on `revize-prod` and one **worker** dyno on `revize-prod-mirror` so **`web.1`** and **`worker.1`** exist.
+- At least one **web** dyno on `my-app-web` and one **worker** dyno on `my-app-workers` so **`web.1`** and **`worker.1`** exist.
 - Check **Rails logs** for `TjScaleRuby` lines (debug/warn/error).
 - Confirm your API receives periodic requests with the expected payload.
 
@@ -274,29 +274,29 @@ heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1
 
 The `DYNO` environment variable is automatically set by Heroku and is used to determine which dyno should run the monitoring loop (only `web.1` or `worker.1`, depending on `TJ_SCALE_MONITOR_PROCESS`).
 
-### Example: web on `revize-prod`, workers on `revize-prod-mirror`
+### Example: web on `my-app-web`, workers on `my-app-workers`
 
 Use two Heroku apps (or one app with both process types—same idea). Configure each app’s config vars so the **monitoring service** receives `heroku_app`, `target_process`, and `job_count` on each POST. Scaling bounds (min/max dynos) are set in the control plane's dashboard.
 
-**App `revize-prod` (web dynos)** — run the reporter on the first web dyno and scale `web` dynos:
+**App `my-app-web` (web dynos)** — run the reporter on the first web dyno and scale `web` dynos:
 
 ```bash
-heroku config:set TJ_SCALE_API_TOKEN=your_token -a revize-prod
-heroku config:set TJ_SCALE_MONITOR_PROCESS=web -a revize-prod
-heroku config:set TJ_SCALE_TARGET_APP=revize-prod -a revize-prod
-heroku config:set TJ_SCALE_TARGET_PROCESS=web -a revize-prod
-heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a revize-prod
-heroku config:set TJ_SCALE_ENABLE_QUEUE_TIME_MIDDLEWARE=1 -a revize-prod
+heroku config:set TJ_SCALE_API_TOKEN=your_token -a my-app-web
+heroku config:set TJ_SCALE_MONITOR_PROCESS=web -a my-app-web
+heroku config:set TJ_SCALE_TARGET_APP=my-app-web -a my-app-web
+heroku config:set TJ_SCALE_TARGET_PROCESS=web -a my-app-web
+heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a my-app-web
+heroku config:set TJ_SCALE_ENABLE_QUEUE_TIME_MIDDLEWARE=1 -a my-app-web
 ```
 
-**App `revize-prod-mirror` (worker dynos)** — run the reporter on `worker.1` and scale `worker` dynos:
+**App `my-app-workers` (worker dynos)** — run the reporter on `worker.1` and scale `worker` dynos:
 
 ```bash
-heroku config:set TJ_SCALE_API_TOKEN=your_token -a revize-prod-mirror
-heroku config:set TJ_SCALE_MONITOR_PROCESS=worker -a revize-prod-mirror
-heroku config:set TJ_SCALE_TARGET_APP=revize-prod-mirror -a revize-prod-mirror
-heroku config:set TJ_SCALE_TARGET_PROCESS=worker -a revize-prod-mirror
-heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a revize-prod-mirror
+heroku config:set TJ_SCALE_API_TOKEN=your_token -a my-app-workers
+heroku config:set TJ_SCALE_MONITOR_PROCESS=worker -a my-app-workers
+heroku config:set TJ_SCALE_TARGET_APP=my-app-workers -a my-app-workers
+heroku config:set TJ_SCALE_TARGET_PROCESS=worker -a my-app-workers
+heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a my-app-workers
 ```
 
 Ensure both apps have the `web` / `worker` process types in the `Procfile` as needed, deploy, and scale at least one dyno of each monitored type so `web.1` / `worker.1` exist.
@@ -388,7 +388,7 @@ For a full checklist (git, tests, version, integrate in the app, Heroku), see **
 3. Build the gem:
 
 ```bash
-gem build tj-scale-ruby.gemspec
+gem build tj-scale.gemspec
 ```
 
 This will create a `.gem` file in the current directory.
@@ -400,7 +400,7 @@ This will create a `.gem` file in the current directory.
 3. Configure your credentials:
 
 ```bash
-gem push --key your_api_key tj-scale-ruby-1.0.0.gem
+gem push --key your_api_key tj-scale-1.0.1.gem
 ```
 
 Or use the credentials file:
@@ -411,7 +411,7 @@ Or use the credentials file:
 # ---
 # :rubygems_api_key: your_api_key_here
 
-gem push tj-scale-ruby-1.0.0.gem
+gem push tj-scale-1.0.1.gem
 ```
 
 ### Publishing to a Private Gem Server
@@ -419,7 +419,7 @@ gem push tj-scale-ruby-1.0.0.gem
 If you're using a private gem server:
 
 ```bash
-gem push tj-scale-ruby-1.0.0.gem --host https://your-gem-server.com
+gem push tj-scale-1.0.1.gem --host https://your-gem-server.com
 ```
 
 ## Deployment
@@ -429,7 +429,7 @@ gem push tj-scale-ruby-1.0.0.gem --host https://your-gem-server.com
 1. Add the gem to your `Gemfile`:
 
 ```ruby
-gem "tj-scale-ruby", "~> 1.2"
+gem "tj-scale", "~> 1.0"
 ```
 
 2. Set the required environment variables:
@@ -469,7 +469,7 @@ The gem works with any Rails application. Just ensure:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/untechnickle/tj-scale-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Untechnickle/tj-scale-gem.
 
 1. Fork the repository
 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
@@ -491,7 +491,7 @@ See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.
 
 ## Support
 
-For issues, questions, or contributions, please open an issue on the [GitHub repository](https://github.com/untechnickle/tj-scale-ruby/issues).
+For issues, questions, or contributions, please open an issue on the [GitHub repository](https://github.com/Untechnickle/tj-scale-gem/issues).
 
 ## Authors
 

data/lib/tj_scale_ruby/version.rb

@@ -2,5 +2,5 @@
 
 # Version module for TjScaleRuby gem
 module TjScaleRuby
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tj-scale
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Tanuj
@@ -148,21 +148,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.14'
 description: |
-  TjScaleRuby reports metrics from your Rails app to an TJ Scale (or compatible)
-  control plane so it can autoscale Heroku formation from rules you configure there.
+  TJ Scale is a lightweight metrics agent that lets a TJ Scale dashboard autoscale
+  your Heroku dynos based on real queue pressure instead of CPU or memory.
 
-  Behavior at a glance:
-  - Runs a background loop on exactly one dyno: web.1 or worker.1 (configurable).
-  - Worker reporter: waiting job count and oldest-job age (queue_time_s) from Delayed Job
-    or Sidekiq — pick with TJ_SCALE_JOB_BACKEND (auto-detected by default).
-  - Web reporter: router queue_time_ms (Rack middleware + X-Request-Start), request volume,
-    and average response time per reporting interval.
-  - Sends target Heroku app and process type on every POST; scaling limits
-    (min/max dynos) are configured in the control plane's dashboard settings.
-  - Configure with environment variables; no Rails initializer required.
+  Add the gem, set a few environment variables, and a background reporter starts on
+  exactly one dyno (web.1 or worker.1 — your choice). Every few seconds it POSTs a
+  small JSON payload to your dashboard, which applies the scaling rules, limits, and
+  cooldowns you configure there and calls the Heroku Platform API. The gem itself
+  never scales anything, keeping your app free of Heroku credentials.
 
-  Requires Rails 6.1+ and Ruby 3.0+. Bring your own queue gem: delayed_job_active_record
-  or sidekiq (worker reporters only).
+  Worker mode reports the number of waiting jobs and the age of the oldest one, from
+  either Delayed Job or Sidekiq (auto-detected). Web mode reports router queue time
+  (via Rack middleware and the X-Request-Start header), request volume, and average
+  response time.
+
+  Zero-config inside Rails: no initializer needed, everything is driven by
+  environment variables. Requires Rails 6.1+ and Ruby 3.0+. For worker metrics,
+  bring your own queue gem (delayed_job_active_record or sidekiq).
 email:
 - tanuj@untechnickle.com
 executables: []
@@ -204,6 +206,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: 'Rails gem: Delayed Job / Sidekiq queue metrics for Heroku auto-scaling (web
-  or worker dynos)'
+summary: Heroku autoscaling agent for Rails — reports web and worker queue metrics
+  (Delayed Job or Sidekiq) to your TJ Scale dashboard
 test_files: []