OpenSource/homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update healthchecks docs

Browse Source
This commit is contained in:
shamoon 2024-01-07 08:57:47 -08:00
parent d4ab1439b4
commit 1b45ad3977
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/widgets/services/healthchecks.md
View File

@ -3,16 +3,21 @@ title: Health checks
description: Health checks Widget Configuration description: Health checks Widget Configuration
--- ---
Specify a single check by including the `uuid` field or show the total 'up' and 'down' for all
checks by leaving off the `uuid` field.
To use the Health Checks widget, you first need to generate an API key. To use the Health Checks widget, you first need to generate an API key.
1. In your project, go to project Settings on the navigation bar. 1. In your project, go to project Settings on the navigation bar.
2. Click on API key (read-only) and then click _Create_. 2. Click on API key (read-only) and then click _Create_.
3. Copy the API key that is generated for you. 3. Copy the API key that is generated for you.
Allowed fields: `["status", "last_ping"]` for single checks, `["up", "down"]` for total stats.
```yaml ```yaml
widget: widget:
type: healthchecks type: healthchecks
url: http://healthchecks.host.or.ip:port url: http://healthchecks.host.or.ip:port
key: <YOUR_API_KEY> key: <YOUR_API_KEY>
uuid: <YOUR_CHECK_UUID> # optional, if not present group statistics is shown uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown
``` ```