Formato de Mensagem de Alarme

Procure parâmetros que aparecem em mensagens de alarme enviadas pelo serviço Monitoring. Revise descrições de parâmetros e valores de exemplo, variáveis dinâmicas e aparência padrão em mensagens formatadas.

Os parâmetros são listados na ordem em que aparecem nos formatos bonito JSON e bruto de mensagens de e-mail.

Parâmetros em Mensagens de Alarme

As tabelas a seguir descrevem parâmetros em mensagens de alarme e fornecem valores de exemplo.

alarme

Parâmetro de alarme Descrição e valor de exemplo
dedupekey

string

Identificador exclusivo do alarme (mensagem agrupada) ou do stream de métrica no alarme (mensagem dividida).

Valor de exemplo: exampleuniqueid

Comentários sobre uso:

Para mensagens agrupadas (notificationType: Group notifications across metric streams), use dedupekey para agrupar mensagens pertencentes ao mesmo alarme.

Para mensagens divididas (notificationType: Split messages per metric stream), use dedupekey para agrupar mensagens pertencentes ao mesmo alarme e ao mesmo stream de métrica.

Para deduplicar várias ocorrências da mesma mensagem, use dedupekey e timestamp juntos.

title

string

O título da notificação do alarme (Assunto de notificação no formulário da Console para criar e atualizar alarmes). Se não for especificado, o nome para exibição do alarme será usado.

Valor de exemplo usando variáveis dinâmicas: {{severity}} alarm triggered at {{timestamp}}

Valor de exemplo (nome para exibição do alarme): High CPU Utilization

body

string

O corpo da mensagem configurado do alarme (Corpo do alarme no form da Console para criar e atualizar alarmes). Nulo se não for especificado.

Valor de exemplo usando variáveis dinâmicas: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Valor de exemplo (texto): Follow runbook at http://example.com/runbooks

type

string

O motivo para enviar a mensagem de notificação.

Valores válidos: Consulte Tipos de Mensagem.

Valor de exemplo: OK_TO_FIRING

severity

string

O nível de gravidade mais alto dos alarmes listados.

Valores válidos: CRITICAL, ERROR, WARNING e INFO

timestampEpochMillis

longo

O timestamp da avaliação, em milissegundos desde o horário da época.

Exemplo de valor: 1684337663852

timestamp

string

O timestamp de avaliação, no formato ISO-8601.

Valor de exemplo: 2023-05-17T15:34:23.852Z

alarmMetaData

matriz de objetos

Lista de alarmes relacionados a esta mensagem de notificação.

Por exemplo, valores, consulte parâmetros filhos na tabela a seguir, Metadados de Alarme.

version

int

A versão do formato da mensagem de alarme.

Exemplo de valor: 1.5

Metadados do Alarme

Parâmetro de alarme Descrição e valor de exemplo
id

string

O alarme OCID .

Valor de exemplo: ocid1.alarm.oc1..exampleuniqueID

status

string

Estado do alarme.

Valores válidos: OK, FIRING

severity

string

O nível de gravidade do alarme.

Valores válidos: CRITICAL, ERROR, WARNING, INFO

namespace

string

O namespace de métricas.

Valor de exemplo: oci_computeagent

query

string

A consulta configurada do alarme ou a expressão MQL.

Valor de exemplo: CpuUtilization[1m].mean() > 90

totalMetricsFiring

int

O número de streams de métricas representados nesta mensagem de notificação.

Exemplo de valor: 3

dimensions

matriz de objetos

Lista de pares de chave/valor da dimensão que identificam cada stream de métrica. A lista é limitada a cem entradas.

Exemplo de valor:

