From 49e363581938b6c86549d13d002ea4e8d8ff0473 Mon Sep 17 00:00:00 2001 From: Ian Fijolek Date: Wed, 12 May 2021 16:37:59 -0700 Subject: [PATCH] Add backwards compatility explanation in Readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 107fbf5..4db92d7 100644 --- a/README.md +++ b/README.md @@ -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