Learn the "why" behind slow queries and how to fix them in our 2-Part Webinar.
Register now >
Docs Menu
Docs Home
/ /
ajustes
Docs Home
/ /
Alertas
/
ajustes
Docs Home
/
Herramientas
/
Atlas CLI
/
atlas
/
Alertas
/
ajustes

crear configuración de alertas de atlas

Cree una configuración de alerta para su proyecto.

Para usar este comando, debes autenticarte con una cuenta de usuario, una cuenta de servicio o una clave API que tenga el rol de Propietario del proyecto.

Sintaxis

Sintaxis del comando
atlas alerts settings create [options]

opciones

Nombre
Tipo
Requerido
Descripción

--apiKey

string

false

Clave API de Datadog, Clave API de Opsgenie o clave API de VictorOps. Obligatorio si notificationType es DATADOG, OPS_GENIE o VICTOR_OPS, respectivamente.

--enabled

false

Bandera que indica si se debe habilitar la configuración de alerta.

--event

string

false

Tipo de evento que activó la alerta. Para saber qué valores acepta la CLI, consulta el Enum para eventTypeName en la especificación de Admin API de Atlas: https://dochub.mongodb.org/core/atlas-event-names.

-f, --file

string

false

Ruta al archivo de configuración JSON que define la configuración de alertas. Nota: Se omiten los campos no admitidos en el archivo JSON. Para conocer más sobre los archivos de configuración de alertas para la CLI de Atlas, consulta https://dochub.mongodb.org/core/alert-config-atlas-cli.

-h, --help

false

ayuda para crear

--matcherFieldName

string

false

Nombre del campo del objeto de destino para hacer la coincidencia. Para aprender los valores válidos, ejecuta atlas alerts settings campos type.

--matcherOperator

string

false

Operador de comparación que se aplica al comparar la métrica actual con matcherValue. Los valores válidos son CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX y STARTS_WITH.

--matcherValue

string

false

Valor para probar con el operador especificado. Si matcherFieldName se establece como TYPE_NAME, puedes hacer coincidir los siguientes valores: CONFIG, MONGOS, primario, secundario, autónomo.

--metricMode

string

false

Opción que indica si Atlas calcula el valor actual de la métrica como un promedio. El valor válido es AVERAGE.

--metricName

string

false

Nombre de la métrica contra la cual este comando verifica la alerta configurada. Para aprender los valores válidos, consulta https://dochub.mongodb.org/core/alert-host-metrics-atlas. Esta opción solo se aplica si el evento está configurado en OUTSIDE_METRIC_THRESHOLD.

--metricOperator

string

false

Operador de comparación a aplicar al verificar el valor actual del métrico. Los valores válidos son LESS_THAN y GREATER_THAN.

--metricThreshold

float

false

Valor de umbral fuera del cual se activará una alerta.

--metricUnits

string

false

Unidades para el valor umbral. Los valores válidos son BITS, BYTES, DÍAS, GIGABITS, GIGABYTES, HORAS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILISEGUNDOS, MINUTOS, PETABYTES, RAW, SEGUNDOS, TERABYTES.

--notificationChannelName

string

false

Nombre del canal de Slack. Es requerido para el tipo de notificaciones SLACK.

--notificationDelayMin

Int

false

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

--notificationEmailAddress

string

false

Dirección de correo electrónico a la que se envían las notificaciones de alerta.

--notificationEmailEnabled

false

Bandera que habilita las notificaciones por correo electrónico. Configurable para los tipos de notificación GROUP y USER.

--notificationIntervalMin

Int

false

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

--notificationMobileNumber

string

false

Número móvil al que se envían las notificaciones de alerta.

--notificationRegion

string

false

Región que indica qué URL de API se debe usar.

--notificationRole

Cuerdas

false

Lista que contiene uno o más roles de organización o proyecto que reciben la alerta configurada.

--notificationServiceKey

string

false

Clave de servicio de PagerDuty.

--notificationSmsEnabled

false

Indicador que habilita las notificaciones por mensaje de texto.

--notificationTeamId

string

false

Identificador único de un equipo.

--notificationToken

string

false

Slack API token, or Bot token.

--notificationType

string

false

Tipo de notificación de alerta. Los valores válidos son DATADOG, EMAIL, GROUP (Proyecto), MICROSOFT_TEAMS, ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, TEAM, USER, VICTOR_OPS o WEBHOOK.

--notificationUsername

string

false

Nombre del usuario de Atlas al que enviar notificaciones.

--notificationVictorOpsRoutingKey

string

false

Clave de enrutamiento asociada a tu cuenta de Splunk On-Call.

--notificationWebhookSecret

string

false

Secreto de autenticación para una alerta basada en webhook.

--notificationWebhookUrl

string

false

URL de destino para una alerta basada en webhook o una alerta de Microsoft Teams.

-o, --output

string

false

Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json.

--projectId

string

false

string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno.

Opciones heredadas

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Salida

Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.

Alert configuration <Id> created.

Ejemplos

# Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
atlas alerts settings create --event JOINED_GROUP --enabled \
--notificationType USER --notificationEmailEnabled \
--notificationIntervalMin 60 --notificationUsername john@example.com \
--output json --projectId 5df90590f10fab5e33de2305
# Create alert using json file containing alert configuration
atlas alerts settings create 5d1113b25a115342acc2d1aa --file alerts.json
# Create an alert that shows possible connection storms based on the number of connections
atlas alerts settings create --event OUTSIDE_METRIC_THRESHOLD --metricName CONNECTIONS --metricOperator LESS_THAN --metricThreshold 1 --metricUnits RAW --projectId 5df90590f10fab5e33de2305 --notificationType GROUP --notificationEmailEnabled --notificationIntervalMin 5 --enabled

Volver

ajustes

Next

borrar

En esta página