Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /
Configuraciones de Alerta
Docs Home
/ /
Mediciones y alertas
/
Configuraciones de Alerta
Docs Home
/
Gestión
/
Gerente de Operaciones
/
API
/
Recursos
/
Mediciones y alertas
/
Configuraciones de Alerta

Crear una configuración de alerta

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal como se indica en el documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/alertConfigs

Parámetros de la ruta de solicitud

Todos los parámetros de ruta de solicitud son obligatorios.

Parameter
Tipo
Descripción

PROJECT-ID

string

Identificador único para este proyecto.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuesta HTTP

content

Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nota

Las configuraciones de alerta varían. Una configuración de alerta puede incluir solo un subconjunto de estos elementos.

Nombre
Tipo
Descripción

habilitado

booleano

Si se omite, la configuración se desactivará.

eventTypeName
Required.

string

El tipo de evento que activa una alerta.

Los valores incluyen:

agente

Configuración de automatización

Backup

Conector de BI

clúster

Explorador de datos accedido

Host

Organización

Proyecto

Set de réplicas

equipo

Usuario

Para consultar la lista completa de eventos que generan alertas y sus descripciones, consulte Tipos de alerta. Para obtener una lista completa de los eventos incluidos en el registro de auditoría de Ops Manager, consulte Eventos de auditoría.

matchers.fieldName

string

Nombre del campo en el objeto de destino con el que hacer coincidir.

  • Las alertas de host admiten estos campos:

    • HOSTNAME

    • PORT

    • HOSTNAME_AND_PORT

    • REPLICA_SET_NAME

    • TYPE_NAME

  • Las alertas de sets de réplicas admiten estos campos:

    • REPLICA_SET_NAME

    • SHARD_NAME

    • CLUSTER_NAME

  • Las alertas de clúster fragmentado admiten estos campos:

    • CLUSTER_NAME

    • SHARD_NAME

Todos los demás tipos de alertas no soportan matchers.

operador de coincidentes

string

Operador para probar el valor del campo. Los valores aceptados son:

  • EQUALS

  • NOT_EQUALS

  • CONTAINS

  • NOT_CONTAINS

  • STARTS_WITH

  • ENDS_WITH

  • REGEX

matchers.value

string

Valor a probar con el operador especificado.

Si matchers.fieldName se establece en TYPE_NAME, puede coincidir con los siguientes valores:

  • PRIMARY

  • SECONDARY

  • STANDALONE

  • CONFIG

  • MONGOS

comparadores

objeto arreglo

Reglas a aplicar al cotejar un objeto con esta configuración de alerta. Solo las entidades que cumplen todas estas reglas son revisadas por una condición de alerta.

Puede filtrar utilizando solo el arreglo matchers cuando el eventTypeName especifica un evento para un host, set de réplicas o clúster.

metricThreshold.metricName

string

Nombre de la métrica a comprobar. Admite los mismos valores que el campo metricName del recurso alerts.

modo de umbral métrico

string

Configura en AVERAGE para calcular el promedio de esta métrica.

operadorUmbralMétrico

string

Operador que se aplica al comparar el valor de la métrica actual con el valor umbral. Los valores aceptados son:

  • GREATER_THAN

  • LESS_THAN

métricoUmbral.umbral

Número

Valor de umbral fuera del cual se activa una alerta.

metricThreshold.units

string

Unidades para el valor umbral. Depende del tipo de métrica.

Por ejemplo, una métrica que mide el consumo de memoria tendría una medida en bytes, mientras que una métrica que mide el tiempo tendría una unidad de tiempo.

Los valores aceptados son:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

metricThreshold

Objeto

Umbral que activará una alerta. Obligatorio si "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

notificaciones.apiToken

string

Token de API de Slack o token de Bot. Requerido si "notifications.typeName" : "SLACK". Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del Proyecto y, finalmente, removerá el token.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notificaciones.channelName

string

Nombre del canal de Slack. Obligatorio si "notifications.typeName" : "SLACK".

notificaciones.datadogApiKey

string

Clave de API de DataDog. Encontrado en el tablero de DataDog. Requerido si "notifications.typeName" : "DATADOG".

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notificaciones.Retraso mínimo

Número

Número de minutos de espera tras detectarse una condición de alerta antes de enviar la primera notificación.

notificaciones.dirección de correo electrónico

string

Dirección de correo electrónico a la que enviar la notificación. Obligatorio si "notifications.typeName" : "EMAIL".

notificaciones.emailEnabled

booleano

Determina si se deben enviar notificaciones por correo electrónico. Obligatorio si:

  • "notifications.typeName" : "GROUP"

  • "notifications.typeName" : "USER"

notificaciones.intervalMin

Número

Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.

