From 74f56a5501bad0951b9f577da68af75724e475b6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C4=93teris=20Caune?= <cuu508@gmail.com>
Date: Fri, 6 Aug 2021 16:10:06 +0300
Subject: [PATCH] Improve the note about start signals and alerting logic

cc: #547
---
 templates/docs/measuring_script_run_time.html |  8 ++++++--
 templates/docs/measuring_script_run_time.md   | 11 +++++++++--
 2 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/templates/docs/measuring_script_run_time.html b/templates/docs/measuring_script_run_time.html
index f7c42e92..26095150 100644
--- a/templates/docs/measuring_script_run_time.html
+++ b/templates/docs/measuring_script_run_time.html
@@ -4,8 +4,12 @@
  It will store the "start" events and display the job execution times. SITE_NAME
  calculates the job execution times as the time gaps between adjacent "start" and
  "complete" events.</p>
-<p>Signaling a start kicks off a separate timer: the job now <strong>must</strong> signal a
-success within its configured "Grace Time," or it will get marked as "down."</p>
+<h2>Alerting Logic</h2>
+<p>SITE_NAME applies an additional alerting rule for jobs that  use the <code>/start</code> signal.</p>
+<p>If a job sends a "start" signal, but then does not send a "complete"
+signal within its configured grace time, SITE_NAME will assume the job
+has failed. It will mark the job as "down" and send out alerts.</p>
+<h2>Usage Example</h2>
 <p>Below is a code example in Python:</p>
 <div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">requests</span>
 <span class="n">URL</span> <span class="o">=</span> <span class="s2">&quot;PING_URL&quot;</span>
diff --git a/templates/docs/measuring_script_run_time.md b/templates/docs/measuring_script_run_time.md
index 8e446ff9..82544bbf 100644
--- a/templates/docs/measuring_script_run_time.md
+++ b/templates/docs/measuring_script_run_time.md
@@ -6,8 +6,15 @@
  calculates the job execution times as the time gaps between adjacent "start" and
  "complete" events.
 
-Signaling a start kicks off a separate timer: the job now **must** signal a
-success within its configured "Grace Time," or it will get marked as "down."
+## Alerting Logic
+
+SITE_NAME applies an additional alerting rule for jobs that  use the `/start` signal.
+
+If a job sends a "start" signal, but then does not send a "complete"
+signal within its configured grace time, SITE_NAME will assume the job
+has failed. It will mark the job as "down" and send out alerts.
+
+## Usage Example
 
 Below is a code example in Python: