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.

-

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:

import requests
 URL = "PING_URL"
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: