Skip to content

Commit 8d092a3

Browse files
authored
[DOCS-12837] Add monitor title/description guidelines (#33663)
* [DOCS-12837] Add monitor title/description guidelines * Add note * Change callout type * Move tables into procedure * Fix indentation * Add back an editorial change that got lost
1 parent 9fe93b9 commit 8d092a3

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

content/en/extend/integrations/create-an-integration-monitor-template.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,18 @@ After you've created and tested your monitor, add it to your listing in the Deve
6363
2. Click **Import Monitor**.
6464
3. Search for and select the monitor you created. You can include up to 10 monitors per integration.
6565
4. For each monitor, provide a **Display Name** and **Description**. These appear on the [**Monitors > Templates**][2] page:
66-
- **Display Name**: A concise title that clearly communicates what the alert covers. Use active voice (for example, `Database latency exceeds threshold`).
66+
- **Display Name**: A concise title that clearly communicates what the alert covers. Use active voice and start with the resource or metric followed by a verb (for example, `Database latency exceeds threshold`). Do not use template variables.
67+
68+
| Needs revision | Better | Best |
69+
|--------------------------------------------------------|---------------------------------------|-----------------------------------------------|
70+
| High Unacknowledged Messages reported on {{host.name}} | High Unacknowledged Messages reported | Unacknowledged Messages are higher than usual |
71+
6772
- **Description**: A short explanation that helps users decide whether the monitor is relevant to them. Describe why this alert matters and what impact it addresses.
73+
74+
| Needs revision | Better | Best |
75+
|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
76+
| Notify your team when unacked message are high. | Unacked messages are those that have been delivered to a consumer but have not been acknowledged as processed or handled. This monitor tracks the ratio of unacked messages. | Unacked messages are those that have been delivered to a consumer but have not been acknowledged as processed or handled. This monitor tracks the ratio of unacked messages to avoid potential bottlenecks which could lead to delays in message processing. |
77+
6878
5. Click **Import**, then **Save Changes**.
6979

7080
## Further Reading

0 commit comments

Comments
 (0)