Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicnocquee
nicnocquee committed Nov 9, 2023
1 parent 79677f2 commit 40c053d
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions docs/src/pages/guides/probes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,20 @@ probes:
Details of the field are given in the table below.
| Topic | Description |
| :--------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| method (optional) | Http method such as GET, POST, PUT, DELETE. |
| url (required) | This is the url endpoint to dispatch the request to. |
| timeout (optional) | Request timeout in **milliseconds**, Default value is 10000 which corresponds to 10 seconds. If the request takes longer than `timeout`, the request will be aborted. |
| headers (optional) | Http headers you might need for your request. |
| body (optional) | Any http body if your method requires it. |
| interval (optional) | Number of probe's interval (in seconds). Default value is 10 seconds. |
| incidentThreshold (optional) | Number of times an alert should return true before Monika sends notifications. For example, when incidentThreshold is 3, Monika will only send notifications when the probed URL returns non-2xx status 3 times in a row. After sending the notifications, Monika will not send notifications anymore until the alert status changes. Default value is 5. |
| saveBody (optional) | When set to true, the response body of the request is stored in the internal database. The default is off when not defined. This is to keep the log file size small as some responses can be sizable. The setting is for each probe request. |
| alerts (optional) | The condition which will trigger an alert, and the subsequent notification method to send out the alert. See below for further details on alerts and notifications. See [alerts](./alerts) section for detailed information. |
| ping (optional) | (boolean), If set true then send a PING to the specified url instead. |
| allowUnauthorized (optional) | (boolean), If set to true, will make https agent to not check for ssl certificate validity |
| Topic | Description |
| :--------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| method (optional) | Http method such as GET, POST, PUT, DELETE. |
| url (required) | This is the url endpoint to dispatch the request to. |
| timeout (optional) | Request timeout in **milliseconds**, Default value is 10000 which corresponds to 10 seconds. If the request takes longer than `timeout`, the request will be aborted. |
| headers (optional) | Http headers you might need for your request. |
| body (optional) | Any http body if your method requires it. |
| interval (optional) | Number of probe's interval (in seconds). Default value is 10 seconds. |
| incidentThreshold (optional) | Number of times an alert should return true before Monika sends notifications. For example, when incidentThreshold is 3, Monika will only send incident notifications when the probed URL returns non-2xx status 3 times in a row. After sending the notifications, Monika will not send notifications anymore until the alert status changes. Default value is 5. However, the actual number of retries will be the the greatest number between `incidentThreshold` and `recoveryThreshold`. So if you actually want to have 3 retries, you need to set both `incidentThreshold` and `recoveryThreshold`. |
| recoveryThreshold (optional) | Number of retries before Monika sends recovery notifications. Default value is 5. However, the actual number of retries will be the the greatest number between `incidentThreshold` and `recoveryThreshold`. So if you actually want to have 3 retries, you need to set both `incidentThreshold` and `recoveryThreshold`. |
| saveBody (optional) | When set to true, the response body of the request is stored in the internal database. The default is off when not defined. This is to keep the log file size small as some responses can be sizable. The setting is for each probe request. |
| alerts (optional) | The condition which will trigger an alert, and the subsequent notification method to send out the alert. See below for further details on alerts and notifications. See [alerts](./alerts) section for detailed information. |
| ping (optional) | (boolean), If set true then send a PING to the specified url instead. |
| allowUnauthorized (optional) | (boolean), If set to true, will make https agent to not check for ssl certificate validity |

## Request Body

Expand Down

0 comments on commit 40c053d

Please sign in to comment.