Oracle Cloud Infrastructure - Dokumentation

Alarmnachrichtenformat

Suchen Sie nach Parametern, die in Alarmmeldungen angezeigt werden, die von Monitoring gesendet werden. Prüfen Sie Parameterbeschreibungen und Beispielwerte, dynamische Variablen und die Standarddarstellung in formatierten Meldungen.

Parameter werden in der Reihenfolge aufgeführt, in der sie im hübschen JSON- und raw-Format von E-Mail-Nachrichten angezeigt werden.

Parameter in Alarmmeldungen

In den folgenden Tabellen werden Parameter in Alarmmeldungen beschrieben, und es werden Beispielwerte angegeben.

Alarm

Alarmparameter Beschreibung und Beispielwert
dedupekey

Zeichenfolge

Eindeutige ID des Alarms (gruppierte Nachricht) oder des Metrikstreams im Alarm (geteilte Nachricht).

Beispielwert: exampleuniqueid

Kommentare zur Nutzung:

Bei gruppierten Nachrichten (notificationType: Group notifications across metric streams) verwenden Sie dedupekey, um Nachrichten zu gruppieren, die zu demselben Alarm gehören.

Bei aufgeteilten Nachrichten (notificationType: Split messages per metric stream) verwenden Sie dedupekey, um Nachrichten zu gruppieren, die zu demselben Alarm und demselben Metrikstream gehören.

Um mehrere Vorkommen derselben Nachricht zu deduplizieren, verwenden Sie dedupekey und timestamp zusammen.
title

Zeichenfolge

Der Benachrichtigungstitel des Alarms (Benachrichtigungsbetreff im Konsolenformular zum Erstellen und Aktualisieren von Alarmen). Wenn keine Angabe gemacht wird, wird der Anzeigename des Alarms verwendet.

Hinweis: Fügen Sie dynamische Variablen ein, die für alle unterstützten Anwendungsfälle die maximale Länge einhalten. Dynamische Variablen, die das Maximum überschreiten, werden als ungültig betrachtet. Beispiel: Eine dynamische Variable zur Verwendung in title. Ein unterstützter Anwendungsfall für title ist eine E-Mail-Betreffzeile, die maximal 250 Zeichen lang ist. In diesem Fall ist die dynamische Variable für einen Ressourcennamen ({{dimensions.<dimension-name>}}) ungültig, weil sie 256 Zeichen enthält und somit das Maximum überschreitet.

Beispielwert mit dynamischen Variablen: {{severity}} alarm triggered at {{timestamp}}

Beispielwert (Anzeigename des Alarms): High CPU Utilization
body

Zeichenfolge

Der konfigurierte Nachrichtentext des Alarms (Alarmtext im Konsolenformular zum Erstellen und Aktualisieren von Alarmen). Null, wenn nicht angegeben.

Beispielwert mit dynamischen Variablen: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Beispielwert (Text): Follow runbook at http://example.com/runbooks
type

Zeichenfolge

Der Grund für das Senden der Benachrichtigung.

Gültige Werte: siehe Nachrichtentypen.

Beispielwert: OK_TO_FIRING
severity

Zeichenfolge

Der höchste Schweregrad der aufgeführten Alarme.

Gültige Werte: CRITICAL, ERROR, WARNING und INFO
timestampEpochMillis

lang

Der Auswertungszeitstempel in Millisekunden seit Epochenzeit.

Beispielwert: 1684337663852
timestamp

Zeichenfolge

Der Auswertungszeitstempel im ISO-8601-Format.

Beispielwert: 2023-05-17T15:34:23.852Z
alarmMetaData

Array von Objekten

Liste der Alarme für diese Benachrichtigung.

Beispielwerte finden Sie unter den untergeordneten Parametern in der folgenden Tabelle, Alarmmetadaten.
version

int

Die Version des Alarmnachrichtenformats.

Beispielwert: 1.5

Alarmmetadaten

Alarmparameter Beschreibung und Beispielwert
id

Zeichenfolge

Die Alarm-OCID .

Beispielwert: ocid1.alarm.oc1..exampleuniqueID
status

Zeichenfolge

Der Alarmstatus.

Gültige Werte: OK, FIRING
severity

Zeichenfolge

Der Alarmschweregrad.

Gültige Werte: CRITICAL, ERROR, WARNING, INFO
namespace

Zeichenfolge

Der Metrik-Namespace.

Beispielwert: oci_computeagent
query

Zeichenfolge

Die konfigurierte Abfrage des Alarms oder der MQL-Ausdruck.

Beispielwert: CpuUtilization[1m].mean() > 90
totalMetricsFiring

int

Die Anzahl von Metrikstreams, die in dieser Benachrichtigung dargestellt werden.

Beispielwert: 3
dimensions

Array von Objekten

Liste mit Schlüssel/Wert-Paaren für Dimensionen, die jeden Metrikstream identifizieren. Die Liste ist auf 100 Einträge beschränkt.

Beispielwert:

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

Liste der Metrikwerte für Dimensionsschlüssel/Wert-Paare (Metrikstreams). Die Liste ist auf 100 Einträge beschränkt.

Beispielwert:

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

