Create an Integration-Monitor Template
Overview
This guide provides steps for creating a monitor template and best practices to follow during the creation process.
Datadog Monitors track key metrics, so you can efficiently monitor your infrastructure and integrations. Datadog provides a set of out-of-the-box monitors for many features and integrations. View these monitors in your Monitors Template list.
Create an out-of-the-box monitor to help users find value in your Datadog integration. To create a Datadog integration, see Create a New Integration.
Create a monitor
In your Datadog sandbox, create a monitor.
Follow the best practices listed in this guide to configure your monitor.
Upload your monitor
Within your integration in the Integration Developer Platform, navigate to the Content tab. From there, select import monitor to choose from a list of available monitors. You can select up to 10 monitors to include with your integration.
Verify your monitor in production
To see the out-of-the-box monitor:
- Find your detection rule in the Monitor Template list, and click to expand it.
- Ensure logos render correctly.
- Verify that the monitor is enabled.
Find your monitor in the Monitors Template list. Ensure logos render correctly on the Monitors Template lists page.
Configuration best practices
In addition to the monitor definition, the Title, Description, and Tags fields are required for monitor templates. Set tags to “integration:<app_id>”, see other available monitor tags here. For more information, see the documentation on configuring a monitor.
Title
The title allows users to quickly understand the underlying failure mode the alert is covering.
- Use the active voice and start with an object followed by a verb.
- Do not use template variables.
| Needs revision | Better | Best |
|---|
| High Unacknowledged Messages reported on {{host.name}} | High Unacknowledged Messages reported | Unacknowledged Messages are higher than usual |
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.
- This is not a copy of the title.
- Define the problem stated by the title.
- Answer why this is an issue worth alerting on.
- Describe the impact of the problem.
| Needs revision | Better | Best |
|---|
| 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. |
Further Reading
Additional helpful documentation, links, and articles:
