Skip to content

Document new health check env varaibles #626

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
ComfortablyCoding wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −0
Open

Document new health check env varaibles #626

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
17 changes: 17 additions & 0 deletions content/configuration/healthcheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Health Check
description: Configuration for the server health check service.
---

:partial{content="config-env-vars"}

The health check service powers the `/server/health` endpoint, which reports the status of connected services like the database, edis, storage, and email. Results are cached and shared across requests to avoid excessive checks.

| Variable | Description | Default Value |
| ----------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------ |
| `HEALTHCHECK_ENABLED` | Whether or not to enable the `/server/health` endpoint. | `true` |
| `HEALTHCHECK_NAMESPACE` | Namespace used for health check cache keys to prevent conflicts with other cached data. | `directus:healthcheck` |
| `HEALTHCHECK_SERVICES` | Comma-separated list of services to check. Supported values: `database`, `redis`, `storage`, `email`. | `database,redis,storage,email` |
| `HEALTHCHECK_CACHE_TTL` | How long the cached health check result is valid before services are re-checked. | `5m` |

Individual services also support their own health check threshold configuration. See [Database](/configuration/database), [Cache](/configuration/cache), [Files](/configuration/files), and [Security & Limits](/configuration/security-limits) for `*_HEALTHCHECK_THRESHOLD` variables.