diff --git a/static/img/docs/edit_cron_schedule.png b/static/img/docs/edit_cron_schedule.png index 0fe0b442..d87a0371 100644 Binary files a/static/img/docs/edit_cron_schedule.png and b/static/img/docs/edit_cron_schedule.png differ diff --git a/templates/docs/configuring_checks.html b/templates/docs/configuring_checks.html index 49c0f648..bdca653a 100644 --- a/templates/docs/configuring_checks.html +++ b/templates/docs/configuring_checks.html @@ -3,65 +3,67 @@ monitor. For example, when monitoring cron jobs, you would create a separate check for each cron job to be monitored. SITE_NAME pricing plans are structured primarily around how many checks you can have in your account. You can create checks -either in SITE_NAME web interface or by calling API.

+either in SITE_NAME web interface or by calling Management API.

Name, Tags, Description

-

Describe each check using optional name, tags and description fields.

+

Describe each check using an optional name, tags, and description fields.

Editing name, tags and description

Simple Schedules

-

SITE_NAME supports two types of schedules: "simple" and "cron". Use "Simple" schedules -for monitoring processes that are expected to run at relatively regular time +

SITE_NAME supports two types of schedules: Simple and Cron. Use Simple +schedules for monitoring processes that you expect to run at relatively regular time intervals: once an hour, once a day, once a week.

Editing the period and grace time

-

For simple schedules you configure two time durations, Period and Grace Time.

+

For the simple schedules, you can configure two parameters, Period and Grace Time.

Cron Schedules

-

Use "cron" for monitoring processes with more complex schedules, and to ensure -jobs run at the correct time (not just at correct time intervals).

+

Use "cron" for monitoring processes with more complex schedules. This monitoring mode +ensures that jobs run at the correct time, and not just at correct time intervals.

Editing cron schedule

-

You will need to specify Cron Expression, Server's Time Zone and Grace Time.

+

You will need to specify Cron Expression, Server's Time Zone, and Grace Time.

Filtering Rules

-

In the "Filtering Rules" dialog you can control several advanced aspects of +

In the "Filtering Rules" dialog, you can control several advanced aspects of how SITE_NAME handles incoming pings for a particular check.

Setting filtering rules