Zeichenfolge

Link zur Alarmdetailseite in der Konsole.

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

Zeichenfolge

Die konfigurierte Alarmübersicht des Alarms (Alarmübersicht im Konsolenformular zum Erstellen und Aktualisieren von Alarmen). Falls nicht konfiguriert, wird eine vom System generierte Meldung verwendet, die den Status zusammenfasst.

Beispielwert mit dynamischen Variablen: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Der Inhalt der systemgenerierten Nachricht (wird verwendet, wenn die Alarmübersicht nicht konfiguriert ist) hängt von notificationType ab:

  • Für 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>

    Beispiel:

    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

  • Für 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

Zeichenfolge

Benachrichtigungstyp (gruppiert oder aufgeteilt).

Gültige Werte: Grouped messages across metric streams oder Split messages per metric stream

Dynamische Variable

In den folgenden Tabellen werden dynamische Variablen aufgeführt, die für jeden Parameter verfügbar sind.

Verwenden Sie die angegebene dynamische Variable, um den Wert eines Parameters in Alarmmeldungen wiederzugeben.

Tipp

HTML-Escaping erfolgt für die primäre (kürzere) dynamische Variable. Beispiel: Wenn Sie die primäre dynamische Variable {{title}} für den Parameterwert alarm for successRate < 0.99 title verwenden, wird das Zeichen < als &lt; gerendert.

Um die HTML-Escape-Funktion zu deaktivieren, verwenden Sie die sekundäre (längere) dynamische Variable. Beispiel: Wenn Sie die sekundäre dynamische Variable {{{title}}} für den Parameterwert alarm for successRate < 0.99 title verwenden, wird das Zeichen < beibehalten.

Alarm

Alarmparameter Dynamische Variablen*
dedupekey
  • {{dedupekey}}
  • {{{dedupekey}}}
title
  • {{title}}
  • {{{title}}}
body (keiner)
type
  • {{type}}
  • {{{type}}}
severity

Siehe den untergeordneten Parameter severity in der folgenden Tabelle, Alarmmetadaten.
timestampEpochMillis
  • {{timestampEpochMillis}}
  • {{{timestampEpochMillis}}}
timestamp
  • {{timestamp}}
  • {{{timestamp}}}
alarmMetaData

Siehe die untergeordneten Parameter in der folgenden Tabelle, Alarmmetadaten.
version
  • {{version}}
  • {{{version}}}

*Die primäre (kürzere) dynamische Variable führt HTML-Escaping durch. Die sekundäre (längere) dynamische Variable behält Eingabezeichen bei.

Alarmmetadaten

Alarmparameter Dynamische Variablen*
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> ist der Name der Dimension.

Der Dimensionsname muss gültig sein, damit die dynamische Variable in der Alarmmeldung gerendert wird.

Die dynamische Variable gibt den ersten zurückgegebenen Wert wieder. Das heißt, wenn mehrere eindeutige Werte zurückgegeben werden, wird der erste Wert zum Rendern ausgewählt.

Beispiel 1: Mehrere eindeutige Werte aus der Dimension target

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

Werte: target1, target2

Zugeordneter Raw-Nachrichteninhalt:

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

In diesem Beispiel wird der erste zurückgegebene Wert target1 zum Rendern ausgewählt.

Beispiel 2: Einzelner Wert aus der Dimension faultdomain

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

Wert: FAULT-DOMAIN-3

Zugeordneter Raw-Nachrichteninhalt:

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

Beispielwert:

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

Zugeordneter Raw-Nachrichteninhalt:

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

*Die primäre (kürzere) dynamische Variable führt HTML-Escaping durch. Die sekundäre (längere) dynamische Variable behält Eingabezeichen bei.

Formatierte Standardnachrichtenanzeige

In den folgenden Tabellen werden die Standarddarstellungen der einzelnen Alarmmeldungsparameter in formatierten Alarmmeldungen aufgeführt.

Alarm

Alarmparameter Standardformatierte Meldung
dedupekey
title
body
type
severity Standardmäßig ausgelassen
timestampEpochMillis Standardmäßig ausgelassen
timestamp
alarmMetaData

Siehe die untergeordneten Parameter in der folgenden Tabelle, Alarmmetadaten.
version Standardmäßig ausgelassen

Alarmmetadaten

Alarmparameter Standardformatierte Meldung
id
status
severity
namespace Standardmäßig ausgelassen
query
totalMetricsFiring
  • E-Mail (formatiert): Anzahl Metriken, die den Schwellenwert überschreiten
  • Slack: Anzahl Metrikstreams, die den Schwellenwert überschreiten
  • SMS: Standardmäßig ausgelassen
dimensions
metricValues
  • E-Mail (formatiert): Kennzahlenwerte, sortiert nach Dimension
  • Slack: Metrikwerte, sortiert nach Dimension
  • SMS: Standardmäßig ausgelassen
alarmUrl
alarmSummary
  • E-Mail (formatiert): Alarmübersicht (Schaltfläche unten in der Nachricht)
  • Slack: Standardmäßig ausgelassen
  • SMS: Standardmäßig ausgelassen
notificationType Standardmäßig ausgelassen