Add backwards compatility explanation in Readme
continuous-integration/drone/push Build is passing Details

This commit is contained in:
IamTheFij 2021-05-12 16:37:59 -07:00
parent 860c2cdf43
commit 49e3635819
1 changed files with 13 additions and 1 deletions

View File

@ -54,7 +54,7 @@ The global configurations are:
|key|value|
|---|---|
|`check_interval`|Maximum frequency to run checks for each monitor (as duration, eg. 1m2s)|
|`check_interval`|Maximum frequency to run checks for each monitor as duration, eg. 1m2s.|
|`monitors`|List of all monitors. Detailed description below|
|`alerts`|List of all alerts. Detailed description below|
@ -143,6 +143,18 @@ alerts:
command: 'echo {{.MonitorName}}'
```
Interval durations have changed from being an integer number of seconds to a duration string supported by Go, for example:
minitor-py:
```yaml
check_interval: 90
```
minitor-go:
```yaml
check_interval: 1m30s
```
For the time being, legacy configs for the Python version of Minitor should be compatible if you apply the `-py-compat` flag when running Minitor. Eventually, this flag will go away when later breaking changes are introduced.
## Future