From 78113e1aea3e423ae2aadf19acc9fe54f75dbbd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C4=93teris=20Caune?= Date: Mon, 9 Aug 2021 17:52:20 +0300 Subject: [PATCH] Improve "Grace Time" description in docs cc: #547 --- templates/docs/configuring_checks.html | 5 +++++ templates/docs/configuring_checks.md | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/templates/docs/configuring_checks.html b/templates/docs/configuring_checks.html index ea440d4e..fbb6ae9b 100644 --- a/templates/docs/configuring_checks.html +++ b/templates/docs/configuring_checks.html @@ -32,6 +32,11 @@ intervals: once an hour, once a day, once a week.

is late. Use this parameter to account for small, expected deviations in job execution times. +

Note: if you use the "start" signal to measure job run times, +then Grace Time also specifies how long the job is expected to run. Whenever SITE_NAME +receives a "start" signal, it expects to receive a subsequent "success" signal +within Grace Time. If the success signal does not arrive within the configured +Grace Time, SITE_NAME will mark the check as failed and send out alerts.

Cron Schedules

Use "cron" for monitoring processes with more complex schedules. This monitoring mode ensures that jobs run at the correct time, and not just at correct time intervals.

diff --git a/templates/docs/configuring_checks.md b/templates/docs/configuring_checks.md index 08b80e4f..d0a9082f 100644 --- a/templates/docs/configuring_checks.md +++ b/templates/docs/configuring_checks.md @@ -39,6 +39,12 @@ For the simple schedules, you can configure two parameters, Period and Grace Tim is late. Use this parameter to account for small, expected deviations in job execution times. +Note: if you use the "start" signal to [measure job run times](../measuring_script_run_time/), +then Grace Time also specifies how long the job is expected to run. Whenever SITE_NAME +receives a "start" signal, it expects to receive a subsequent "success" signal +within Grace Time. If the success signal does not arrive within the configured +Grace Time, SITE_NAME will mark the check as failed and send out alerts. + ## Cron Schedules Use "cron" for monitoring processes with more complex schedules. This monitoring mode