Crear una plantilla de monitor de integración
Los monitores Datadog realizan un seguimiento de métricas clave, para que puedas monitorizar eficientemente tu infraestructura y tus integraciones. Datadog proporciona un conjunto de monitores listos para utilizar para muchas funciones e integraciones. Consulta estos monitores en tu lista de plantillas de monitores.
Crea un monitor listo para usar para ayudar a los usuarios a encontrar valor en tu integración de Datadog. En esta guía, se proporcionan los pasos para crear una plantilla de monitor de integración y las prácticas recomendadas a seguir durante el proceso de creación.
Para crear una integración Datadog, consulta la sección de creación de una nueva integración.
Pasos para crear una plantilla de monitor
Crear un esquema JSON para monitores
Crea un monitor.
Sigue las prácticas recomendadas de esta guía para configurar tu monitor.
Haz clic en Export Monitor (Exportar monitor).
Marca la casilla Select to export as a monitor template (Seleccionar para exportar como plantilla de monitor).
Haz clic en Copy (Copiar) para utilizar el esquema JSON de tu monitor configurado.
Guarda el esquema copiado en un archivo JSON y nómbralo según el título de tu monitor. Por ejemplo, your_integration_name_alert.json.
En el archivo JSON del monitor, rellena el Título, la Descripción y las Etiquetas (tags). Para obtener más información, consulta Prácticas de configuración recomendadas.
Abrir una solicitud pull
Guarda el archivo JSON del monitor en tu carpeta de integraciones assets/monitors. Añade el recurso a tu archivo manifest.json. Para obtener más información sobre la estructura del archivo y el archivo de manifiesto de tu integración, consulta Referencia de recursos de integraciones.
Abra una solicitud de extracción (PR) para añadir el archivo JSON de plantilla de monitor y el archivo de manifiesto actualizado a la carpeta integración correspondiente, ya sea en el repositorio de GitHub integrations-extras o en el repositorio de GitHub Marketplace.
Una vez aprobada, Datadog fusiona la PR y la plantilla de monitor de la integración se pasa a producción.
Verificar tu monitor en producción
Para ver el monitor listo para utilizar, el cuadro de integración relevante debe ser Installed en Datadog.
Encuentra tu monitor en la lista de plantillas de monitores. Asegúrate de que los logotipos se muestran correctamente en la página de listas de plantillas de monitores.
Prácticas de configuración recomendadas
Además de la definición de tu monitor, los campos Título, Descripción y Etiquetas son obligatorios para las plantillas de monitor. Configura las etiquetas como “integración:<app_id>”; consulta otras etiquetas de monitor disponibles aquí. Para obtener más información, consulta la documentación de configuración de un monitor.
Título
El título permite a los usuarios comprender rápidamente el modo de fallo subyacente que abarca la alerta.
- Utiliza la voz activa y empieza con un objeto seguido de un verbo.
- No utilices variables de plantilla.
| Necesita revisión | Mejor | El mejor |
|---|
| Mensajes numerosos no reconocidos, informados en {{host.name}} | Mensajes numerosos no reconocidos, informados | Los mensajes no reconocidos son más numerosos de lo habitual |
Descripción
Proporciona contexto adicional con respecto al modo de fallo y también sobre el impacto que este modo puede tener en el sistema. Debe permitir a los usuarios comprender de un vistazo si es relevante o no para ellos crear un monitor a partir de él.
- No se trata de una copia del título.
- Define el problema enunciado en el título.
- Responde por qué es un problema que merece generar alertas.
- Describe el impacto del problema.
| Necesita revisión | Mejor | El mejor |
|---|
| Notifica a tu equipo cuando los mensajes no reconocidos son numerosos. | Los mensajes no reconocidos son aquellos que han sido entregados a un consumidor pero que no han sido reconocidos como procesados o gestionados. Este monitor realiza un seguimiento de la proporción de mensajes no reconocidos. | Los mensajes no reconocidos son aquellos que han sido entregados a un consumidor pero que no han sido reconocidos como procesados o gestionados. Este monitor realiza un seguimiento de la proporción de mensajes no reconocidos para evitar posibles cuellos de botella que podrían provocar retrasos en el procesamiento de los mensajes. |
Referencias adicionales
Más enlaces, artículos y documentación útiles:
