"Signalling a Failure" section in docs. (cc: #151)

hc/front/management/commands/pygmentize.py

@@ -34,6 +34,7 @@ class Command(BaseCommand):
         _process("node", lexers.JavascriptLexer())
         _process("python_urllib2", lexers.PythonLexer())
         _process("python_requests", lexers.PythonLexer())
+        _process("python_requests_fail", lexers.PythonLexer())
         _process("php", lexers.PhpLexer())
         _process("powershell", lexers.shell.PowerShellLexer())
         _process("powershell_inline", lexers.shell.BashLexer())

templates/front/docs.html

@@ -15,11 +15,18 @@
 <h2>Summary</h2>
 <p>
 Each check in <a href="{% url 'hc-index' %}">My Checks</a>
-page has an unique "ping" URL. Whenever you access this URL,
+page has a unique "ping" URL. Whenever you make a HTTP request to this URL,
-the "Last Ping" value of corresponding check is updated.
+{% site_name %} records the request and updates the "Last Ping" value of
+the corresponding check.
 </p>
-<p>When a certain amount of time passes since last received ping, the
+
-check is considered "late", and {% site_name %} sends an email alert.
+<p>When a certain, configurable amount of time passes since last received ping,
+the check is considered "late". {% site_name %} then
+waits for additional time (configured with the "Grace Time" parameter) and,
+if still no ping, sends you an alert.</p>
+
+<p>As long as the monitored service sends pings on time, you receive no
+alerts. As soon as it fails to check in on time, you get notified.
 It is a simple idea.</p>
 
 <h2>Executing a Ping</h2>
@@ -28,18 +35,32 @@ It is a simple idea.</p>
     your ping URL.
 </p>
 <ul>
-    <li>HTTP and HTTPS protocols both are fine</li>
+    <li>HTTP and HTTPS protocols both work.
+        Prefer HTTPS, but on old systems you may need to fall back to HTTP.</li>
     <li>Request method can be GET, POST or HEAD</li>
     <li>Both IPv4 and IPv6 work</li>
-    <li>It does not matter what request headers you send, or what you put in request body.</li>
+    <li>
+        For HTTP POST requests, you can include additional diagnostic information
+        for your own reference in the request body. If the request body looks
+        like a UTF-8 string, {% site_name %} will log the first 10 kilobytes
+        of the request body, so you can inspect it later.
+    </li>
 </ul>
 
 <p>The response will have status code "200 OK" and response body will be a
 short and simple string "OK".</p>
 
+<h2>Signalling a Failure</h2>
 <p>
-    Here are examples of executing pings from different environments.
+    Append <code>/fail</code> to a ping URL and use it to actively signal a
+    failure. Requesting the <code>/fail</code> URL will immediately mark the
+    check as "down". You can use this feature to minimize the delay from
+    your monitored service failing to you getting a notification.
 </p>
+<p>Below is a skeleton code example in Python which signals a failure when the
+work function returns an unexpected value or throws an exception:</p>
+
+{% include "front/snippets/python_requests_fail.html" %}
 
 <a name="crontab"></a>
 <h3>Crontab</h3>

templates/front/snippets/python_requests_fail.html

@@ -0,0 +1,17 @@
+<div class="highlight"><pre><span></span><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>
+
+<span class="k">def</span> <span class="nf">do_work</span><span class="p">():</span>
+    <span class="c1"># Do actual work here.</span>
+    <span class="c1"># Return a truthy value on success.</span>
+    <span class="c1"># Return a falsy value or throw an exception on failure.</span>
+    <span class="k">return</span> <span class="bp">True</span>
+
+<span class="n">success</span> <span class="o">=</span> <span class="bp">False</span>
+<span class="k">try</span><span class="p">:</span>
+    <span class="n">success</span> <span class="o">=</span> <span class="n">do_work</span><span class="p">()</span>
+<span class="k">finally</span><span class="p">:</span>
+    <span class="c1"># On success, requests {{ ping_url }}</span>
+    <span class="c1"># On failure, requests {{ ping_url }}/fail</span>
+    <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span> <span class="k">if</span> <span class="n">success</span> <span class="k">else</span> <span class="n">URL</span> <span class="o">+</span> <span class="s2">&quot;/fail&quot;</span><span class="p">)</span>
+</pre></div>

templates/front/snippets/python_requests_fail.txt

@@ -0,0 +1,16 @@
+import requests
+URL = "PING_URL"
+
+def do_work():
+    # Do actual work here.
+    # Return a truthy value on success.
+    # Return a falsy value or throw an exception on failure.
+    return True
+
+success = False
+try:
+    success = do_work()
+finally:
+    # On success, requests PING_URL
+    # On failure, requests PING_URL/fail
+    requests.get(URL if success else URL + "/fail")