Documentación de Oracle Cloud Infrastructure

Formato del mensaje de alarma

Consulte los parámetros que aparecen en los mensajes de alarma enviados por Monitoring. Revise las descripciones de los parámetros y los valores de ejemplo, las variables dinámicas y la apariencia por defecto en los mensajes con formato.

Los parámetros se muestran en el orden en que aparecen en los formatos pretty JSON y raw de los mensajes de correo electrónico.

Parámetros en mensajes de alarma

En las siguientes tablas, se describen los parámetros de los mensajes de alarma y se proporcionan valores de ejemplo.

alarma

Parámetro de alarma Descripción y valor de ejemplo
dedupekey

cadena

Identificador único de la alarma (mensaje agrupado) o del flujo de métricas de la alarma (mensaje dividido).

Valor de ejemplo: exampleuniqueid

Comentarios sobre el uso:

Para mensajes agrupados (notificationType: Group notifications across metric streams), utilice dedupekey para agrupar mensajes que pertenezcan a la misma alarma.

Para mensajes divididos (notificationType: Split messages per metric stream), utilice dedupekey para agrupar mensajes que pertenezcan a la misma alarma y al mismo flujo de métricas.

Para desduplicar varias incidencias del mismo mensaje, utilice dedupekey y timestamp juntos.
title

cadena

Título de notificación de la alarma (Asunto de notificación en el formulario de la consola para crear y actualizar alarmas). Si no se especifica, se utilizará el nombre mostrado de la alarma.

Valor de ejemplo con variables dinámicas: {{severity}} alarm triggered at {{timestamp}}

Valor de ejemplo (nombre mostrado de la alarma): High CPU Utilization
body

cadena

Cuerpo del mensaje configurado de la alarma (Cuerpo de alarma en el formulario de la consola para crear y actualizar alarmas). Nulo si no se especifica.

Valor de ejemplo con variables dinámicas: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

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

cadena

Motivo por el que se envía el mensaje de notificación.

Valores válidos: consulte Tipos de mensaje.

Valor de ejemplo: OK_TO_FIRING
severity

cadena

La gravedad más alta de las alarmas mostradas.

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

largo

El registro de hora de evaluación, en milisegundos desde la época.

Valor de ejemplo: 1684337663852
timestamp

cadena

El registro de hora de evaluación, en formato ISO-8601.

Valor de ejemplo: 2023-05-17T15:34:23.852Z
alarmMetaData

matriz de objetos

Lista de alarmas relacionadas con este mensaje de notificación.

Por ejemplo, valores, consulte los parámetros secundarios en la siguiente tabla, Alarm Metadata (Metadatos de alarma).
version

int

Versión del formato del mensaje de la alarma.

Valor de ejemplo: 1.5

Metadatos de alarma

Parámetro de alarma Descripción y valor de ejemplo
id

cadena

OCID  de la alarma.

Valor de ejemplo: ocid1.alarm.oc1..exampleuniqueID
status

cadena

Estado de la alarma.

Valores válidos: OK, FIRING
severity

cadena

Nivel de gravedad de la alarma.

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

cadena

Espacio de nombre de métrica.

Valor de ejemplo: oci_computeagent
query

cadena

Consulta de la alarma configurada o expresión MQL.

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

int

Número de flujos de métricas representado en este mensaje de notificación.

Valor de ejemplo: 3
dimensions

matriz de objetos

Lista de pares de clave de dimensión-valor para identificar cada flujo de métricas. Esta lista se limita a cien entradas.

Valor de ejemplo:

{ "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étricas para pares clave-valor de dimensión (flujos de métricas). Esta lista se limita a cien entradas.

Valor de ejemplo:

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

cadena

Enlace a la página de detalles de alarma en la consola.

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

cadena

Resumen de alarma configurado de la alarma (Resumen de alarma en el formulario de la consola para crear y actualizar alarmas). Si no está configurado, se utiliza un mensaje generado por el sistema que resume el estado.

Valor de ejemplo con variables dinámicas: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

El contenido del mensaje generado por el sistema (utilizado cuando no se configura el resumen de alarmas) 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>

    Ejemplo:

    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

cadena

Tipo de notificación (agrupada o dividida).

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

Variables dinámicas

En las siguientes tablas se muestran las variables dinámicas disponibles para cada parámetro.

Utilice la variable dinámica indicada para representar el valor de un parámetro en los mensajes de alarma.

Consejo

El escape HTML se produce para la variable dinámica principal (más corta). Por ejemplo, al utilizar la variable dinámica principal {{title}} para el valor de parámetro title alarm for successRate < 0.99, el carácter < se representa como &lt;.

Para desactivar el escape HTML, utilice la variable dinámica secundaria (más larga). Por ejemplo, al utilizar la variable dinámica secundaria {{{title}}} para el valor de parámetro title alarm for successRate < 0.99, se conserva el carácter <.

alarma

Parámetro de alarma Variables dinámicas*
dedupekey
  • {{dedupekey}}
  • {{{dedupekey}}}
title
  • {{title}}
  • {{{title}}}
body (ninguno)
type
  • {{type}}
  • {{{type}}}
severity

Consulte el parámetro secundario severity en la siguiente tabla, Alarm Metadata (Metadatos de alarma).
timestampEpochMillis
  • {{timestampEpochMillis}}
  • {{{timestampEpochMillis}}}
timestamp
  • {{timestamp}}
  • {{{timestamp}}}
alarmMetaData

Consulte los parámetros secundarios en la siguiente tabla, Alarm Metadata (Metadatos de alarma).
version
  • {{version}}
  • {{{version}}}

*La variable dinámica principal (más corta) realiza el escape HTML. La variable dinámica secundaria (más larga) conserva los caracteres de entrada.

Metadatos de alarma

Parámetro de alarma Variables 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> es el nombre de la dimensión.

El nombre de dimensión debe ser válido para que la variable dinámica se presente en el mensaje de alarma.

La variable dinámica representa el primer valor devuelto. Es decir, si se devuelven varios valores distintos, se selecciona el primer valor para la representación.

Ejemplo 1: varios valores distintos de la dimensión target

  • {{dimensions.target}}
  • {{{dimensions.target}}}

Valores: target1, target2

Contenido de mensaje sin formato asociado:

"target": "target1"
…
"target": "target2"

En este ejemplo, se selecciona el primer valor devuelto target1 para la representación.

Ejemplo 2: valor único de la dimensión faultdomain

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

Valor: FAULT-DOMAIN-3

Contenido de mensaje sin formato asociado:

"faultdomain":"FAULT-DOMAIN-3"
metricValues
  • {{metricValues}}
  • {{{metricValues}}}

Valor de ejemplo:

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

Contenido del mensaje raw asociado:

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

*La variable dinámica principal (más corta) realiza el escape HTML. La variable dinámica secundaria (más larga) conserva los caracteres de entrada.

Apariencia de mensaje con formato por defecto

En las siguientes tablas, se muestra la apariencia predeterminada de cada parámetro de mensaje de alarma en los mensajes de alarma con formato.

alarma

Parámetro de alarma Apariencia de mensaje con formato predeterminado
dedupekey
title
body
type
severity Omitido por defecto
timestampEpochMillis Omitido por defecto
timestamp
alarmMetaData

Consulte los parámetros secundarios en la siguiente tabla, Alarm Metadata (Metadatos de alarma).
version Omitido por defecto

Metadatos de alarma

Parámetro de alarma Apariencia de mensaje con formato predeterminado
id
status
severity
namespace Omitido por defecto
query
totalMetricsFiring
dimensions
metricValues
alarmUrl
alarmSummary
notificationType Omitido por defecto