mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
817ccf3620
* Add Quickstart Guide * Update installation * Remove unused files * Update support/backing * Tweaks in concepts * Setup file structure for API reference 2.0 * Setup page layout for reference * Add clean-urls plugin * getting started updates * Finish authentication rest * getting started updates * Render stylus in 2 spaces * Various * Various * Finish activity docs * Add collections reference * Add extension reference * concepts updates * Fields/tweaks * Add files doc * Add revisions * concepts docs * More api reference * Finish rest api reference (finally) * initial concepts * More things * Add assets api ref * Move sections from file to assets * Add environment variables * contributing docs * Add field transforms page * Left align table headers * concept links * Add API config * Fix mobile nav * Add migrating a project * doc link fixes Co-authored-by: Ben Haynes <ben@rngr.org>
68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
# Server Health
|
|
|
|
The `/server/health` endpoint shows you a general health status for the server, and all connected (third party)
|
|
services, like Redis or S3.
|
|
|
|
The output is based on the "Health Check Response for HTTP APIs" draft spec:
|
|
[Health Check Response Format for HTTP APIs Draft Specification](https://tools.ietf.org/id/draft-inadarei-api-health-check-05.html).
|
|
|
|
This endpoint can be used to ensure a healthy system when running in a horizontally scaled setup, like Kubernetes or AWS
|
|
Elastic Beanstalk.
|
|
|
|
By default, the endpoint only returns a `status` of `ok`, `warn` or `error`. By authenticating as an admin, it'll return
|
|
more in-depth information about what the current health status of the system is.
|
|
|
|
```json
|
|
// Response
|
|
|
|
// Non-admin
|
|
{
|
|
"status": "ok"
|
|
}
|
|
|
|
// Admin
|
|
{
|
|
"status": "ok",
|
|
"releaseId": "9.0.0",
|
|
"serviceId": "3292c816-ae02-43b4-ba91-f0bb549f040c",
|
|
"checks": {
|
|
"pg:responseTime": [
|
|
{
|
|
"status": "ok",
|
|
"componentType": "datastore",
|
|
"observedUnit": "ms",
|
|
"observedValue": 0.489
|
|
}
|
|
],
|
|
"pg:connectionsAvailable": [
|
|
{
|
|
"status": "ok",
|
|
"componentType": "datastore",
|
|
"observedValue": 2
|
|
}
|
|
],
|
|
"pg:connectionsUsed": [
|
|
{
|
|
"status": "ok",
|
|
"componentType": "datastore",
|
|
"observedValue": 0
|
|
}
|
|
],
|
|
"storage:local:responseTime": [
|
|
{
|
|
"status": "ok",
|
|
"componentType": "objectstore",
|
|
"observedValue": 1.038,
|
|
"observedUnit": "ms"
|
|
}
|
|
],
|
|
"email:connection": [
|
|
{
|
|
"status": "ok",
|
|
"componentType": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|