tj-scale 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +43 -43
- data/lib/tj_scale_ruby/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bfa02cccd18ac22e845267ddac5835d60c620e793e65aa34b648d1cc7889eab3
|
|
4
|
+
data.tar.gz: 28a78e5c2643a400910aaca6d535f191f521c1633a8eaab48d28365aa40835e6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a269ea3a6087b6bdf54f40a6ac98960d7e70219049ec02dea5d7de592277fba106c5e77769277bd04b3623e356ad90a03926cb0bfcc7edef0867f37ef1bc11d3
|
|
7
|
+
data.tar.gz: e2ed378beb3196a9e9508132f04fea691a828ee6359650b8bb8e6daa96c8693199cbb091e06c8ee1d9aa31353596f7af305c23fbe7703ecbf8a35c9fceb78bb7
|
data/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [1.0.2] (tj-scale) - 2026-06-12
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- README fully updated for the `tj-scale` name: install/build/publish instructions,
|
|
15
|
+
repository URLs (`Untechnickle/tj-scale-gem`), and generic example app names.
|
|
16
|
+
- Supersedes 1.0.0 and 1.0.1, which are yanked (same code, stale docs/description).
|
|
17
|
+
|
|
10
18
|
## [1.0.1] (tj-scale) - 2026-06-12
|
|
11
19
|
|
|
12
20
|
### Changed
|
data/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# tj-scale
|
|
2
2
|
|
|
3
3
|
[](https://www.ruby-lang.org/)
|
|
4
4
|
[](https://rubyonrails.org/)
|
|
5
5
|
[](LICENSE.txt)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
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.
|
|
8
8
|
|
|
9
9
|
## Features
|
|
10
10
|
|
|
@@ -28,7 +28,7 @@ The control plane lives in its own project, **`tj-scale-dashboard`** (a sibling
|
|
|
28
28
|
Add this line to your application's Gemfile:
|
|
29
29
|
|
|
30
30
|
```ruby
|
|
31
|
-
gem "tj-scale
|
|
31
|
+
gem "tj-scale", "~> 1.0"
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
And then execute:
|
|
@@ -40,7 +40,7 @@ $ bundle install
|
|
|
40
40
|
Or install it yourself as:
|
|
41
41
|
|
|
42
42
|
```bash
|
|
43
|
-
$ gem install tj-scale
|
|
43
|
+
$ gem install tj-scale
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
### From Source
|
|
@@ -48,8 +48,8 @@ $ gem install tj-scale-ruby
|
|
|
48
48
|
1. Clone the repository:
|
|
49
49
|
|
|
50
50
|
```bash
|
|
51
|
-
git clone https://github.com/
|
|
52
|
-
cd tj-scale-
|
|
51
|
+
git clone https://github.com/Untechnickle/tj-scale-gem.git
|
|
52
|
+
cd tj-scale-gem
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
2. Install dependencies:
|
|
@@ -85,7 +85,7 @@ Build the gem, publish or reference it, add it to your Rails app, and set config
|
|
|
85
85
|
cd /path/to/tj-scale
|
|
86
86
|
git init # if needed
|
|
87
87
|
git add .
|
|
88
|
-
git commit -m "Release tj-scale
|
|
88
|
+
git commit -m "Release tj-scale"
|
|
89
89
|
```
|
|
90
90
|
|
|
91
91
|
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
|
|
|
101
101
|
4. **Build the package**:
|
|
102
102
|
|
|
103
103
|
```bash
|
|
104
|
-
gem build tj-scale
|
|
104
|
+
gem build tj-scale.gemspec
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
-
This produces `tj-scale
|
|
107
|
+
This produces `tj-scale-<version>.gem` in the current directory.
|
|
108
108
|
|
|
109
109
|
### 3. Publish the gem (choose one)
|
|
110
110
|
|
|
@@ -114,13 +114,13 @@ Build the gem, publish or reference it, add it to your Rails app, and set config
|
|
|
114
114
|
2. Push the file you built (version must match `VERSION`):
|
|
115
115
|
|
|
116
116
|
```bash
|
|
117
|
-
gem push tj-scale-
|
|
117
|
+
gem push tj-scale-1.0.1.gem
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
**Private gem host**
|
|
121
121
|
|
|
122
122
|
```bash
|
|
123
|
-
gem push tj-scale-
|
|
123
|
+
gem push tj-scale-1.0.1.gem --host https://your-gem-server.com
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
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
|
|
|
130
130
|
In the app’s `Gemfile`:
|
|
131
131
|
|
|
132
132
|
```ruby
|
|
133
|
-
gem "tj-scale
|
|
133
|
+
gem "tj-scale", git: "https://github.com/Untechnickle/tj-scale-gem.git", branch: "main"
|
|
134
134
|
# or path for local development:
|
|
135
|
-
# gem "tj-scale
|
|
135
|
+
# gem "tj-scale", path: "../tj-scale"
|
|
136
136
|
```
|
|
137
137
|
|
|
138
138
|
Then `bundle install`.
|
|
@@ -142,7 +142,7 @@ Then `bundle install`.
|
|
|
142
142
|
1. Open the app’s **`Gemfile`** and add (adjust version or source as above):
|
|
143
143
|
|
|
144
144
|
```ruby
|
|
145
|
-
gem "tj-scale
|
|
145
|
+
gem "tj-scale", "~> 1.0"
|
|
146
146
|
```
|
|
147
147
|
|
|
148
148
|
2. Run:
|
|
@@ -177,26 +177,26 @@ Configuration is **entirely via environment variables** (and Heroku **config var
|
|
|
177
177
|
|
|
178
178
|
Heroku sets **`DYNO`** (for example `web.1`, `worker.1`) and typically **`HEROKU_APP_NAME`**; do not set **`DYNO`** manually in production.
|
|
179
179
|
|
|
180
|
-
**Example: `
|
|
180
|
+
**Example: `my-app-web` (web) and `my-app-workers` (workers)**
|
|
181
181
|
|
|
182
182
|
Use the same token on both apps if one backend handles scaling.
|
|
183
183
|
|
|
184
184
|
```bash
|
|
185
|
-
#
|
|
185
|
+
# my-app-web — reporter on web.1, scale web dynos
|
|
186
186
|
heroku config:set TJ_SCALE_API_TOKEN=your_token \
|
|
187
187
|
TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics \
|
|
188
|
-
TJ_SCALE_TARGET_APP=
|
|
188
|
+
TJ_SCALE_TARGET_APP=my-app-web \
|
|
189
189
|
TJ_SCALE_TARGET_PROCESS=web \
|
|
190
190
|
TJ_SCALE_MONITOR_PROCESS=web \
|
|
191
|
-
-a
|
|
191
|
+
-a my-app-web
|
|
192
192
|
|
|
193
|
-
#
|
|
193
|
+
# my-app-workers — reporter on worker.1, scale worker dynos
|
|
194
194
|
heroku config:set TJ_SCALE_API_TOKEN=your_token \
|
|
195
195
|
TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics \
|
|
196
|
-
TJ_SCALE_TARGET_APP=
|
|
196
|
+
TJ_SCALE_TARGET_APP=my-app-workers \
|
|
197
197
|
TJ_SCALE_TARGET_PROCESS=worker \
|
|
198
198
|
TJ_SCALE_MONITOR_PROCESS=worker \
|
|
199
|
-
-a
|
|
199
|
+
-a my-app-workers
|
|
200
200
|
```
|
|
201
201
|
|
|
202
202
|
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`**,
|
|
|
214
214
|
|
|
215
215
|
### 7. Verify
|
|
216
216
|
|
|
217
|
-
- At least one **web** dyno on `
|
|
217
|
+
- At least one **web** dyno on `my-app-web` and one **worker** dyno on `my-app-workers` so **`web.1`** and **`worker.1`** exist.
|
|
218
218
|
- Check **Rails logs** for `TjScaleRuby` lines (debug/warn/error).
|
|
219
219
|
- Confirm your API receives periodic requests with the expected payload.
|
|
220
220
|
|
|
@@ -274,29 +274,29 @@ heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1
|
|
|
274
274
|
|
|
275
275
|
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`).
|
|
276
276
|
|
|
277
|
-
### Example: web on `
|
|
277
|
+
### Example: web on `my-app-web`, workers on `my-app-workers`
|
|
278
278
|
|
|
279
279
|
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.
|
|
280
280
|
|
|
281
|
-
**App `
|
|
281
|
+
**App `my-app-web` (web dynos)** — run the reporter on the first web dyno and scale `web` dynos:
|
|
282
282
|
|
|
283
283
|
```bash
|
|
284
|
-
heroku config:set TJ_SCALE_API_TOKEN=your_token -a
|
|
285
|
-
heroku config:set TJ_SCALE_MONITOR_PROCESS=web -a
|
|
286
|
-
heroku config:set TJ_SCALE_TARGET_APP=
|
|
287
|
-
heroku config:set TJ_SCALE_TARGET_PROCESS=web -a
|
|
288
|
-
heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a
|
|
289
|
-
heroku config:set TJ_SCALE_ENABLE_QUEUE_TIME_MIDDLEWARE=1 -a
|
|
284
|
+
heroku config:set TJ_SCALE_API_TOKEN=your_token -a my-app-web
|
|
285
|
+
heroku config:set TJ_SCALE_MONITOR_PROCESS=web -a my-app-web
|
|
286
|
+
heroku config:set TJ_SCALE_TARGET_APP=my-app-web -a my-app-web
|
|
287
|
+
heroku config:set TJ_SCALE_TARGET_PROCESS=web -a my-app-web
|
|
288
|
+
heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a my-app-web
|
|
289
|
+
heroku config:set TJ_SCALE_ENABLE_QUEUE_TIME_MIDDLEWARE=1 -a my-app-web
|
|
290
290
|
```
|
|
291
291
|
|
|
292
|
-
**App `
|
|
292
|
+
**App `my-app-workers` (worker dynos)** — run the reporter on `worker.1` and scale `worker` dynos:
|
|
293
293
|
|
|
294
294
|
```bash
|
|
295
|
-
heroku config:set TJ_SCALE_API_TOKEN=your_token -a
|
|
296
|
-
heroku config:set TJ_SCALE_MONITOR_PROCESS=worker -a
|
|
297
|
-
heroku config:set TJ_SCALE_TARGET_APP=
|
|
298
|
-
heroku config:set TJ_SCALE_TARGET_PROCESS=worker -a
|
|
299
|
-
heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a
|
|
295
|
+
heroku config:set TJ_SCALE_API_TOKEN=your_token -a my-app-workers
|
|
296
|
+
heroku config:set TJ_SCALE_MONITOR_PROCESS=worker -a my-app-workers
|
|
297
|
+
heroku config:set TJ_SCALE_TARGET_APP=my-app-workers -a my-app-workers
|
|
298
|
+
heroku config:set TJ_SCALE_TARGET_PROCESS=worker -a my-app-workers
|
|
299
|
+
heroku config:set TJ_SCALE_API_URL=https://your-control-plane.example.com/api/v1/metrics -a my-app-workers
|
|
300
300
|
```
|
|
301
301
|
|
|
302
302
|
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 **
|
|
|
388
388
|
3. Build the gem:
|
|
389
389
|
|
|
390
390
|
```bash
|
|
391
|
-
gem build tj-scale
|
|
391
|
+
gem build tj-scale.gemspec
|
|
392
392
|
```
|
|
393
393
|
|
|
394
394
|
This will create a `.gem` file in the current directory.
|
|
@@ -400,7 +400,7 @@ This will create a `.gem` file in the current directory.
|
|
|
400
400
|
3. Configure your credentials:
|
|
401
401
|
|
|
402
402
|
```bash
|
|
403
|
-
gem push --key your_api_key tj-scale-
|
|
403
|
+
gem push --key your_api_key tj-scale-1.0.1.gem
|
|
404
404
|
```
|
|
405
405
|
|
|
406
406
|
Or use the credentials file:
|
|
@@ -411,7 +411,7 @@ Or use the credentials file:
|
|
|
411
411
|
# ---
|
|
412
412
|
# :rubygems_api_key: your_api_key_here
|
|
413
413
|
|
|
414
|
-
gem push tj-scale-
|
|
414
|
+
gem push tj-scale-1.0.1.gem
|
|
415
415
|
```
|
|
416
416
|
|
|
417
417
|
### Publishing to a Private Gem Server
|
|
@@ -419,7 +419,7 @@ gem push tj-scale-ruby-1.0.0.gem
|
|
|
419
419
|
If you're using a private gem server:
|
|
420
420
|
|
|
421
421
|
```bash
|
|
422
|
-
gem push tj-scale-
|
|
422
|
+
gem push tj-scale-1.0.1.gem --host https://your-gem-server.com
|
|
423
423
|
```
|
|
424
424
|
|
|
425
425
|
## Deployment
|
|
@@ -429,7 +429,7 @@ gem push tj-scale-ruby-1.0.0.gem --host https://your-gem-server.com
|
|
|
429
429
|
1. Add the gem to your `Gemfile`:
|
|
430
430
|
|
|
431
431
|
```ruby
|
|
432
|
-
gem "tj-scale
|
|
432
|
+
gem "tj-scale", "~> 1.0"
|
|
433
433
|
```
|
|
434
434
|
|
|
435
435
|
2. Set the required environment variables:
|
|
@@ -469,7 +469,7 @@ The gem works with any Rails application. Just ensure:
|
|
|
469
469
|
|
|
470
470
|
## Contributing
|
|
471
471
|
|
|
472
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
472
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/Untechnickle/tj-scale-gem.
|
|
473
473
|
|
|
474
474
|
1. Fork the repository
|
|
475
475
|
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.
|
|
|
491
491
|
|
|
492
492
|
## Support
|
|
493
493
|
|
|
494
|
-
For issues, questions, or contributions, please open an issue on the [GitHub repository](https://github.com/
|
|
494
|
+
For issues, questions, or contributions, please open an issue on the [GitHub repository](https://github.com/Untechnickle/tj-scale-gem/issues).
|
|
495
495
|
|
|
496
496
|
## Authors
|
|
497
497
|
|