Skip to content

docs: add section on third-party monitoring tool arq-ui #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add section on third-party monitoring tool arq-ui #442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,12 @@ in the queue.

.. literalinclude:: examples/job_abort.py

Health checks
.............
Health checks and monitoring
............................

Monitoring and observability tasks remain within the developer's realm of responsibility. However, there are third-party
projects offering monitoring capabilities, such as `arq-ui <https://github.com/antonko/arq-ui>`_. It provides a solution for visualizing and
tracking task execution within arq, albeit with certain limitations.

*arq* will automatically record some info about its current state in redis every ``health_check_interval`` seconds.
That key/value will expire after ``health_check_interval + 1`` seconds so you can be sure if the variable exists *arq*
Expand Down