\ No newline at end of file diff --git a/templates/docs/configuring_checks.md b/templates/docs/configuring_checks.md index d5f53e9c..ea0a68f5 100644 --- a/templates/docs/configuring_checks.md +++ b/templates/docs/configuring_checks.md @@ -4,59 +4,60 @@ In SITE_NAME, a **Check** represents a single service you want to monitor. For example, when monitoring cron jobs, you would create a separate check for each cron job to be monitored. SITE_NAME pricing plans are structured primarily around how many checks you can have in your account. You can create checks -either in SITE_NAME web interface or by calling [API](../api/). +either in SITE_NAME web interface or by calling [Management API](../api/). ## Name, Tags, Description -Describe each check using optional name, tags and description fields. +Describe each check using an optional name, tags, and description fields. ![Editing name, tags and description](IMG_URL/edit_name.png) * **Name**: names are optional, but it is a good idea to set them. Good naming becomes especially important as you add more checks in the -account. Names are displayed in the web interface, in email reports and in the -notifications that SITE_NAME sends out. +account. SITE_NAME will display check names in the web interface, in email reports, +and in notifications. * **Tags**: a space-separated list of optional labels. Use tags to organize and group -checks within a project. You can tag checks by environment -(`prod`, `staging`, `dev`, ...) or by role (`www`, `db`, `worker`, ...) or using +checks within a project. You can tag checks by the environment +(`prod`, `staging`, `dev`, etc.) or by role (`www`, `db`, `worker`, etc.) or using any other system. * **Description**: a free-form text field with any related information for your team -or for your future self: what is being monitored, who set it up, -what to do in case of failures, where to look for additional information. +or your future self. Describe the cron job's role, who set it up, what to do in +case of failures, where to look for additional information. ## Simple Schedules -SITE_NAME supports two types of schedules: "simple" and "cron". Use "Simple" schedules -for monitoring processes that are expected to run at relatively regular time +SITE_NAME supports two types of schedules: **Simple** and **Cron**. Use Simple +schedules for monitoring processes that you expect to run at relatively regular time intervals: once an hour, once a day, once a week. ![Editing the period and grace time](IMG_URL/edit_simple_schedule.png) -For simple schedules you configure two time durations, Period and Grace Time. +For the simple schedules, you can configure two parameters, Period and Grace Time. -* **Period**: the expected time between pings -* **Grace Time**: when a check is late, how long to wait before sending an alert. -Use this variable to account for small, expected deviations in job execution times. +* **Period** is the expected time between pings. +* **Grace Time** is the additional time to wait before sending an alert when a check +is late. Use this parameter to account for small, expected deviations in job +execution times. ## Cron Schedules -Use "cron" for monitoring processes with more complex schedules, and to ensure -jobs run **at the correct time** (not just at correct time intervals). +Use "cron" for monitoring processes with more complex schedules. This monitoring mode +ensures that jobs run **at the correct time**, and not just at correct time intervals. ![Editing cron schedule](IMG_URL/edit_cron_schedule.png) -You will need to specify Cron Expression, Server's Time Zone and Grace Time. +You will need to specify Cron Expression, Server's Time Zone, and Grace Time. -* **Cron Expression**: enter the same expression you've used in the crontab. -* **Server's Time Zone**: cron daemon typically uses the local time of the machine it is -running on. If the machine is not using UTC timezone, you need to tell SITE_NAME -what timezone to use. -* **Grace Time**: same as for simple schedules, how long to wait before sending an alert -for a late check. +* **Cron Expression** is the cron expression you specified in the crontab. +* **Server's Time Zone** is the timezone of your server. The cron daemon typically uses +system's local time. If the machine is not using the UTC timezone, you need to +specify it here. +* **Grace Time**, same as for simple schedules, is how long to wait before sending an +alert for a late check. ## Filtering Rules -In the "Filtering Rules" dialog you can control several advanced aspects of +In the "Filtering Rules" dialog, you can control several advanced aspects of how SITE_NAME handles incoming pings for a particular check. ![Setting filtering rules](IMG_URL/filtering_rules.png) @@ -64,15 +65,16 @@ how SITE_NAME handles incoming pings for a particular check. * **Allowed request methods for HTTP requests**. You can require the ping requests to use HTTP POST. Use the "Only POST" option if you run into issues of preview bots hitting the ping URLs when you send them in email or post them in chat. -* **Filter by keywords in the Subject line**. When pinging via [email](../email/), +* **Filter by keywords in the Subject line**. When pinging [via email](../email/), look for specific keywords in the subject line. If the subject line contains any of the keywords listed in **Success Keywords**, SITE_NAME will assume it to be a success signal. Likewise, if it contains any of the keywords listed in **Failure Keywords**, SITE_NAME will treat it as an explicit failure signal. -This is useful, for example, if your backup software sends an email after each backup +For example, this is useful if your backup software sends an email after each backup run with a different subject line depending on success or failure. -* **Pinging a Paused Check**. When you ping a paused check, normally it leaves -the paused state and goes into the "up" or "down" state (depending on the type of -the ping). This changes if you select the "Ignore the ping, stay in the paused state" -option: the paused state becomes "sticky". SITE_NAME will ignore all incoming pings -until you explicitly *resume* the check. +* **Pinging a Paused Check**. Normally, when you ping a paused check, it leaves the +paused state and goes into the "up" state (or the "down" state +in case of [a failure signal](../signalling_failures/)). +You can change this behavior by selecting the "Ignore the ping, stay in +the paused state" option. With this option selected, the paused state becomes "sticky": +SITE_NAME will ignore all incoming pings until you explicitly *resume* the check. diff --git a/templates/docs/introduction.html b/templates/docs/introduction.html index cb6bb06c..60ec6a4b 100644 --- a/templates/docs/introduction.html +++ b/templates/docs/introduction.html @@ -1,12 +1,13 @@

SITE_NAME Documentation

SITE_NAME is a service for monitoring cron jobs and similar periodic processes:

SITE_NAME works as a dead man's switch for processes that need to -run continuously or on regular, known schedule. For example:

+run continuously or on a regular, known schedule. For example: