Documentação do Oracle Cloud Infrastructure

Usando Variáveis Dinâmicas em Mensagens de Alarme

Atualize um alarme no serviço Monitoring para incluir valores de parâmetros de mensagem de alarme em mensagens.

Consulte também Criando um Alarme Básico.

Como as Variáveis Dinâmicas São Renderizadas

Observação

Insira variáveis dinâmicas que respeitem o tamanho máximo de todos os casos de uso suportados. Variáveis dinâmicas que excedem o máximo são consideradas inválidas. Por exemplo, considere uma variável dinâmica para uso em title. Um caso de uso suportado para title é uma linha de assunto de e-mail, com no máximo 250 caracteres. Nesse caso, a variável dinâmica de um nome de recurso ({{dimensions.<dimension-name>}}) é inválida porque tem 256 caracteres e, portanto, excede o máximo.

O valor de um parâmetro de mensagem de alarme é renderizado em uma mensagem de alarme quando você insere a variável dinâmica associada em campos suportados. Por exemplo, insira o seguinte como o corpo do alarme:

{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Na imagem a seguir de uma mensagem de alarme, o corpo do alarme (Corpo) é renderizado como: alarme CRÍTICO acionado porque o limite foi violado em decorrência de [CpuUtilization[1m].mean():92] em 2023-08-15T19:51:00Z

Exemplo de variáveis dinâmicas renderizadas em uma mensagem de e-mail formatada.

As variáveis dinâmicas são exibidas nas notificações que contêm elementos do corpo.

  • Se houver dados disponíveis para uma variável dinâmica, a variável será resolvida e os dados serão exibidos em seu lugar. O exemplo anterior de mensagem de alarme mostra [CpuUtilization[1m].mean():92] no lugar da variável dinâmica {{metricValues}}.
  • Se nenhum dado estiver disponível para uma variável dinâmica, a variável não será resolvida e será exibida como codificada. Por exemplo, se nenhum valor de métrica estiver disponível para a variável dinâmica {{metricValues}}, como quando o alarme está no estado OK, a variável dinâmica {{metricValues}} aparecerá na mensagem de alarme.
  • Como as mensagens SMS não têm elementos de corpo, as variáveis dinâmicas não são resolvidas.

Procurando Variáveis Dinâmicas

Para procurar uma variável dinâmica para um parâmetro, consulte Variáveis Dinâmicas.

    1. Na página de lista Definições de Alarme, selecione o alarme com o qual deseja trabalhar. Se precisar de ajuda para localizar a página da lista ou o alarme, consulte Listando Alarmes.
    2. Vá para Ações e selecione Editar alarme.
    3. Na página Editar alarme, localize o campo ao qual você deseja adicionar variáveis dinâmicas.
      • Corpo do alarme (parâmetro da mensagem de alarme body): Renderizado como um campo dentro do corpo da mensagem de alarme.
      • Resumo do alarme (parâmetro da mensagem de alarme alarmSummary): Renderizado como um campo dentro do corpo da mensagem de alarme.
      • Assunto de notificação (parâmetro de mensagem de alarme title): A renderização depende do tipo de mensagem. Para uma mensagem de e-mail formatada, é renderizada como a linha de assunto. Para uma mensagem do Slack, é renderizado como o título. Para uma mensagem SMS, é renderizada como parte da mensagem.
        Observação

        Insira variáveis dinâmicas que respeitem o tamanho máximo de todos os casos de uso suportados. Variáveis dinâmicas que excedem o máximo são consideradas inválidas. Por exemplo, considere uma variável dinâmica para uso em title. Um caso de uso suportado para title é uma linha de assunto de e-mail, com no máximo 250 caracteres. Nesse caso, a variável dinâmica de um nome de recurso ({{dimensions.<dimension-name>}}) é inválida porque tem 256 caracteres e, portanto, excede o máximo.

      Para obter informações sobre a aparência padrão desses parâmetros de mensagem de alarme em mensagens formatadas, consulte Formato de Mensagem de Alarme.

    4. Insira variáveis dinâmicas para os parâmetros de mensagem de alarme desejados.

      Exemplo com variáveis dinâmicas:

      {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

      Para procurar variáveis dinâmicas de um parâmetro, consulte Variáveis Dinâmicas.

      Você pode desativar o escape HTML usando a variável dinâmica mais longa para um parâmetro de alarme. Por exemplo, para renderizar o valor do parâmetro query na mensagem de alarme com escape HTML desativado, informe a variável dinâmica {{{query}}}.

    5. Selecione Salvar alarme.

  • Use o comando oci monitoring alarm update e os parâmetros obrigatórios para atualizar um alarme para usar variáveis dinâmicas no campo que você deseja:

    oci monitoring alarm update --alarm-summary <text-including-dynamic-variables> --body <text-including-dynamic-variables> --notification-title <text-including-dynamic-variables> [...]

    Com quebras de linha:

    oci monitoring alarm update 
--alarm-summary <text-including-dynamic-variables> 
--body <text-including-dynamic-variables> 
--notification-title <text-including-dynamic-variables> [...]

    Para obter uma lista completa de parâmetros e valores para comandos CLI, consulte a Referência de Linha de Comandos para Monitoramento.

  • Execute a operação UpdateAlarm para atualizar um alarme e usar a opção de formato de mensagem desejada.

    Ao definir detalhes para UpdateAlarmDetails, defina o campo que você deseja (alarmSummary, body ou notificationTitle) como o texto que você deseja, incluindo variáveis dinâmicas.