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
/ /

Crear una configuración de alerta global

Cree una configuración global de alerta.

Puede llamar correctamente a este punto final con cualquiera de los siguientes roles asignados:

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

POST /globalAlertConfigs

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

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

Body Parameter
Tipo
Necesidad
Descripción

enabled

booleano

Opcional

Palanca que especifica si la configuración de alerta está habilitada.

eventTypeName

string

Requerido

Tipo de evento para el cual esta configuración de alerta activa una alerta.

Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas.

Para obtener una lista completa de los eventos incluidos en el registro de auditoría del Ops Manager, consulte Eventos de Auditoría.

forAllGroups

booleano

Requerido

Alterna que especifica si la configuración global de alertas se aplica a todos los grupos. También afecta si puedes usar el arreglo tags para orientar la configuración a grupos específicos.

Si true, la configuración aplica a todos los grupos. Puedes orientar la configuración de alertas a grupos específicos a través del tags arreglo.

Si false, la configuración solo se aplica a los grupos especificados en el arreglo groupIds. Se debe especificar al menos un proyecto en el arreglo groupIds. No puedes utilizar el arreglo tags para esta configuración de alerta.

groupIds

Arreglo de cadenas

Opcional

Ids de los grupos a los cuales se aplica esta configuración de alerta. Este campo solo se aplica si forAllGroups está configurado en false.

matchers

Arreglo de objetos

Condicional

Reglas a aplicar al comparar un objeto con esta configuración global de alertas. Ops Manager solo comprueba las entidades que coinciden con todas estas reglas para 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.

matchers
.fieldName

string

Condicional

Nombre del campo en el objeto de destino en el que 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.

matchers
.operator

string

Condicional

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

Condicional

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

metricThreshold

Objeto

Condicional

Umbral que activa esta configuración de alerta. Solo es necesario si eventTypeName está configurado en OUTSIDE_METRIC_THRESHOLD.

metricThreshold
.metricName

string

Condicional

Nombre de la métrica a comprobar. Admite los mismos valores que el campo metricName del recurso globalAlerts. Para obtener una lista de valores posibles, consulta Tipos de medición para alertas globales.

metricThreshold
.mode

string

Condicional

Esto se establece en AVERAGE y calcula el valor métrico actual como un promedio.

metricThreshold
.operator

string

Condicional

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

  • GREATER_THAN

  • LESS_THAN

metricThreshold
.threshold

Número

Condicional

Valor umbral fuera del cual esta configuración de alerta activa una alerta.

metricThreshold
.units

string

Condicional

Unidades para metricThreshold.threshold. Las unidades dependen del tipo de métrica.

Los valores aceptados son:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Por ejemplo, una métrica que mide el consumo de memoria puede usar BYTES, mientras que una métrica que mide el tiempo puede usar HOURS.

notifications

Arreglo de objetos

Requerido

Notificaciones que Ops Manager envía cuando detecta una alerta que esta configuración de alerta describe.

notifications
.apiToken

string

Condicional

Token de API de Slack o token de Bot. Sólo aceptado para notificaciones SLACK. Si el token luego se vuelve inválido, Ops Manager envía un correo electrónico al propietario del proyecto y remueve el token.

notifications
.channelName

string

Condicional

Nombre del canal de Slack. Solo aceptado para notificaciones de SLACK.

notifications
.delayMin

Número

Condicional

Número de minutos que se debe esperar después de que se detecte una condición de alerta antes de que Ops Manager envíe la primera notificación.

notifications
.emailAddress

Condicional

Opcional

Dirección de correo electrónico para enviar notificaciones. Solo se acepta para EMAIL notificaciones.

notifications
.emailEnabled

booleano

Condicional

Cambiar especificar si Ops Manager envía notificaciones por correo electrónico. Solo se aceptan para GROUP y USER notificaciones.

notifications
.intervalMin

Número

Condicional

Número de minutos que se deben esperar entre notificaciones sucesivas para alertas no reconocidas y no resueltas que esta configuración de alerta activa.

notifications
.webhookSecret

string

Condicional

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

Puedes configurar un webhookSecret para un webhookURL por defecto solo desde la consola de administración.

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

notifications
.webhookUrl

string

Opcional

URL del webhook que activa estas notificaciones. Si no declaras explícitamente un webhookUrl, tu solicitud utilizará el webhookUrl predeterminado establecido en la Consola de administración.

notifications
.webhookHeadersTemplate

string

Opcional

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.

notifications
.webhookBodyTemplate

string

Opcional

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.

notifications
.microsoftTeamsWebhookUrl

string

Condicional

URL de webhook entrante del canal Microsoft Teams. Solo se acepta para notificaciones MICROSOFT_TEAMS.

notifications
.notificationToken

string

Condicional

Token de la API de HipChat. Solo se acepta para HIP_CHAT notificaciones. Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del proyecto y removerá el token.

notifications
.roomName

string

Condicional

Nombre del cuarto de HipChat. Sólo aceptado para notificaciones de HIP_CHAT.

notifications
.serviceKey

string

Condicional

Clave de integración de PagerDuty. Sólo aceptado para notificaciones PAGER_DUTY. Si la clave se vuelve inválida más tarde, Ops Manager enviará un correo electrónico al propietario del proyecto y removerá la clave.

Todas las nuevas claves de PagerDuty utilizan su Events API v2. Si tienes una llave API de Eventos v1, puedes seguir utilizándola con Ops Manager.

notifications
.smsEnabled

booleano

Condicional

Alternar la especificación de si Ops Manager envía notificaciones por SMS. Solo se acepta para notificaciones GROUP y USER.

notifications
.typeName

string

Requerido

Tipo de notificación de alerta que activa esta configuración. Los valores aceptados son:

  • ADMIN

  • GROUP

  • USER

  • EMAIL

  • SMS (Disponible solo si Ops Manager está configurado para la integración de Twilio.)

  • HIPCHAT

  • SLACK

  • PAGER_DUTY

notifications
.username

string

Condicional

Nombre del usuario de Ops Manager a quien se deben enviar las notificaciones. Solo está presente para USER notificaciones.

threshold

Objeto

Condicional

Umbral que hace que esta configuración de alerta active una alerta. Solo es requerido si eventTypeName se establece en uno de los siguientes valores:

  • TOO_FEW_HEALTHY_MEMBERS

  • TOO_MANY_UNHEALTHY_MEMBERS

threshold
.operator

string

Condicional

Operador a aplicar al comprobar el valor de la métrica actual respecto a threshold.threshold. Los valores aceptados son:

  • GREATER_THAN

  • LESS_THAN

threshold
.threshold

Número

Condicional

Valor umbral fuera del cual esta configuración de alerta activa una alerta.

tags

Arreglo de cadenas

Opcional

Etiquetas asociadas con esta configuración de alerta.

typeName

string

Opcional

Este campo está obsoleto y será ignorado.

Nombre
Tipo
Descripción

created

string

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

enabled

booleano

Palanca que especifica si la configuración de alerta está habilitada.

eventTypeName

string

Tipo de evento para el cual esta configuración de alerta activa una alerta.

Para revisar los tipos de eventos que generan alertas, consulta Tipos de Alertas.

Para obtener una lista completa de los eventos incluidos en el registro de auditoría del Ops Manager, consulte Eventos de Auditoría.

forAllGroups

booleano

Alterna que especifica si la configuración global de alertas se aplica a todos los grupos. También afecta si puedes usar el arreglo tags para orientar la configuración a grupos específicos.

Si true, la configuración aplica a todos los grupos. Puedes orientar la configuración de alertas a grupos específicos a través del tags arreglo.

Si false, la configuración solo se aplica a los grupos especificados en el arreglo groupIds. Se debe especificar al menos un proyecto en el arreglo groupIds. No puedes utilizar el arreglo tags para esta configuración de alerta.

groupIds

Arreglo de cadenas

Ids de los grupos a los cuales se aplica esta configuración de alerta. Este campo solo se aplica si forAllGroups está configurado en false.

id

string

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

matchers

Arreglo de objetos

Reglas a aplicar al comparar un objeto con esta configuración global de alertas. Ops Manager solo comprueba las entidades que coinciden con todas estas reglas para 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.

matchers.fieldName

string

Nombre del campo en el objeto de destino en el que 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.

matchers.operator

string

Operador para probar el valor del campo. Los valores posibles 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

metricThreshold

Objeto

Umbral que hace que esta configuración de alerta active una alerta. Solo está presente si eventTypeName se establece en OUTSIDE_METRIC_THRESHOLD.

metricThreshold.metricName

string

Nombre de la métrica a comprobar. Admite los mismos valores que el campo metricName del recurso globalAlerts. Para obtener una lista de valores posibles, consulta Tipos de medición para alertas globales.

metricThreshold.mode

string

Esto se establece en AVERAGE y calcula el valor métrico actual como un promedio.

metricThreshold.operator

string

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

  • GREATER_THAN

  • LESS_THAN

metricThreshold.threshold

Número

Valor umbral fuera del cual esta configuración de alerta activa una alerta.

metricThreshold.units

string

Unidades para metricThreshold.threshold. Las unidades dependen del tipo de métrica.

Los valores aceptados son:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Por ejemplo, una métrica que mide el consumo de memoria puede usar BYTES, mientras que una métrica que mide el tiempo puede usar HOURS.

notifications

Arreglo de objetos

Notificaciones que Ops Manager envía cuando detecta una alerta que esta configuración de alerta describe.

notifications.apiToken

string

Token de API de Slack o token de Bot. Solo presente para SLACK notificaciones. Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del proyecto y 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.channelName

string

Nombre del canal de Slack. Solo presente para SLACK notificaciones.

notifications.delayMin

Número

