Skip to content

Commit f709642

Browse files
committed
[DOCS-12837] Add monitor title/description guidelines
1 parent b6826e4 commit f709642

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,29 @@ Start by reviewing the [full list of monitor types][6] to understand what kinds
4747

4848
[Create and configure your monitor][5] within your partner developer organization. These monitors serve as reusable templates that integration users can enable directly in their own Datadog organizations.
4949

50+
See the following best practices for your monitor template's title and description:
51+
52+
#### Write a title for your monitor template
53+
54+
The title allows users to understand the underlying failure mode the alert is covering.
55+
- Use the active voice and start with an object followed by a verb.
56+
- Do not use template variables.
57+
58+
| Needs revision | Better | Best |
59+
| ----------- | ----------- | ----------- |
60+
|High Unacknowledged Messages reported on {{host.name}}| High Unacknowledged Messages reported |Unacknowledged Messages are higher than usual|
61+
62+
#### Write a description for your monitor template
63+
64+
The description provides extra context around the failure mode and also about the impact this mode can have on the system. It should allow users to understand at a glance whether it is relevant or not for them to create a monitor out of it. The description should not be a copy of the title.
65+
- Define the problem stated by the title.
66+
- Answer why this is an issue worth alerting on.
67+
- Describe the impact of the problem.
68+
69+
| Needs revision | Better | Best |
70+
| ----------- | ----------- | ----------- |
71+
|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.|
72+
5073
### Test your monitor
5174

5275
1. Ingest telemetry that triggers your monitor.

0 commit comments

Comments
 (0)