forked from hyperjumptech/monika
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation for status notification schedule (hyperjumptech#436)
* docs: added guide for status notification schedule * docs: added guide on how to disable status notification
- Loading branch information
Showing
2 changed files
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
id: status-notification | ||
title: Status Notification | ||
--- | ||
|
||
Monika sends status notification periodically based on a schedule with following information: | ||
|
||
- Host | ||
- Number of probes | ||
- Average response time in the last 24 hours | ||
- Incidents in the last 24 hours | ||
- Recoveries in the last 24 hours | ||
- Number of sent notifications in the last 24 hours | ||
- Application version | ||
|
||
By default the schedule is set to 6 AM everyday. You can configure the schedule with cron syntax via command line argument like so: | ||
|
||
```bash | ||
monika --status-notification "0 6 * * *" | ||
``` | ||
|
||
or via configuration file like so: | ||
|
||
```yml | ||
notifications: | ||
- id: desktop | ||
type: desktop | ||
probes: | ||
- requests: | ||
- url: http://example.com | ||
status-notification: 0 6 * * * | ||
``` | ||
You can also choose to disable this feature altogether. Just set the value to `false` | ||
|
||
```bash | ||
monika --status-notification false | ||
``` | ||
|
||
or | ||
|
||
```yml | ||
notifications: ... | ||
probes: ... | ||
status-notification: false | ||
``` |