Documentazione dell'infrastruttura Oracle Cloud

Formato del messaggio di allarme

Cercare i parametri visualizzati nei messaggi di allarme inviati da Monitoring. Rivedere le descrizioni dei parametri e i valori di esempio, le variabili dinamiche e l'aspetto predefinito nei messaggi formattati.

I parametri sono elencati nell'ordine in cui vengono visualizzati nei formati pretty JSON e raw dei messaggi e-mail.

Parametri nei messaggi di allarme

Le tabelle seguenti descrivono i parametri in messaggi di allarme e forniscono valori di esempio.

Allarme

Parametro allarme Descrizione e valore di esempio
dedupekey

stringa

Identificativo univoco dell'allarme (messaggio raggruppato) o del flusso di metriche nell'allarme (messaggio diviso).

Valore di esempio: exampleuniqueid

Commenti sull'utilizzo:

Per i messaggi raggruppati (notificationType: Group notifications across metric streams), utilizzare dedupekey per raggruppare i messaggi appartenenti allo stesso allarme.

Per i messaggi divisi (notificationType: Split messages per metric stream), utilizzare dedupekey per raggruppare i messaggi appartenenti allo stesso allarme e allo stesso flusso di metriche.

Per annullare la duplicazione di più occorrenze dello stesso messaggio, utilizzare dedupekey e timestamp insieme.
title

stringa

Titolo della notifica dell'allarme (Oggetto notifica nel form della console per la creazione e l'aggiornamento degli allarmi). Se non specificato, viene utilizzato il nome visualizzato dell'allarme.

Nota: inserire variabili dinamiche che rispettano la lunghezza massima per tutti i casi d'uso supportati. Le variabili dinamiche che superano il numero massimo vengono considerate non valide. Ad esempio, considerare una variabile dinamica da utilizzare in title. Un caso d'uso supportato per title è una riga dell'oggetto e-mail con una lunghezza massima di 250 caratteri. In questo caso, la variabile dinamica per un nome risorsa ({{dimensions.<dimension-name>}}) non è valida perché è composta da 256 caratteri e quindi supera il valore massimo.

Valore di esempio che utilizza variabili dinamiche: {{severity}} alarm triggered at {{timestamp}}

