Skip to content

Commit

Permalink
docs: Improve README
Browse files Browse the repository at this point in the history
* Fix link to worker example

* Add visual interest to callout notes
  • Loading branch information
karls authored Mar 8, 2023
1 parent d85cd10 commit b493359
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ Install Judoscale for Celery with:
$ pip install 'judoscale[celery-redis]'
```

> **NOTE 1:** The Judoscale Celery integration currently only works with the [Redis broker](https://docs.celeryq.dev/en/stable/getting-started/backends-and-brokers/index.html#redis).
> :warning: **NOTE 1:** The Judoscale Celery integration currently only works with the [Redis broker](https://docs.celeryq.dev/en/stable/getting-started/backends-and-brokers/index.html#redis).
> **NOTE 2:** Using [task priorities](https://docs.celeryq.dev/en/latest/userguide/calling.html#advanced-options) is currently not supported by `judoscale`. You can still use task priorities, but `judoscale` won't see and report metrics on any queues other than the default, unprioritised queue.
> :warning: **NOTE 2:** Using [task priorities](https://docs.celeryq.dev/en/latest/userguide/calling.html#advanced-options) is currently not supported by `judoscale`. You can still use task priorities, but `judoscale` won't see and report metrics on any queues other than the default, unprioritised queue.
Judoscale can automatically scale the number of Celery workers based on the queue latency (the age of the oldest pending task in the queue).

Expand Down Expand Up @@ -143,7 +143,7 @@ If you need to change the Judoscale integration configuration, you can pass a di
judoscale_celery(celery_app, extra_config={"LOG_LEVEL": "DEBUG"})
```

> **NOTE:** Calling `judoscale_celery` turns on sending [`task-sent`](https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-send-sent-event) events. This is required for the Celery integration with Judoscale to work.
> :warning: **NOTE:** Calling `judoscale_celery` turns on sending [`task-sent`](https://docs.celeryq.dev/en/stable/userguide/configuration.html#task-send-sent-event) events. This is required for the Celery integration with Judoscale to work.
### Judoscale with Celery and Flask

Expand Down Expand Up @@ -238,7 +238,7 @@ with app.app_context():
worker.work()
```

See the [run-worker.py script](./sample-apps/rq_sample/run-worker.py) for reference.
See the [run-worker.py script](./sample-apps/flask_rq_sample/run-worker.py) for reference.

### Judoscale with RQ and Django

Expand Down Expand Up @@ -294,7 +294,7 @@ JUDOSCALE = {
}
```

> **NOTE:** Django-RQ enables configuring RQ such that different queues and workers use _different_ Redis instances. Judoscale currently only supports connecting to and monitoring queue latency on a single Redis instance.
> :warning: **NOTE:** Django-RQ enables configuring RQ such that different queues and workers use _different_ Redis instances. Judoscale currently only supports connecting to and monitoring queue latency on a single Redis instance.
## Development

Expand Down

0 comments on commit b493359

Please sign in to comment.