Documentación de Oracle Cloud Infrastructure

Uso de variables dinámicas en mensajes de alarma

Actualice una alarma en Monitoring para incluir valores de parámetros de mensajes de alarma en los mensajes.

Consulte también Creating a Basic Alarm.

Cómo se representan las variables dinámicas

Nota

Inserte variables dinámicas que respeten la longitud máxima para todos los casos de uso soportados. Las variables dinámicas que superan el máximo se consideran no válidas. Por ejemplo, considere una variable dinámica para su uso en title. Un caso de uso admitido para title es una línea de asunto de correo electrónico, con una longitud máxima de 250 caracteres. En este caso, la variable dinámica para un nombre de recurso ({{dimensions.<dimension-name>}}) no es válida porque tiene 256 caracteres y, por lo tanto, supera el máximo.

El valor de un parámetro de mensaje de alarma se representa en un mensaje de alarma al insertar la variable dinámica asociada en los campos soportados. Por ejemplo, introduzca lo siguiente como el cuerpo de la alarma:

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

En la siguiente imagen de un mensaje de alarma, el cuerpo de la alarma (Cuerpo) se representa como: Alarma CRÍTICA disparada porque se ha incumplido el umbral debido a [CpuUtilization[1m].mean():92] en 2023-08-15T19:51:00Z

Ejemplo de variables dinámicas representadas en un mensaje de correo electrónico con formato.

Las variables dinámicas aparecen en las notificaciones que contienen elementos de cuerpo.

  • Si hay datos disponibles para una variable dinámica, la variable se resuelve y los datos aparecen en su lugar. El mensaje de alarma de ejemplo anterior muestra [CpuUtilization[1m].mean():92] en lugar de la variable dinámica {{metricValues}}.
  • Si no hay datos disponibles para una variable dinámica, la variable no se resuelve y aparece como codificada. Por ejemplo, si no hay valores de métrica disponibles para la variable dinámica {{metricValues}}, como cuando la alarma está en estado correcto, la variable dinámica {{metricValues}} aparece en el mensaje de alarma.
  • Los mensajes SMS carecen de elementos del cuerpo, por lo que las variables dinámicas no se resuelven.

Búsqueda de variables dinámicas

Para buscar una variable dinámica para un parámetro, consulte Variables dinámicas.

    1. En la página de lista Definiciones de alarma, seleccione la alarma con la que desea trabajar. Si necesita ayuda para buscar la página de lista o la alarma, consulte Lista de alarmas.
    2. Vaya a Acciones y, a continuación, seleccione Editar alarma.
    3. En la página Editar alarma, busque el campo al que desea agregar variables dinámicas.
      • Cuerpo de la alarma (parámetro de mensaje de alarma body): se representa como un campo dentro del cuerpo del mensaje de alarma.
      • Resumen de alarma (parámetro de mensaje de alarma alarmSummary): se representa como un campo dentro del cuerpo del mensaje de alarma.
      • Asunto de notificación (parámetro de mensaje de alarma title): la representación depende del tipo de mensaje. Para un mensaje de correo electrónico con formato, se representa como la línea de asunto. Para un mensaje de Slack, se presenta como el título. Para un mensaje SMS, se representa como parte del mensaje.
        Nota

        Inserte variables dinámicas que respeten la longitud máxima para todos los casos de uso soportados. Las variables dinámicas que superan el máximo se consideran no válidas. Por ejemplo, considere una variable dinámica para su uso en title. Un caso de uso admitido para title es una línea de asunto de correo electrónico, con una longitud máxima de 250 caracteres. En este caso, la variable dinámica para un nombre de recurso ({{dimensions.<dimension-name>}}) no es válida porque tiene 256 caracteres y, por lo tanto, supera el máximo.

      Para obtener información sobre la apariencia predeterminada de estos parámetros de mensajes de alarma en mensajes con formato, consulte Formato de mensaje de alarma.

    4. Inserte variables dinámicas para los parámetros de mensaje de alarma que desee.

      Ejemplo con variables dinámicas:

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

      Para buscar variables dinámicas para un parámetro, consulte Variables dinámicas.

      Puede desactivar el escape HTML mediante la variable dinámica más larga para un parámetro de alarma. Por ejemplo, para representar el valor del parámetro query en el mensaje de alarma con escape HTML desactivado, introduzca la variable dinámica {{{query}}}.

    5. Seleccione Guardar alarma.

  • Utilice el comando oci monitoring alarm update y los parámetros necesarios para actualizar una alarma a fin de utilizar variables dinámicas en el campo que desea:

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

    Con saltos de línea:

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

    Para obtener una lista completa de parámetros y valores para comandos de CLI, consulte la Referencia de línea de comandos para la supervisión.

  • Ejecute la operación UpdateAlarm para actualizar una alarma para que utilice la opción de formato de mensaje que desea.

    Al definir detalles para UpdateAlarmDetails, defina el campo que desea (alarmSummary, body o notificationTitle) en el texto que desea, incluidas las variables dinámicas.