notificaciones.webhookSecret

string

Un valor usado para autenticarse con el Webhook que acepta y reenvía la notificación. Puedes declarar explícitamente un secreto únicamente en una solicitud que tenga ambas condiciones:

  • Un notifications.typeName de WEBHOOK

  • Un explícitamente declarado notifications.webhookURL

Puede configurar un webhookSecret para un webhookURL por defecto solo en la página de Integraciones, o bien con el API.

Para declarar explícitamente un webhookURL sin un webhookSecret, omita este campo.

Después de crear una notificación de webhook, la URL está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.

notificaciones.webhookUrl

string

URL para el webhook que activa esta notificación. Si no declaras explícitamente un webhookUrl, tu solicitud utilizará el webhookUrl por defecto establecido ya sea en la página de Integraciones, o con la API de Integraciones.

Después de crear una notificación de webhook, la URL está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.

notificaciones.webhookHeadersTemplate

string

Plantilla para encabezados personalizados para incluir en las notificaciones webhook. Puedes usar variables en la plantilla que se reemplazan con valores específicos de la alerta cuando se envía la notificación.

notificaciones.webhookBodyTemplate

string

Plantilla para el contenido del cuerpo de las notificaciones de webhook. Puedes usar variables en la plantilla que se reemplazan con valores específicos de la alerta cuando se envía la notificación.

notificaciones.microsoftTeamsWebhookUrl

string

URL del webhook entrante del canal de Microsoft Teams. Requerido si "notifications.typeName" : "MICROSOFT_TEAMS".

Cuando se ve o edita la alerta de una notificación de webhook, la URL aparece parcialmente oculta y el secreto aparece completamente oculto.

notificaciones.mobileNumber

string

Número de móvil al que se enviarán mensajes SMS. Obligatorio si "notifications.typeName" : "SMS".

notificaciones.notificationToken

string

Un token de la API de HipChat. Obligatorio si "notifications.typeName" : "HIP_CHAT". Si posteriormente deja de ser válido, Ops Manager envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notificaciones.rol

string

Rol de Ops Manager en el proyecto actual. Obligatorio si "notifications.typeName" : "GROUP".

notificaciones.nombreDeLaHabitación

string

Nombre de la sala HipChat. Obligatorio si "notifications.typeName" : "HIP_CHAT".

notificaciones.serviceKey

string

Clave de integración PagerDuty. Requerido si "notifications.typeName" : "PAGER_DUTY".

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notificaciones.smsEnabled

booleano

Indica que se deben enviar notificaciones por SMS. Obligatorio si:

  • "notifications.typeName" : "GROUP"

  • "notifications.typeName" : "USER"

notificaciones.teamId

string

Identificador único de un equipo.

notificaciones.typeName

string

Tipo de notificación de alerta. Los valores aceptados son:

  • DATADOG

  • EMAIL

  • GROUP (Proyecto)

  • HIPCHAT

  • ORG

  • PAGER_DUTY

  • SLACK

  • SMS (La integración de Twilio debe estar configurada)

  • USER

  • WEBHOOK

notificaciones.nombre de usuario

string

Nombre de un usuario de Ops Manager al que enviar notificaciones. Especifique un usuario en el Proyecto que posea la configuración de alertas. Requerido si "notifications.typeName" : "USER".

notifications
Required

objeto arreglo

Notificaciones para enviar cuando se detecta una condición de alerta.

threshold.operator

string

Operador a aplicar al comparar el valor de la métrica actual con el valor del umbral.

  • GREATER_THAN

  • LESS_THAN

threshold.threshold

Número

Valor de umbral fuera del cual se activa una alerta.

límite

Objeto

Umbral que provocará la activación de una alerta. Obligatorio si:

  • "eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"

  • "eventTypeName" : TOO_MANY_UNHEALTHY_MEMBERS

Respuesta

La respuesta incluye los detalles de la configuración de la alerta:

Nota

Las configuraciones de alerta varían. Una configuración de alerta puede incluir solo un subconjunto de estos elementos.

Nombre
Tipo
Descripción

creado

string

Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se creó esta configuración de alerta.

habilitado

booleano

Indicador de que esta configuración de alerta está habilitada.

nombreDeTipoDeEvento

string

Tipo de evento que activa una alerta.

ID del grupo

string

Identificador único del Proyecto propietario de esta configuración de alerta.

ID

string

Identificador único de la configuración de la alerta.

enlaces

Arreglo de objetos

Uno o más enlaces a sub-recursos y/o recursos relacionados. Los tipos de relación entre URLs se explican en la Especificación de Vinculación Web.

comparadores

Arreglo de objetos

Reglas para aplicar al comparar un objeto con esta configuración de alerta.

