Skip to content

Commit

Permalink
docs: Add /healthz/readiness endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivov
ivov committed Sep 5, 2024
1 parent f67bec9 commit 9e0b88a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/hosting/logging-monitoring/monitoring.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,24 @@ contentType: howto
There are two API endpoints you can call to check the status of your instance: `/healthz` and `/metrics`.

<!-- vale off -->
## healthz
## healthz and healthz/readiness
<!-- vale on -->
The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It's available for both self-hosted and Cloud users.
The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It does not indicate DB status. It's available for both self-hosted and Cloud users.

Check failure on line 14 in docs/hosting/logging-monitoring/monitoring.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-microsoft.Contractions] Use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[from-microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "docs/hosting/logging-monitoring/monitoring.md", "range": {"start": {"line": 14, "column": 106}}}, "severity": "ERROR"}

Check warning on line 14 in docs/hosting/logging-monitoring/monitoring.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.TooWordy] 'indicate' is too wordy.

Raw Output:
{"message": "[from-write-good.TooWordy] 'indicate' is too wordy.", "location": {"path": "docs/hosting/logging-monitoring/monitoring.md", "range": {"start": {"line": 14, "column": 115}}}, "severity": "WARNING"}

Access the endpoint:

```
<your-instance-url>/healthz
```

The /healthz/readiness endpoint is similar to the `/healthz` endpoint, but it returns a HTTP status code of 200 if the DB is connected and migrated and therefore the instance is ready to accept traffic.

Check warning on line 22 in docs/hosting/logging-monitoring/monitoring.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.TooWordy] 'similar to' is too wordy.

Raw Output:
{"message": "[from-write-good.TooWordy] 'similar to' is too wordy.", "location": {"path": "docs/hosting/logging-monitoring/monitoring.md", "range": {"start": {"line": 22, "column": 36}}}, "severity": "WARNING"}

Check warning on line 22 in docs/hosting/logging-monitoring/monitoring.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Passive] 'is connected' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[from-write-good.Passive] 'is connected' may be passive voice. Use active voice if you can.", "location": {"path": "docs/hosting/logging-monitoring/monitoring.md", "range": {"start": {"line": 22, "column": 123}}}, "severity": "WARNING"}

Check warning on line 22 in docs/hosting/logging-monitoring/monitoring.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.TooWordy] 'therefore' is too wordy.

Raw Output:
{"message": "[from-write-good.TooWordy] 'therefore' is too wordy.", "location": {"path": "docs/hosting/logging-monitoring/monitoring.md", "range": {"start": {"line": 22, "column": 153}}}, "severity": "WARNING"}

Access the endpoint:

```
<your-instance-url>/healthz/readiness
```


## metrics

Expand Down

0 comments on commit 9e0b88a

Please sign in to comment.