Menu Docs

Página inicial do Docs → Iniciar e gerenciar o MongoDB → MongoDB CLI

criar configuração de alerta do mongocli Cloud Manager

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Crie uma configuração de alerta para seu projeto.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.

Sintaxe

Sintaxe do comando
mongocli cloud-manager alerts settings create [options]

Opções

Nome
Tipo
Obrigatório
Descrição
--apiKey
string
false
Chave de API Datadog, chave de API Opsgenie ou chave de API VictorOps. Obrigatório se o notificationType for DATADOG, OPS_GENIE ou VICTOR_OPS, respectivamente.
--enabled
false
Sinalizador que indica se a configuração de alerta deve ser habilitada.
--event
string
false
Tipo de evento que acionou o alerta. Para saber quais valores a CLI aceita, consulte os possíveis valores de eventTypeName na documentação da API para o Atlas (https://dochub.mongodb.org/core/atlas-event-names), gerente de operações (https://dochub.mongodb.org/core/om-event-names) ou Cloud Manager (https://dochub.mongodb.org/core/cm-event-names).
-h, --ajuda
false
ajuda para criar
--matcherFieldName
string
false
Nome do campo no objeto de destino a ser correspondido. Para saber os valores válidos, execute o campo de configurações de alerta do Atlas mongocli.
--matcherOperator
string
false
Operador de comparação a ser aplicado ao verificar a métrica atual em relação amatcherValue. Os valores válidos são Contains, Ends_WITH, Equals, not_contains, not_equals, regex, StartS_WITH.
--matcherValue
string
false
Valor para testar com o operador especificado. Se o matcherFieldName for definido como TYPE_NAME, você poderá fazer a correspondência com os seguintes valores: CONFIG, Mongo, PRIMARY, SECONDARY, autônomo.
--metricMode
string
false
Opção que indica se o Atlas calcula o valor da métrica atual como uma média. O valor válido é AVERAGE.
--metricName
string
false
Nome da métrica em relação à qual este comando verifica o alerta configurado. Para saber os valores válidos, consulte https://dochub.mongodb.org/core/alert-host-metrics-atlas. Esta opção se aplica somente se o evento estiver definido comoOUTSIDE_METRIC_THRESHOLD.
--metricOperator
string
false
Operador de comparação a ser aplicado ao verificar o valor da métrica atual. Os valores válidos são LESS_TANA e GREATER_TANA.
--metricThreshold
flutuar
false
Valor limite fora do qual um alerta será acionado.
--metricUnits
string
false
Unidades para o valor limite. Os valores válidos são BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MUSEBITS, MEABYTES, MILLISECONDS, MINUTES, petabytes, CRW, SECONDS, TERABYTES.
--notificationChannelName
string
false
Nome do canal do Slack. Necessário para o tipo de notificações Slack.
--notificationDelayMin
int
false
Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação.
--notificationEmailAddress
string
false
Endereço de e-mail para o qual as notificações de alerta são enviadas.
--notificationEmailEnabled
false
Sinalizador que habilita notificações por e-mail. Configurável para tipos de notificação GRUPO e USUÁRIO.
--notificationIntervalMin
int
false
Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.
--notificationMobileNumber
string
false
Número de celular para o qual as notificações de alerta são enviadas.
--notificationRegion
string
false
Região que indica qual URL da API usar.
--notificationServiceKey
string
false
Chave de serviço PagerDuty.
--notificationSmsEnabled
false
Sinalizador que habilita as notificações de mensagens de texto.
--notificationTeamId
string
false
Identificador único de uma equipe.
--notificationToken
string
false
Token de API do Slack ou token de Bot.
--notificationType
string
false
Tipo de notificação de alerta. Os valores válidos são DATADOG, E-mail, GROUP (Project), ORG, OPS_GENIE, PAGER_DUTY, Slack, SMS, USER ou VICTOR_OPS.
--notificationUsername
string
false
Nome do Atlas user para o qual enviar notificações.
--notificationVictorOpsRoutingKey
string
false
Chave de roteamento associada à sua conta Splunk On-Call.
-o, --output
string
false
Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.
--projectId
string
false
String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

Opções herdadas

Nome
Tipo
Obrigatório
Descrição
-P, --profile
string
false
Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Saída

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

Alert configuration <ID> created.

Exemplos

# Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
mongocli atlas alerts settings create --event JOINED_GROUP --enabled \
--notificationType USER --notificationEmailEnabled \
--notificationUsername john@example.com \
--output json --projectId 5df90590f10fab5e33de2305
← configurações de alerta do mongocli Cloud Manager
configurações de alertas do mongocli cloud-manager excluídas →

Nesta página