{ "instancePoolId": "Default", "resourceDisplayname": "oke-0", "faultDomain": "FAULT-DOMAIN-1", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-2", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-2", "faultDomain": "FAULT-DOMAIN-3", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-1", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-1", "faultDomain": "FAULT-DOMAIN-2", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-3", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }
metricValues

matriz de objetos

Lista de valores de métrica para pares de chave/valor de dimensão (streams de métrica). A lista é limitada a cem entradas.

Exemplo de valor:

[{"CpuUtilization[1m].mean()":"92"},{"CpuUtilization[1m].mean()":"95"},{"CpuUtilization[1m].mean()":"93"}]
alarmUrl

string

Link para a página de detalhes do alarme na Console.

Valor de exemplo: https://cloud.oracle.com/monitoring/alarms/ocid1.alarm.oc1.iad.exampleuniqueid?region=us-ashburn-1

alarmSummary

string

O resumo do alarme configurado (Resumo do alarme no form da Console para criar e atualizar alarmes). Se não estiver configurado, será usada uma mensagem gerada pelo sistema que resume o estado.

Valor de exemplo usando variáveis dinâmicas: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

O conteúdo da mensagem gerada pelo sistema (usado quando o resumo do alarme não está configurado) depende de notificationType:

  • Para Grouped messages across metric streams:

    Alarm <alarm-name> is in a <alarm-state> state; because <number-of-metric-streams> metrics meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>

    Exemplo:

    Alarm High CPU Utilization is in a FIRING state; because 4 metrics meet the trigger rule: CpuUtilization[1m].mean() >90, with a trigger delay of 1 minute
  • Para Split messages per metric stream:

    Alarm <alarm-name> is in a <alarm-state> state; because the resources with dimensions listed below meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>
notificationType

string

Tipo de notificação (agrupada ou dividida).

Valores válidos: Grouped messages across metric streams ou Split messages per metric stream

Variáveis Dinâmicas

As tabelas a seguir listam as variáveis dinâmicas disponíveis para cada parâmetro.

Use a variável dinâmica indicada para renderizar o valor de um parâmetro em mensagens de alarme.

Dica

O escape de HTML ocorre para a variável dinâmica primária (mais curta). Por exemplo, quando você usa a variável dinâmica principal {{title}} para o valor do parâmetro title alarm for successRate < 0.99, o caractere < é renderizado como &lt;.

Para desativar o escape de HTML, use a variável dinâmica secundária (mais longa). Por exemplo, quando você usa a variável dinâmica secundária {{{title}}} para o valor do parâmetro title alarm for successRate < 0.99, o caractere < é preservado.

alarme

Parâmetro de alarme Variáveis dinâmicas*
dedupekey
  • {{dedupekey}}
  • {{{dedupekey}}}
title
  • {{title}}
  • {{{title}}}
body (nenhuma)
type
  • {{type}}
  • {{{type}}}
severity

Consulte o parâmetro filho severity na tabela a seguir, Metadados de Alarme.

timestampEpochMillis
  • {{timestampEpochMillis}}
  • {{{timestampEpochMillis}}}
timestamp
  • {{timestamp}}
  • {{{timestamp}}}
alarmMetaData

Consulte os parâmetros filhos na tabela a seguir, Metadados de Alarme.

version
  • {{version}}
  • {{{version}}}

*A variável dinâmica primária (mais curta) executa escape de HTML. A variável dinâmica secundária (mais longa) preserva os caracteres de entrada.

Metadados do Alarme

Parâmetro de alarme Variáveis dinâmicas*
id
  • {{id}}
  • {{{id}}}
status
  • {{status}}
  • {{{status}}}
severity
  • {{severity}}
  • {{{severity}}}
namespace
  • {{namespace}}
  • {{{namespace}}}
query
  • {{query}}
  • {{{query}}}
totalMetricsFiring
  • {{totalMetricsFiring}}
  • {{{totalMetricsFiring}}}
dimensions
  • {{dimensions.<dimension-name>}}
  • {{{dimensions.<dimension-name>}}}

<dimension-name> é o nome da dimensão. Por exemplo, para fazer referência à dimensão faultdomain:

  • {{dimensions.faultdomain}}
  • {{{dimensions.faultdomain}}}

Exemplo de valor:

FAULT-DOMAIN-3

Conteúdo bruto da mensagem associado:

"faultdomain":"FAULT-DOMAIN-3"

O nome da dimensão deve ser válido para que a variável dinâmica seja renderizada na mensagem de alarme.

metricValues
  • {{metricValues}}
  • {{{metricValues}}}

Exemplo de valor:

[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]

Conteúdo bruto da mensagem associado:

metricValues:[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]
alarmUrl
  • {{alarmUrl}}
  • {{{alarmUrl}}}
alarmSummary
  • {{alarmSummary}}
  • {{{alarmSummary}}}
notificationType
  • {{notificationType}}
  • {{{notificationType}}}

*A variável dinâmica primária (mais curta) executa escape de HTML. A variável dinâmica secundária (mais longa) preserva os caracteres de entrada.

Aparência padrão da mensagem formatada

As tabelas a seguir listam a aparência padrão de cada parâmetro de mensagem de alarme em mensagens de alarme formatadas.

alarme

Parâmetro de alarme Aparência de mensagem formatada padrão
dedupekey
title
body
type
severity Omitido por padrão
timestampEpochMillis Omitido por padrão
timestamp
alarmMetaData

Consulte os parâmetros filhos na tabela a seguir, Metadados de Alarme.

version Omitido por padrão

Metadados do Alarme

Parâmetro de alarme Aparência de mensagem formatada padrão
id
status
severity
namespace Omitido por padrão
query
totalMetricsFiring
  • E-mail (formatado): Número de métricas que violam o limite
  • Slack: Número de streams de métrica que violam o limite
  • SMS: Omitido por padrão
dimensions
metricValues
  • E-mail (formatado): Valores de métricas, ordenados por dimensão
  • Slack: Valores de métricas, ordenados por dimensão
  • SMS: Omitido por padrão
alarmUrl
alarmSummary
notificationType Omitido por padrão