Número de minutos que se debe esperar después de que se detecte una condición de alerta antes de que Ops Manager envíe la primera notificación.

notifications.emailAddress

string

Dirección de correo electrónico para enviar notificaciones. Solo se muestra para EMAIL notificaciones.

notifications.emailEnabled

booleano

Activa o desactiva la opción para especificar si Ops Manager envía notificaciones por correo electrónico. Solo está presente para las notificaciones GROUP y USER.

notifications.intervalMin

Número

Número de minutos que se deben esperar entre notificaciones sucesivas para alertas no reconocidas y no resueltas que esta configuración de alerta activa.

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

  • Se establece un(a) webhookSecret por defecto en la Consola de Administración.

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 webhookUrl predeterminado en la página de la Consola de administración.

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.

notifications.microsoftTeamsWebhookUrl

string

URL de webhook entrante del canal Microsoft Teams. Solo presente para notificaciones 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.notificationToken

string

Token de la API de HipChat. Solo presente para HIP_CHAT notificaciones. Si el token posteriormente se vuelve inválido, Ops Manager enviará un correo electrónico al propietario del proyecto y 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.roomName

string

Nombre de la sala de HipChat. Solo estará presente para las notificaciones HIP_CHAT.

notifications.serviceKey

string

Clave de integración de PagerDuty. Solo presente para notificaciones de PAGER_DUTY. Si la clave se vuelve inválida más tarde, Ops Manager enviará un correo electrónico al propietario del proyecto y removerá la clave.

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.smsEnabled

booleano

Activa o desactiva la indicación de si Ops Manager envía notificaciones por SMS. Solo presente para notificaciones de GROUP y USER.

notifications.typeName

string

Tipo de notificación de alerta que activa esta configuración de alerta. Los valores posibles son:

  • ADMIN

  • GROUP

  • USER

  • EMAIL

  • SMS (Disponible solo si Ops Manager está configurado para la integración de Twilio.)

  • HIPCHAT

  • SLACK

  • PAGER_DUTY

notifications.username

string

Nombre del usuario de Ops Manager a quien se deben enviar las notificaciones. Solo está presente para USER notificaciones.

threshold

Objeto

Umbral que hace que esta configuración de alerta active una alerta. Solo está presente si eventTypeName tiene uno de los siguientes valores:

  • TOO_FEW_HEALTHY_MEMBERS

  • TOO_MANY_UNHEALTHY_MEMBERS

threshold.operator

string

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

  • GREATER_THAN

  • LESS_THAN

threshold.threshold

Número

Valor umbral fuera del cual esta configuración de alerta activa una alerta.

tags

Arreglo de cadenas

Etiquetas asociadas con esta configuración de alerta.

typeName

string

Este campo está obsoleto y será ignorado.

updated

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.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs \
6 --data '{
7 "enabled": true,
8 "eventTypeName": "BACKUP_AGENT_DOWN",
9 "forAllGroups": true,
10 "groupIds": [],
11 "matchers": [],
12 "notifications": [
13 {
14 "delayMin": 0,
15 "intervalMin": 60,
16 "typeName": "ADMIN"
17 },
18 {
19 "delayMin": 0,
20 "intervalMin": 60,
21 "typeName": "WEBHOOK",
22 "webhookUrl": "https://example.com/webhook",
23 "webhookSecret": "secret123",
24 "webhookHeadersTemplate": "{\"X-Alert-Type\": \"{{eventTypeName}}\"}",
25 "webhookBodyTemplate": "{\"alert\": \"{{eventTypeName}}\", \"type\": \"{{typeName}}\"}"
26 }
27 ],
28 "tags": [],
29 "typeName": "AGENT"
30 }
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 201 Created
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}
1{
2 "created": "2019-10-02T12:34:04Z",
3 "enabled": true,
4 "eventTypeName": "BACKUP_AGENT_DOWN",
5 "forAllGroups": true,
6 "groupIds": [],
7 "id": "{GLOBAL-ALERT-CONFIG-ID}",
8 "links": [
9 ],
10 "matchers": [],
11 "notifications": [
12 {
13 "id": "{NOTIFICATION-ID-1}",
14 "delayMin": 0,
15 "intervalMin": 60,
16 "typeName": "ADMIN"
17 },
18 {
19 "id": "{NOTIFICATION-ID-2}",
20 "delayMin": 0,
21 "intervalMin": 60,
22 "typeName": "WEBHOOK",
23 "webhookUrl": "https://example.com/webhook",
24 "webhookSecret": "***",
25 "webhookHeadersTemplate": "{\"X-Alert-Type\": \"{{eventTypeName}}\"}",
26 "webhookBodyTemplate": "{\"alert\": \"{{eventTypeName}}\", \"type\": \"{{typeName}}\"}"
27 }
28 ],
29 "tags": [],
30 "typeName": "AGENT",
31 "updated": "2019-10-02T12:34:04Z"
32}

Volver

Obtenga uno

En esta página