mirror of
https://github.com/healthchecks/healthchecks.git
synced 2024-11-23 07:57:39 +00:00
b9996e63c8
HTML files in /templates/docs/ are not Django templates,
they contain HTML content to be used verbatim in
hc.front.views.serve_doc view.
Some of these files contain "{{ ... }}" syntax. When
we run "./manage.py compress", django-compressor trips
up on this syntax because it treats them as Django templates.
The fix is to change file extension for these files
from .html to something else (I picked .html-fragment)
so django-compressor would ignore them.
44 lines
2.9 KiB
Plaintext
44 lines
2.9 KiB
Plaintext
<h1>Signaling failures</h1>
|
|
<p>You can actively signal a failure to SITE_NAME by slightly changing the
|
|
ping URL: append either <code>/fail</code> or <code>/{exit-status}</code> to your normal ping URL.
|
|
The exit status should be a 0-255 integer. SITE_NAME will interpret
|
|
exit status 0 as success and all non-zero values as failures.</p>
|
|
<p>Examples:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="c1"># Reports failure by appending the /fail suffix:</span>
|
|
curl<span class="w"> </span>--retry<span class="w"> </span><span class="m">3</span><span class="w"> </span>PING_URL/fail
|
|
|
|
<span class="c1"># Reports failure by appending a non-zero exit status:</span>
|
|
curl<span class="w"> </span>--retry<span class="w"> </span><span class="m">3</span><span class="w"> </span>PING_URL/1
|
|
</code></pre></div>
|
|
|
|
<p>By actively signaling failures to SITE_NAME, you can minimize the delay from your
|
|
monitored service encountering a problem to you getting notified about it.</p>
|
|
<h2>Shell Scripts</h2>
|
|
<p>The below shell script appends <code>$?</code> (a special variable that contains the
|
|
exit status of the last executed command) to the ping URL:</p>
|
|
<div class="highlight"><pre><span></span><code><span class="ch">#!/bin/sh</span>
|
|
|
|
/usr/bin/certbot<span class="w"> </span>renew
|
|
curl<span class="w"> </span>--retry<span class="w"> </span><span class="m">3</span><span class="w"> </span>PING_URL/<span class="nv">$?</span>
|
|
</code></pre></div>
|
|
|
|
<h2>Python</h2>
|
|
<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>
|
|
<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">"PING_URL"</span>
|
|
|
|
<span class="k">def</span> <span class="nf">do_work</span><span class="p">():</span>
|
|
<span class="c1"># Do your number crunching, backup dumping, newsletter sending 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="kc">True</span>
|
|
|
|
<span class="n">success</span> <span class="o">=</span> <span class="kc">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">"/fail"</span><span class="p">)</span>
|
|
</code></pre></div> |