harmacist/healthchecks
1
0
Fork 0
forked from GithubBackups/healthchecks
Code Issues Pull Requests Projects Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Pēteris Caune 2015-07-21 01:23:57 +03:00
parent 71b5e1ef87
commit 6a4cef3131
3 changed files with 61 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
hc/front/views.py
View File

@ -1,5 +1,6 @@
from datetime import timedelta as td
from django.conf import settings
from django.contrib.auth.decorators import login_required
from django.http import HttpResponseForbidden
from django.shortcuts import redirect, render
@ -61,7 +62,12 @@ def pricing(request):
def docs(request):
return render(request, "front/docs.html", {"page": "docs"})
ctx = {
"page": "docs",
"ping_endpoint": settings.PING_ENDPOINT
}
return render(request, "front/docs.html", ctx)
def about(request):

8
templates/front/about.html
View File

@ -18,15 +18,15 @@
<h3>Reliability Guarantees</h3>
<p>
Health Checks is currently at a very early stage as you can probably tell.
Health Checks is currently at an
relatively early stage as you can probably tell.
</p>
<p>
The service is currently run on single $5 Digital Ocean box.
It can and will have ocassional outages. <!-- User data should be safe however,
as we are doing regular database backups to Amazon S3. -->
It can and will have ocassional outages. User data is however
being backed up to Amazon S3 daily.
</p>
<p>
If all this does not sound very inspiring,
there are also alternative services:

54
templates/front/docs.html
View File

@ -35,18 +35,64 @@
In bash scripts, you can use <code>wget</code> or <code>curl</code> to run the requests:
</p>
<pre>
curl http://healthchecks.io/ping/uuid-goes-here
curl {{ ping_endpoint }}{uuid-goes-here}
</pre>
<h3>When Alerts Are Sent</h3>
<p>
Each check has a configurable "Frequency" parameter, with default value of <strong>one day</strong>.
Each check has a configurable <strong>Frequency</strong> parameter, with the default value of one day.
For periodic tasks, this is the expected time gap between two runs.
</p>
<p>
When time since last ping exceeds the configured amount, the check is considered late.
When a check is <strong>1 hour late</strong>, Health Checks sends you an email alert.
Additionally, each check has a <strong>Grace</strong> parameter, with default value of one hour.
You can use this parameter to account for run time variance of tasks.
For example, if a backup task completes in 50 seconds one day, and
completes in 60 seconds the following day, you might not want to get
alerted because the backups are 10 seconds late.
</p>
<p>Each check can be in one of the following states:</p>
<table class="table">
<tr>
<td>
<span class="glyphicon glyphicon-question-sign new"></span>
</td>
<td>
<strong>New.</strong>
A check that has been created, but has not received any pings yet.
</td>
</tr>
<tr>
<td>
<span class="glyphicon glyphicon-ok-sign up"></span>
</td>
<td>
<strong>Up.</strong>
Time since last ping has not exceeded <strong>Frequency</strong>.
</td>
</tr>
<tr>
<td>
<span class="glyphicon glyphicon-exclamation-sign grace"></span>
</td>
<td>
<strong>Late.</strong>
Time since last ping has exceeded <strong>Frequency</strong>,
but has not yet exceeded <strong>Frequency</strong> + <strong>Grace</strong>.
</td>
</tr>
<tr>
<td>
<span class="glyphicon glyphicon-exclamation-sign down"></span>
</td>
<td>
<strong>Down.</strong>
Time since last ping has exceeded <strong>Frequency</strong> + <strong>Grace</strong>.
When check goes from "Late" to "Down", healthchecks.io
sends you an email alert.
</td>
</tr>
</table>
</div>
</div>