Arquivo de configuração de alerta

Nesta página

Definições de configuração de alerta

Exemplo de arquivo de configuração de alerta
Exemplo de comandos de configuração de alerta

Você pode utilizar um arquivo de configuração para especificar as configurações para criar ou atualizar uma configuração de alerta através do Atlas CLI. O Atlas CLI aceita arquivos de configuração .json .

Definições de configuração de alerta

Dependendo do tipo de configuração de alerta, você pode especificar as seguintes configurações para criar ou atualizar uma configuração de alerta em um arquivo de configuração:

Campo	Tipo	Descrição
`enabled`	booleano	Sinalizador que indica se alguém habilitou esta configuração de alerta para o projeto especificado.
`eventTypeName`	string	Obrigatório. Tipo de evento Atlas Triggers um alerta.
`matchers`	Array de objetos	Regras a serem aplicadas ao corresponder um objeto a essa configuração de alerta. Você pode usar esse campo somente se o `eventTypeName` especificar um evento para um host, conjunto de réplicas ou cluster fragmentado.
`metricThreshold`	objeto	Limite para a métrica que, quando excedido, aciona um alerta. Você pode usar este campo somente se o `eventTypeName` refletir uma alteração na medida ou métrica.
`notifications`	Array de objetos	Lista que contém os destinos para os quais o Atlas envia notificações.
`threshold`	objeto	Um limite que Atlas Triggers um alerta quando excedido.

Para obter descrições detalhadas e uma lista completa das configurações disponíveis, consulte o esquema do corpo da solicitação na especificação da API:

Exemplo de arquivo de configuração de alerta

Para criar ou atualizar uma configuração de alerta, especifique os campos que deseja incluir no arquivo de configuração. Por exemplo, o arquivo de amostra abaixo ativa uma configuração de alerta que o notifica quando um conjunto de réplicas chamado event-replica-set perde seu nó primário:

{
  "enabled": true,
  "eventTypeName": "NO_PRIMARY",
  "matchers": [
    {
      "fieldName": "REPLICA_SET_NAME",
      "operator": "EQUALS",
      "value": "event-replica-set"
    }
  ],
  "notifications": [
    {
      "datadogApiKey": "****************************a23c",
      "datadogRegion": "US",
      "delayMin": 0,
      "intervalMin": 5,
      "notifierId": "6462742adc47d365036da07c",
      "typeName": "DATADOG"
    }
  ],
  "threshold": {
    "operator": "<",
    "threshold": 0,
    "units": "bits"
  }
}

Exemplo de comandos de configuração de alerta

Após criar o arquivo, execute o comando Atlas CLI para criar ou atualizar a configuração de alerta.

Criar uma configuração de alerta

Para criar uma configuração de alerta, especifique a opção --flag e o caminho para o arquivo. O exemplo a seguir cria uma configuração de alerta utilizando um arquivo de configuração denominado alert-config.json:

atlas alerts settings create --file /alert-config.json

Atualizar uma configuração de alerta

Para atualizar uma configuração de alerta, especifique o ID da configuração de alerta que você deseja atualizar, a opção --flag e o caminho para o arquivo. O exemplo a seguir atualiza uma configuração de alerta existente usando um arquivo de configuração chamado alert-config.json:

atlas alerts settings update <alertConfigId> --file /alert-config.json

Voltar

Arquivo On-line

Solução de problemas