matchers
.[n].fieldName

string

Nombre del campo en el objeto de destino que deseas que esta configuración coincida.

matchers
.[n].operator

string

Operador de comparación que se aplicará al comparar el valor de la métrica actual con matcher.[n].value.

matchers
.[n].value

string

Valor a igualar o superar utilizando matchers.[n].operator.

metricThreshold

Objeto

Valor y medio de comparación que activa una alerta.

metricThreshold
.metricName

string

Nombre de la métrica a comprobar. Admite los mismos valores que el campo metricName del recurso alerts.

metricThreshold
.mode

string

Valor promedio de esta métrica.

metricThreshold
.operator

string

Operador de comparación que Ops Manager aplicó al verificar el valor métrico actual contra el valor umbral.

metricThreshold
.threshold

Número

Valor de metricThreshold.metricName que, al superarse, desencadena una alerta.

metricThreshold
.units

string

Unidades de capacidad o tiempo que definen el alcance del metricThreshold.threshold.

notificaciones

Arreglo de objetos

Uno o más objetivos para que Ops Manager envíe notificaciones cuando se detecta una condición de alerta.

notifications.[n]
.apiToken

string

Token de la API de Slack. Ops Manager devuelve este valor si se establece notifications.[n].typeName en SLACK.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notifications.[n]
.channelName

string

Nombre del canal de Slack. Ops Manager devuelve este valor si estableces notifications.[n].typeName a SLACK.

notifications.[n]
.datadogApiKey

string

Clave de API de DataDog. Ops Manager devuelve este valor si estableces notifications.[n].typeName en DATADOG.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notifications.[n]
.delayMin

Número

Número de minutos de espera tras detectarse una condición de alerta antes de enviar la primera notificación.

notifications.[n]
.emailAddress

string

Dirección de correo electrónico a la que enviar la notificación. Ops Manager devuelve este valor si estableces notifications.[n].typeName en EMAIL.

notifications.[n]
.emailEnabled

booleano

Bandera que indica que se deben enviar notificaciones por correo electrónico. Ops Manager devuelve este valor si estableces notifications.[n].typeName en ORG, GROUP o USER.

notifications.[n]
.intervalMin

Número

Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.

notifications.[n]
.microsoftTeamsWebhookUrl

string

URL del webhook entrante del canal de Microsoft Teams. Ops Manager devuelve este valor si estableces notifications.[n].typeName en MICROSOFT_TEAMS.

Cuando se ve o edita la alerta de una notificación de webhook, la URL aparece parcialmente oculta y el secreto aparece completamente oculto.

notifications.[n]
.mobileNumber

string

Número de teléfono móvil al que se envían las notificaciones de alerta. Ops Manager devuelve este valor si estableces notifications.[n].typeName en SMS.

notifications.[n]
.notificationToken

string

Token de la API de HipChat. Ops Manager devuelve este valor si estableces notifications.[n].typeName en HIP_CHAT.

Si el token se vuelve inválido más adelante, MongoDB Atlas enviará un correo electrónico a Project Owner y eventualmente removerá el token.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notifications.[n]
.opsGenieApiKey

string

API de alertas de OpsGenie clave. Ops Manager devuelve este valor si se establece notifications.[n].typeName en OPS_GENIE.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notifications.[n]
.opsGenieRegion

string

Región que indica qué API URL utilizar. Ops Manager devuelve este valor si se establece notifications.[n].typeName en OPS_GENIE.

notifications.[n]
.roles

Arreglo de cadenas

Rol de administrador de operaciones en el proyecto u organización actual. El administrador de operaciones devuelve este valor si se establece notifications.[n].typeName en ORG o GROUP.

notifications.[n]
.roomName

string

Nombre de la sala de HipChat. Ops Manager devuelve este valor si "notifications.typeName" : "HIP_CHAT.

notifications.[n]
.serviceKey

string

Clave de servicio de PagerDuty. Ops Manager devuelve este valor si estableces notifications.[n].typeName en PAGER_DUTY.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notifications.[n]
.smsEnabled

booleano

Bandera que indica que deben enviarse notificaciones de texto. Ops Manager devuelve este valor si se establece notifications.[n].typeName en ORG, GROUP o USER.

notifications.[n]
.teamId

string

Identificador único del equipo que recibe esta notificación.

notifications.[n]
.teamName

string

Etiqueta para el equipo que recibe esta notificación.

notifications.[n]
.typeName

string

Medios por los cuales desea que Ops Manager le envíe una notificación de una alerta.

notifications.[n]
.username

string

Nombre de un usuario de Ops Manager al que se enviarán notificaciones. Ops Manager devuelve este valor si se establece de notifications.[n].typeName a USER.

notifications.[n]
.victorOpsApiKey

