Browse Source

Illustrations in "Measuring script run time" page

pull/328/head
Pēteris Caune 5 years ago
parent
commit
e29b2387de
No known key found for this signature in database GPG Key ID: E28D7679E9A9EDE2
6 changed files with 32 additions and 7 deletions
  1. BIN
      static/img/docs/checks_durations.png
  2. BIN
      static/img/docs/details_durations.png
  3. +3
    -3
      templates/docs/configuring_notifications.html
  4. +3
    -3
      templates/docs/configuring_notifications.md
  5. +12
    -1
      templates/docs/measuring_script_run_time.html
  6. +14
    -0
      templates/docs/measuring_script_run_time.md

BIN
static/img/docs/checks_durations.png View File

Before After
Width: 931  |  Height: 675  |  Size: 81 KiB

BIN
static/img/docs/details_durations.png View File

Before After
Width: 794  |  Height: 674  |  Size: 126 KiB

+ 3
- 3
templates/docs/configuring_notifications.html View File

@ -35,12 +35,12 @@ Set them up in <a href="../../accounts/profile/">Account Settings › Email Repo
<h2>Monthly Reports</h2>
<p>SITE_NAME sends monthly email reports at the start of each month. Use them
to make sure all checks have their expected state and nothing has
fallen "through the cracks".</p>
"fallen through the cracks".</p>
<p>A monthly report shows checks from all projects you have access
to. For each check it lists:</p>
<ul>
<li>check's current status</li>
<li>the number of downtimes for two previous months</li>
<li>the downtime duration for two previous months</li>
<li>the number of downtimes by month, for the two previous months</li>
<li>the total downtime duration by month, for the two previous months</li>
</ul>
<p><img alt="Example monthly report" src="IMG_URL/monthly_report.png" /></p>

+ 3
- 3
templates/docs/configuring_notifications.md View File

@ -44,13 +44,13 @@ Set them up in [Account Settings › Email Reports](../../accounts/profile/):
SITE_NAME sends monthly email reports at the start of each month. Use them
to make sure all checks have their expected state and nothing has
fallen "through the cracks".
"fallen through the cracks".
A monthly report shows checks from all projects you have access
to. For each check it lists:
* check's current status
* the number of downtimes for two previous months
* the downtime duration for two previous months
* the number of downtimes by month, for the two previous months
* the total downtime duration by month, for the two previous months
![Example monthly report](IMG_URL/monthly_report.png)

+ 12
- 1
templates/docs/measuring_script_run_time.html View File

@ -27,4 +27,15 @@ success within its configured "Grace Time", or it will get marked as "down".</p>
<span class="c1"># Signal success:</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="p">)</span>
</pre></div>
</pre></div>
<h2>Viewing Measured Run Times</h2>
<p>When SITE_NAME receives a "start" signal followed by a regular ping or a "fail"
signal, and the two events are less than 24 hours apart,
you will see the time delta displayed in the list of checks. If the two events are
more than 24 hours apart, they are assumed to be unrelated, and the time delta is
not displayed.</p>
<p><img alt="List of checks with durations" src="IMG_URL/checks_durations.png" /></p>
<p>You can also see durations of the previous runs when viewing an individual check:</p>
<p><img alt="Log of received pings with durations" src="IMG_URL/details_durations.png" /></p>

+ 14
- 0
templates/docs/measuring_script_run_time.md View File

@ -33,3 +33,17 @@ print("F(42) = %d" % fib(42))
# Signal success:
requests.get(URL)
```
## Viewing Measured Run Times
When SITE_NAME receives a "start" signal followed by a regular ping or a "fail"
signal, and the two events are less than 24 hours apart,
you will see the time delta displayed in the list of checks. If the two events are
more than 24 hours apart, they are assumed to be unrelated, and the time delta is
not displayed.
![List of checks with durations](IMG_URL/checks_durations.png)
You can also see durations of the previous runs when viewing an individual check:
![Log of received pings with durations](IMG_URL/details_durations.png)

Loading…
Cancel
Save