Skip to content

Commit

Permalink
Move the description of HEALTHCHECK_CACHE_KEY to the correct section
Browse files Browse the repository at this point in the history
It's a setting for the cache backend, but it's documented under "Celery Health
Check". Create a "cache" section, and move the documentation there.

It's also redundantly documented in `contrib.rst`, despite not being a contrib
module. Remove it from there.

Fix the typo in the default value while I'm at it.
  • Loading branch information
SpecLad committed Jul 1, 2024
1 parent b0e2c4c commit 7bfea2a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
6 changes: 0 additions & 6 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,3 @@ all the time.

You may also use both of them. To use these checks add them to `INSTALLED_APPS` in your
Django settings module.

`cache`
-------

The key `djangohealtcheck_test` will be written to the cache backend to validate that the cache is working.
The name of the key can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value.
22 changes: 18 additions & 4 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ You can still use any uptime bot that is URL based while enjoying token protecti
Do NOT use Django's `SECRET_KEY` setting. This should never be exposed,
to any third party. Not even your trusted uptime bot.

`cache`
-------

The cache backend uses the following setting:

.. list-table::
:widths: 25 10 10 55
:header-rows: 1

* - Name
- Type
- Default
- Description
* - `HEALTHCHECK_CACHE_KEY`
- String
- `djangohealthcheck_test`
- Specifies the name of the key to write to and read from to validate that the cache is working.

`psutil`
--------

Expand Down Expand Up @@ -83,10 +101,6 @@ Using `django.settings` you may exert more fine-grained control over the behavio
- Type
- Default
- Description
* - `HEALTHCHECK_CACHE_KEY`
- String
- `djangohealtcheck_test`
- Specifies the name of the key to write to and read from to validate that the cache is working.
* - `HEALTHCHECK_CELERY_QUEUE_TIMEOUT`
- Number
- `3`
Expand Down

0 comments on commit 7bfea2a

Please sign in to comment.