string

VictorOps API key.

Si posteriormente la clave deja de ser válida, MongoDB Atlas envía un correo electrónico a y finalmente elimina la Project Owner clave.

Ops Manager devuelve este valor si estableces notifications.[n].typeName en VICTOR_OPS.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

  • Visualiza o edita la alerta a través de la interfaz de usuario.

  • Consulta la configuración de integración de terceros a través de la API.

notifications.[n]
.victorOpsRoutingKey

string

Clave de enrutamiento de VictorOps.

Si posteriormente la clave deja de ser válida, MongoDB Atlas envía un correo electrónico a y finalmente elimina la Project Owner clave.

Ops Manager devuelve este valor si estableces notifications.[n].typeName en VICTOR_OPS.

notifications.[n]
.webhookSecret

string

Un valor utilizado para autenticar con el Webhook que acepta y reenvía la notificación.

Ops Manager devuelve este valor si establece notifications.[n].typeName en WEBHOOK y:

  • Se configuró notification.[n].webhookSecret como una string no vacía

  • Establece un valor predeterminado webhookSecret en la página Integracioneso con la API de Integraciones

Después de crear una notificación de webhook, la URL está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.

notifications.[n]
.webhookUrl

string

URL del webhook que activa esta notificación.

Ops Manager devuelve este valor si establece notifications.[n].typeName en WEBHOOK y:

  • Se configuró notification.[n].webhookURL como una string no vacía

  • Establece un valor predeterminado webhookUrl en la página Integracioneso con la API de Integraciones

Después de crear una notificación de webhook, la URL está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.

notifications.[n]
.webhookHeadersTemplate

string

Plantilla para encabezados personalizados que se incluyen en las notificaciones de webhook. Ops Manager devuelve este valor si se establece notifications.[n].typeName en WEBHOOK y se proporciona una plantilla de encabezados personalizados.

notifications.[n]
.webhookBodyTemplate

string

Plantilla para el contenido del cuerpo de las notificaciones de webhook. El Administrador de operaciones devuelve este valor si se establece notifications.[n].typeName en WEBHOOK y se proporciona una plantilla personalizada.

notifications.[n]
.id

string

Identificador único de la configuración de notificación.

límite

Objeto

Umbral que activa una alerta. Ops Manager devuelve este valor si eventTypeName es algún valor distinto de OUTSIDE_METRIC_THRESHOLD.

threshold
.operator

string

Operador de comparación que Ops Manager aplicó al verificar el valor métrico actual contra el valor umbral.

threshold
.threshold

Número

Valor que, cuando se excede, Ops Manager activa una alerta.

threshold
.units

string

Unidades de capacidad o tiempo que definen el alcance del threshold.threshold.

typeName

string

Este campo está obsoleto y se ignora.

actualizado

string

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando esta configuración de alerta se actualizó por última vez.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs" \
 --data '
   {
     "eventTypeName" : "RESYNC_REQUIRED",
     "enabled" : true,
     "notifications" : [ {
       "typeName" : "GROUP",
       "intervalMin" : 5,
       "delayMin" : 0,
       "smsEnabled" : false,
       "emailEnabled" : true
     }, {
       "typeName" : "WEBHOOK",
       "intervalMin" : 5,
       "delayMin" : 0,
       "webhookUrl" : "https://example.com/webhook",
       "webhookSecret" : "secret123",
       "webhookHeadersTemplate" : "{\"X-Alert-Type\": \"{{eventTypeName}}\"}",
       "webhookBodyTemplate" : "{\"alert\": \"{{eventTypeName}}\", \"project\": \"{{groupName}}\"}"
     } ]
   }'

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Respuesta del cuerpo

{
  "created" : "2014-04-23T14:29:18Z",
  "enabled" : true,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ ],
  "notifications" : [ {
    "id" : "{NOTIFICATION-ID-1}",
    "delayMin" : 0,
    "emailEnabled" : true,
    "intervalMin" : 5,
    "smsEnabled" : false,
    "typeName" : "GROUP"
  }, {
    "id" : "{NOTIFICATION-ID-2}",
    "delayMin" : 0,
    "intervalMin" : 5,
    "typeName" : "WEBHOOK",
    "webhookUrl" : "https://example.com/webhook",
    "webhookSecret" : "***",
    "webhookHeadersTemplate" : "{\"X-Alert-Type\": \"{{eventTypeName}}\"}",
    "webhookBodyTemplate" : "{\"alert\": \"{{eventTypeName}}\", \"project\": \"{{groupName}}\"}"
  } ],
  "updated" : "2014-04-23T14:29:18Z"
}

Volver

Obtener todo para un proyecto

Next

Obtenga uno

En esta página