You can look up UUIDs of your checks in web UI or via Management API calls.
-Check's slug is its name with the following transformations applied:
+Check's slug is derived from check's name using Django's +slugify +function. It applies the following transformations:
For example, if check's name is "Database Backup", its slug is database-backup.
Check's slug can change. SITE_NAME updates check's slug whenever its name changes.
diff --git a/templates/docs/http_api.md b/templates/docs/http_api.md index e8c7e75a..95f2757d 100644 --- a/templates/docs/http_api.md +++ b/templates/docs/http_api.md @@ -30,13 +30,15 @@ chosen one. When you delete a check, you also lose its UUID and cannot get it ba You can look up UUIDs of your checks in web UI or via [Management API](../api/) calls. -**Check's slug** is its name with the following transformations applied: +**Check's slug** is derived from check's name using Django's +[slugify](https://docs.djangoproject.com/en/3.2/ref/utils/#django.utils.text.slugify) +function. It applies the following transformations: * Convert to ASCII. * Convert to lowercase. * Remove characters that aren't alphanumerics, underscores, hyphens, or whitespace. -* Replace any whitespace or repeated dashes with single dashes. -* Remove leading and trailing whitespace, dashes, and underscores. +* Replace any whitespace or repeated hyphens with single hyphens. +* Remove leading and trailing whitespace, hyphens, and underscores. For example, if check's name is "Database Backup", its slug is `database-backup`. diff --git a/templates/docs/introduction.html b/templates/docs/introduction.html index 7971d01b..113431df 100644 --- a/templates/docs/introduction.html +++ b/templates/docs/introduction.html @@ -60,20 +60,21 @@ workers, batch scripts, scheduled tasks, web services) make HTTP requests to the ping URL to signal a start of the execution, a success, or a failure.SITE_NAME supports two ping URL formats:
PING_ENDPOINT{uuid}PING_ENDPOINT<uuid>PING_ENDPOINT{project-ping-key}/{name-slug}PING_ENDPOINT<project-ping-key>/<name-slug>You can append /start, /fail or /{exitcode} to the base ping URL to send
+
You can append /start, /fail or /<exitcode> to the base ping URL to send
"start" and "failure" signals. The "start" and "failure" signals are optional.
You don't have to use them, but you can gain additional monitoring insights
if you do use them. See Measuring script run time and
Signaling failures for details.
You should treat check UUIDs and project Ping keys as secrets. If you make them public, anybody can send telemetry signals to your checks and mess with your monitoring.
+Read more about Ping URLs in Pinging API.
Grace Time is one of the configuration parameters you can set for each check.
It is the additional time to wait before sending an alert when a check
diff --git a/templates/docs/introduction.md b/templates/docs/introduction.md
index 2e6b7d47..d628e78b 100644
--- a/templates/docs/introduction.md
+++ b/templates/docs/introduction.md
@@ -70,14 +70,14 @@ ping URL to signal a start of the execution, a success, or a failure.
SITE_NAME supports two ping URL formats:
-* `PING_ENDPOINT{uuid}`
+* `PING_ENDPOINT
The check is identified by its UUID. Check UUIDs are assigned
automatically by SITE_NAME, and are guaranteed to be unique.
-* `PING_ENDPOINT{project-ping-key}/{name-slug}`
+* `PING_ENDPOINT
The check is identified by project's **Ping key** and check's
**slug** (its name, converted to lowercase, spaces replaced with hyphens).
-You can append `/start`, `/fail` or `/{exitcode}` to the base ping URL to send
+You can append `/start`, `/fail` or `/