extern/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2024-11-25 09:24:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
TwinProduction 2021-08-21 23:38:41 -04:00
parent 30b17f7bca
commit 2577b196be
1 changed files with 31 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -67,7 +67,9 @@ For more details, see [Usage](#usage)
- [Reloading configuration on the fly](#reloading-configuration-on-the-fly) - [Reloading configuration on the fly](#reloading-configuration-on-the-fly)
- [Service groups](#service-groups) - [Service groups](#service-groups)
- [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port) - [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port)
- [Uptime Badges (ALPHA)](#uptime-badges) - [Badges](#badges)
- [Uptime](#uptime)
- [Response time](#response-time)
- [API](#api) - [API](#api)
- [High level design overview](#high-level-design-overview) - [High level design overview](#high-level-design-overview)
- [Sponsors](#sponsors) - [Sponsors](#sponsors)
@ -100,7 +102,7 @@ The main features of Gatus are:
- **Alerting**: While having a pretty visual dashboard is useful to keep track of the state of your application(s), you probably don't want to stare at it all day. Thus, notifications via Slack, Mattermost, Messagebird, PagerDuty, Twilio and Teams are supported out of the box with the ability to configure a custom alerting provider for any needs you might have, whether it be a different provider or a custom application that manages automated rollbacks. - **Alerting**: While having a pretty visual dashboard is useful to keep track of the state of your application(s), you probably don't want to stare at it all day. Thus, notifications via Slack, Mattermost, Messagebird, PagerDuty, Twilio and Teams are supported out of the box with the ability to configure a custom alerting provider for any needs you might have, whether it be a different provider or a custom application that manages automated rollbacks.
- **Metrics** - **Metrics**
- **Low resource consumption**: As with most Go applications, the resource footprint that this application requires is negligibly small. - **Low resource consumption**: As with most Go applications, the resource footprint that this application requires is negligibly small.
- **GitHub uptime badges**: ![Uptime 1h](https://status.twinnation.org/api/v1/badges/uptime/1h/core_twinnation-external.svg) ![Uptime 24h](https://status.twinnation.org/api/v1/badges/uptime/24h/core_twinnation-external.svg) ![Uptime 7d](https://status.twinnation.org/api/v1/badges/uptime/7d/core_twinnation-external.svg) - **[Badges](#badges)**: ![Uptime 7d](https://status.twinnation.org/api/v1/badges/uptime/7d/core_twinnation-external.svg) ![Response time 24h](https://status.twinnation.org/api/v1/services/core_twinnation-external/response-times/24h/badge.svg)
## Usage ## Usage
@ -1092,11 +1094,11 @@ web:
port: ${PORT} port: ${PORT}
``` ```
### Badges
### Uptime badges ### Uptime
![Uptime 1h](https://status.twinnation.org/api/v1/badges/uptime/1h/core_twinnation-external.svg) ![Uptime 1h](https://status.twinnation.org/api/v1/services/core_twinnation-external/uptimes/1h/badge.svg)
![Uptime 24h](https://status.twinnation.org/api/v1/badges/uptime/24h/core_twinnation-external.svg) ![Uptime 24h](https://status.twinnation.org/api/v1/services/core_twinnation-external/uptimes/24h/badge.svg)
![Uptime 7d](https://status.twinnation.org/api/v1/badges/uptime/7d/core_twinnation-external.svg) ![Uptime 7d](https://status.twinnation.org/api/v1/services/core_twinnation-external/uptimes/7d/badge.svg)
Gatus can automatically generate a SVG badge for one of your monitored services. Gatus can automatically generate a SVG badge for one of your monitored services.
This allows you to put badges in your individual services' README or even create your own status page, if you This allows you to put badges in your individual services' README or even create your own status page, if you
@ -1104,46 +1106,55 @@ desire.
The endpoint to generate a badge is the following: The endpoint to generate a badge is the following:
``` ```
/api/v1/badges/uptime/{duration}/{identifier}.svg /api/v1/services/{key}/uptimes/{duration}/badge.svg
``` ```
Where: Where:
- `{duration}` is `7d`, `24h` or `1h` - `{duration}` is `7d`, `24h` or `1h`
- `{identifier}` has the pattern `<GROUP_NAME>_<SERVICE_NAME>.svg` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. - `{key}` has the pattern `<GROUP_NAME>_<SERVICE_NAME>` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`.
For instance, if you want the uptime during the last 24 hours from the service `frontend` in the group `core`, For instance, if you want the uptime during the last 24 hours from the service `frontend` in the group `core`,
the URL would look like this: the URL would look like this:
``` ```
http://example.com/api/v1/badges/uptime/7d/core_frontend.svg https://example.com/api/v1/services/core_frontend/uptimes/7d/badge.svg
``` ```
If you want to display a service that is not part of a group, you must leave the group value empty: If you want to display a service that is not part of a group, you must leave the group value empty:
``` ```
http://example.com/api/v1/badges/uptime/7d/_frontend.svg https://example.com/api/v1/services/_frontend/uptimes/7d/badge.svg
``` ```
Example:
Example: ![Uptime 24h](https://status.twinnation.org/api/v1/badges/uptime/24h/core_twinnation-external.svg)
``` ```
![Uptime 24h](https://status.twinnation.org/api/v1/badges/uptime/24h/core_twinnation-external.svg) ![Uptime 24h](https://status.twinnation.org/api/v1/services/core_twinnation-external/uptimes/24h/badge.svg)
``` ```
If you'd like to see a visual example of each badges available, you can simply navigate to the service's detail page. If you'd like to see a visual example of each badges available, you can simply navigate to the service's detail page.
### Response time
![Response time 1h](https://status.twinnation.org/api/v1/services/core_twinnation-external/response-times/1h/badge.svg)
![Response time 24h](https://status.twinnation.org/api/v1/services/core_twinnation-external/response-times/24h/badge.svg)
![Response time 7d](https://status.twinnation.org/api/v1/services/core_twinnation-external/response-times/7d/badge.svg)
The endpoint to generate a badge is the following:
```
/api/v1/services/{key}/response-times/{duration}/badge.svg
```
Where:
- `{duration}` is `7d`, `24h` or `1h`
- `{key}` has the pattern `<GROUP_NAME>_<SERVICE_NAME>` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`.
### API ### API
Gatus provides a simple read-only API which can be queried in order to programmatically determine service status and history. Gatus provides a simple read-only API which can be queried in order to programmatically determine service status and history.
All services are available via a GET request to the following endpoint: All services are available via a GET request to the following endpoint:
``` ```
/api/v1/statuses /api/v1/services/statuses
```` ````
Example: https://status.twinnation.org/api/v1/statuses Example: https://status.twinnation.org/api/v1/statuses
Specific services can also be queried by using the following pattern: Specific services can also be queried by using the following pattern:
``` ```
/api/v1/statuses/{group}_{service} /api/v1/services/{group}_{service}/statuses
``` ```
Example: https://status.twinnation.org/api/v1/statuses/core_twinnation-home Example: https://status.twinnation.org/api/v1/statuses/core_twinnation-home
Gzip compression will be used if the `Accept-Encoding` HTTP header contains `gzip`. Gzip compression will be used if the `Accept-Encoding` HTTP header contains `gzip`.