Skip to content

Commit

Permalink
Added documentation for status notification schedule (hyperjumptech#436)
Browse files Browse the repository at this point in the history
* docs: added guide for status notification schedule

* docs: added guide on how to disable status notification
  • Loading branch information
armedi committed Sep 23, 2021
1 parent 1c96d51 commit 38bb867
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/src/manifests/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@
"path": "/guides/tls-checkers",
"editUrl": "/guides/tls-checkers.md"
},
{
"title": "Status Notification",
"path": "/guides/status-notification",
"editUrl": "/guides/status-notification.md"
},
{
"title": "CLI Options",
"path": "/guides/cli-options",
Expand Down
46 changes: 46 additions & 0 deletions docs/src/pages/guides/status-notification.md
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
```

0 comments on commit 38bb867

Please sign in to comment.