Valore di esempio (nome visualizzato dell'allarme): High CPU Utilization
body

stringa

Corpo del messaggio configurato dell'allarme (Corpo dell'allarme nel form della console per la creazione e l'aggiornamento degli allarmi). Null se non specificato.

Valore di esempio che utilizza variabili dinamiche: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Valore di esempio (testo): Follow runbook at http://example.com/runbooks
type

stringa

Il motivo dell'invio del messaggio di notifica.

Valori validi: vedere Tipi di messaggio.

Valore di esempio: OK_TO_FIRING
severity

stringa

Il livello di severità più alto degli allarmi elencati.

Valori validi: CRITICAL, ERROR, WARNING e INFO
timestampEpochMillis

lungo

L'indicatore orario di valutazione, in millisecondi dal tempo di epoca.

Valore di esempio: 1684337663852
timestamp

stringa

Indicatore orario di valutazione, in formato ISO-8601.

Valore di esempio: 2023-05-17T15:34:23.852Z
alarmMetaData

array di oggetti

Lista di allarmi correlati a questo messaggio di notifica.

Ad esempio, vedere i parametri figlio nella tabella seguente, Metadati di allarme.
version

int

Versione del formato del messaggio di allarme.

Valore di esempio: 1.5

Metadati allarme

Parametro allarme Descrizione e valore di esempio
id

stringa

Allarme OCID .

Valore di esempio: ocid1.alarm.oc1..exampleuniqueID
status

stringa

Stato allarme.

Valori validi: OK, FIRING
severity

stringa

Livello di severità allarme.

Valori validi: CRITICAL, ERROR, WARNING, INFO
namespace

stringa

Spazio di nomi delle metriche.

Valore di esempio: oci_computeagent
query

stringa

Query configurata dell'allarme o espressione MQL.

Valore di esempio: CpuUtilization[1m].mean() > 90
totalMetricsFiring

int

Numero di flussi di metriche rappresentati in questo messaggio di notifica.

Valore di esempio: 3
dimensions

array di oggetti

Lista di coppie chiave-valore dimensione che identificano ogni flusso di metriche. L'elenco è limitato a cento voci.

Valore di esempio:

{ "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

array di oggetti

Elenco di valori delle metriche per le coppie chiave-valore dimensione (flussi di metriche). L'elenco è limitato a cento voci.

Valore di esempio:

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

stringa

Collegamento alla pagina dei dettagli dell'allarme nella console.

Valore di esempio: https://cloud.oracle.com/monitoring/alarms/ocid1.alarm.oc1.iad.exampleuniqueid?region=us-ashburn-1
alarmSummary

stringa

Riepilogo degli allarmi configurato dell'allarme (Riepilogo degli allarmi nel form della console per la creazione e l'aggiornamento degli allarmi). Se non è configurato, viene utilizzato un messaggio generato dal sistema che ne riepiloga lo stato.

Valore di esempio che utilizza variabili dinamiche: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Il contenuto del messaggio generato dal sistema (utilizzato quando il riepilogo degli allarmi non è configurato) dipende da notificationType:

  • Per 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>

    Esempio:

    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

  • Per 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

stringa

Tipo di notifica (raggruppata o divisa).

Valori validi: Grouped messages across metric streams o Split messages per metric stream

Variabili dinamiche

Nelle tabelle seguenti sono elencate le variabili dinamiche disponibili per ciascun parametro.

Utilizzare la variabile dinamica indicata per eseguire il rendering del valore di un parametro nei messaggi di allarme.

Suggerimento

L'escape HTML si verifica per la variabile dinamica primaria (più breve). Ad esempio, quando si utilizza la variabile dinamica primaria {{title}} per il valore del parametro title alarm for successRate < 0.99, il carattere < viene visualizzato come &lt;.

Per disabilitare il escape HTML, utilizzare la variabile dinamica secondaria (più lunga). Ad esempio, quando si utilizza la variabile dinamica secondaria {{{title}}} per il valore del parametro title alarm for successRate < 0.99, il carattere < viene conservato.

Allarme

Parametro allarme Variabili dinamiche*
dedupekey
  • {{dedupekey}}
  • {{{dedupekey}}}
title
  • {{title}}
  • {{{title}}}
body (nessuna)
type
  • {{type}}
  • {{{type}}}
severity

Vedere il parametro figlio severity nella tabella seguente, Metadati allarme.
timestampEpochMillis
  • {{timestampEpochMillis}}
  • {{{timestampEpochMillis}}}
timestamp
  • {{timestamp}}
  • {{{timestamp}}}
alarmMetaData

Vedere i parametri figlio nella tabella seguente, Metadati allarme.
version
  • {{version}}
  • {{{version}}}

*La variabile dinamica primaria (più breve) esegue l'escape HTML. La variabile dinamica secondaria (più lunga) conserva i caratteri di input.

Metadati allarme

Parametro allarme Variabili dinamiche*
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> è il nome della dimensione.

Il nome della dimensione deve essere valido affinché la variabile dinamica venga visualizzata nel messaggio di allarme.

La variabile dinamica visualizza il primo valore restituito. In altre parole, se vengono restituiti più valori distinti, viene selezionato il primo valore per il rendering.

Esempio 1: più valori distinti dalla dimensione target

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

Valori: target1, target2

Contenuto messaggio raw associato:

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

In questo esempio, per il rendering viene selezionato il primo valore restituito target1.

Esempio 2: valore singolo dalla dimensione faultdomain

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

Valore: FAULT-DOMAIN-3

Contenuto messaggio raw associato:

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

Valore di esempio:

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

Contenuto messaggio raw associato:

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

*La variabile dinamica primaria (più breve) esegue l'escape HTML. La variabile dinamica secondaria (più lunga) conserva i caratteri di input.

Aspetto predefinito dei messaggi formattati

Le tabelle seguenti elencano l'aspetto predefinito di ogni parametro del messaggio di allarme nei messaggi di allarme formattati.

Allarme

Parametro allarme Aspetto predefinito del messaggio formattato
dedupekey
title
body
type
severity Omesso per impostazione predefinita
timestampEpochMillis Omesso per impostazione predefinita
timestamp
alarmMetaData

Vedere i parametri figlio nella tabella seguente, Metadati allarme.
version Omesso per impostazione predefinita

Metadati allarme

Parametro allarme Aspetto predefinito del messaggio formattato
id
status
severity
namespace Omesso per impostazione predefinita
query
totalMetricsFiring
  • E-mail (formattata): Numero di metriche che superano la soglia
  • Slack: Numero di flussi di metriche che superano la soglia
  • SMS: omesso per impostazione predefinita
dimensions
metricValues
  • E-mail (formattato): Valori delle metriche, ordinati per dimensione
  • Slack: Valori delle metriche, ordinati per dimensione
  • SMS: omesso per impostazione predefinita
alarmUrl
  • E-mail (formattata): Visualizza allarme nella console
  • Slack: non etichettato, parte del titolo
  • SMS: omesso per impostazione predefinita
alarmSummary
  • E-mail (formattata): Riepilogo allarme (pulsante nella parte inferiore del messaggio)
  • Slack: omesso per impostazione predefinita
  • SMS: omesso per impostazione predefinita
notificationType Omesso per impostazione predefinita