Skip to content

Commit d553cb1

Browse files
committed
docs(config): add description field with Rocky AI context to all check config pages
1 parent 11cc6c5 commit d553cb1

7 files changed

Lines changed: 31 additions & 2 deletions

File tree

detect/synthetic-monitoring/api-checks/configuration.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,4 +212,12 @@ This list shows all content types that we scrub from the response data.
212212
|`video/x-ms-wmv`|
213213
|`video/x-msvideo`|
214214
|`video/x-flv`|
215-
|`video/webm`|
215+
|`video/webm`|
216+
217+
## Additional Settings
218+
219+
* **Name:** Give your check a clear name to identify it in dashboards and alerts
220+
* **Description:** Add context about what this check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview)
221+
* **Tags:** Use tags to organize checks across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview)
222+
* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries)
223+
* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations

detect/synthetic-monitoring/playwright-checks/configuration.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,10 @@ A Playwright Check Suite inherits multiple properties from [the abstract `Check`
102102

103103
Check out [the reference documentation](/constructs/project#param-checks-playwright-checks) for more information on these settings.
104104

105+
<Tip>
106+
Use the `description` property to add context about what your check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview).
107+
</Tip>
108+
105109
<Note>
106110
**Checks' Retry strategy is not applicable for Playwright checks.** Playwright includes its own retry features that can be set up directly in your `playwright.config.ts/js` file with the [`retries`](https://playwright.dev/docs/test-retries) option. This allows for more detailed management of test retries within Playwright, when your check runs.
107111
</Note>

detect/uptime-monitoring/dns-monitors/configuration.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours):
323323
### Additional Settings
324324

325325
* **Name:** Give your monitor a clear name to identify it in dashboards and alerts
326+
* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview)
326327
* **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview)
327328
* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries)
328329
* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations

detect/uptime-monitoring/heartbeat-monitors/configuration.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,12 @@
22
title: Heartbeat Configuration
33
description: Ensure your critical automated processes are running as expected.
44
sidebarTitle: Configuration
5-
---
5+
---
6+
7+
### Additional Settings
8+
9+
* **Name:** Give your monitor a clear name to identify it in dashboards and alerts
10+
* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview)
11+
* **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview)
12+
* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries)
13+
* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations

detect/uptime-monitoring/icmp-monitors/configuration.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours):
101101
### Additional Settings
102102

103103
* **Name:** Give your monitor a clear name to identify it in dashboards and alerts
104+
* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview)
104105
* **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview)
105106
* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries)
106107
* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations

detect/uptime-monitoring/tcp-monitors/configuration.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours):
6565
### Additional Settings
6666

6767
* **Name:** Give your monitor a clear name to identify it in dashboards and alerts
68+
* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview)
6869
* **Tags:** Use tags to organize monitors across dashboards and [maintenance windows](/communicate/maintenance-windows/overview)
6970
* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries)
7071
* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations

detect/uptime-monitoring/url-monitors/configuration.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,12 @@ Define where notifications are sent when checks fail or recover. Additional chan
139139
**Global Alert Settings**: By default, monitors inherit your account's notification preferences. Select "Use specific notification settings" to customize alerts for individual monitors.
140140
</Note>
141141

142+
### Additional Settings
143+
144+
* **Name:** Give your monitor a clear name to identify it in dashboards and alerts
145+
* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview)
146+
* **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview)
147+
142148

143149

144150

0 commit comments

Comments
 (0)