Ereignisnutzlast, die von IBM Cloud Logs an IBM Cloud Event Notifications

Erfolgreiche Ereignisse, die von IBM Cloud Logs generiert werden, enthalten verschiedene Felder, die Ihnen helfen, die Quelle und Details eines Ereignisses zu identifizieren.

Ereignisse, die vom IBM Cloud Logs-Dienst generiert werden, enthalten nur Metadaten-Eigenschaften, wie z. B. Namen oder Kennungen von Ressourcen. Sensible Daten wie API-Schlüssel oder Kennwörter werden nicht in generierte Ereignisse eingeschlossen.

Die Eigenschaften, die an Event Notifications gesendet werden, variieren je nach Ereignistyp und Untertyp. Wenn beispielsweise ein StandardMoreThanAlertEvent:AlertTriggered-Ereignis in einer Instanz stattfindet, sendet IBM Cloud Logs eine Benachrichtigung an Event Notifications, die dem folgenden Beispiel ähnelt.

Nutzdaten

{
   "data": {
      "alert_definition": {
         "alert_type": "StandardMoreThanAlertEvent",
         "condition": {
            "MoreThan": {
               "condition_threshold": 1,
               "condition_timeframe": 1
            }
         },
         "description": "",
         "id": "<alert_unique_id>",
         "meta_labels": {
            "env": "prod"
         },
         "name": "<alert_name>",
         "query_statement": "_exists_:level",
         "severity": "ERROR",
         "versioned_id": "<alert_versioned_id>",
      },
      "latest_event_timestamp": 0000000000000,
      "links": {
         "edit_alert": "https://dashboard.eu-gb.logs.cloud.ibm.com/<instance_id>/#/alerts/<alert_versioned_id>",
         "view_alert": "https://dashboard.eu-gb.logs.cloud.ibm.com/<instance_id>/#/insights?id=c9fe7539-e901-4745-b3ad-29ca0ae987a0"
      },
      "log_example": {"msg":"Test Log"},
      "log_example_truncated": true,
      "meta_labels_truncated": false,
      "priority": "<alert_priority>",
      "status": "triggered"
   },
   "datacontenttype": "application/json",
   "ibmendefaultlong": "Triggered: 2024-01-01T00:00:00Z",
   "ibmendefaultshort": "ERROR - new_groupBy",
   "ibmenseverity": "info",
   "ibmensourceid": "crn:v1:bluemix:public:logs:<region>:a/<account_id>:<instance_id>::",
   "id": "997355d5-4542-47fd-9868-84cf5df71e1b_c9fe7539-e901-4745-b3ad-29ca0ae987a0",
   "notification_id": "923873c0-2b42-4d4c-a9a0-c69339b16717",
   "source": "crn:v1:bluemix:public:logs:<region>:a/<account_id>:<instance_id>::",
   "specversion": "1.0",
   "time": "2024-01-01T00:00:00.000000Z",
   "type": "com.ibm.cloud.logs.<event_type>:<event_subtype>"
}

Weitere Informationen zu Ereignisbenachrichtigungseigenschaften finden Sie in der folgenden Tabelle.

Eigenschaften in einer Nutzlast für eine Ereignisbenachrichtigung
Eigenschaft	Beschreibung
`alert_definition`	`alert_type`art des Alarms, der eine Benachrichtigung ausgelöst hat. `condition` konfiguration der Alarme, wenn Alarme ausgelöst werden können. `description` beschreibung: Die Beschreibung des Alarms. `id` ausgelöster Alarm: Der eindeutige Bezeichner des ausgelösten Alarms. Dies ist die gleiche ID, die in API-Aufrufen verwendet werden kann. `name` name: Der Name des angegebenen Alerts. `query_statement` lucene-Suchanfrage: Die Lucene-Suchanfrage für die angegebene Meldung. `severity`schweregrad: Der Schweregrad der gegebenen Warnung. `versioned_id` version: Die Versions-ID der ausgelösten Warnung. Dies ist die ID, die erzeugt wird, wenn die Alarmdefinition aktualisiert wird.
`latest_event_timestamp`	Das Datum und die Uhrzeit, zu der das Ereignis erzeugt wurde.
`links`	`edit_alert`: Link zur Seite, um die Konfigurationen der Warnmeldung zu ändern. `view_alert`: Link zur Seite, um die Details der Warnmeldung zu überprüfen.
`priority`	Die Priorität der Bedingung, die den Alarm ausgelöst hat.
`status`	Der Status der gegebenen Warnung.
`ibmendefaultshort`	Der Name der gegebenen Ausschreibung.
`ibmendefaultlong`	Die Kombination aus der Aktion, ausgelöst oder aufgelöst, und dem Namen des Alarms.
`ibmenseverity`	Der Schweregrad der Warnung.
`ibmensourceid`	Der CRN (Cloud Resource Name), der Ihre IBM Cloud Logs-Serviceinstanz eindeutig identifiziert.
`id`	Die von IBM Cloud Logs bereitgestellte Kennung, die das Ereignis in IBM Cloud Logs
`notification_id`	Die Kennung wurde erstellt von Event Notifications.
`source`	Der CRN (Cloud Resource Name), der Ihre IBM Cloud Logs-Serviceinstanz eindeutig identifiziert.
`time`	Der Zeitpunkt, zu dem eine Warnmeldung ausgelöst wird.
`type`	Die Kombination aus der Art des Ereignisses, das eine Benachrichtigung ausgelöst hat, und dem Subtyp, der der Art des Ereignisses entspricht, das eine Benachrichtigung ausgelöst hat.

Datenmenge

Bei einer Veranstaltung gelten die folgenden Längen:

Data Size
Feldname	Maximale Anzahl von Zeichen
data.log_example	1000
data.alert_definition.meta_labels	400
data.alert_definition.name	100
data.alert_definition.description	100
data.alert_definition.query_statement	100

Jedes Feld in der Nutzlast hat eine bestimmte Größe. Wenn ein Feld die maximale Anzahl an Zeichen überschreitet, wird die Nutzlast abgeschnitten.

Beachten Sie die folgenden Informationen:

Wenn ein Zeichenfolgenfeld die maximale Anzahl an Zeichen überschreitet, wird es abgeschnitten und mit Auslassungspunkten (...) versehen, um anzuzeigen, dass der Inhalt abgeschnitten wurde.
Meta-Labels werden bis zum Limit einbezogen.
Meta-Label-Schlüssel und -Werte werden auf das Limit angerechnet.
Wenn das Feld "log_example" die maximale Anzahl an Zeichen überschreitet, wird es in eine Zeichenkette umgewandelt, die einen Teil der Protokolldaten enthält, gefolgt von Auslassungspunkten (...), um anzuzeigen, dass die Daten abgeschnitten wurden.
Die folgenden zusätzlichen Felder werden zu den Daten hinzugefügt, um anzuzeigen, wann eine Probe oder Etiketten abgeschnitten werden:

log_example_truncated: Dieses Feld wird der Nutzlast hinzugefügt, um anzuzeigen, dass ein Beispielprotokolleintrag abgeschnitten wurde.

Wenn log_example_truncated gleich true ist, wird gekürztes JSON als stringifiziertes JSON an IBM Cloud Event Notifications gesendet.

meta_labels_truncated: Dieses Feld wird hinzugefügt, um anzuzeigen, dass Metadaten-Labels abgeschnitten wurden.

Sonderzeichen in benutzerdefinierten Vorlagenwerten

Wenn Sie einen Wert in einer benutzerdefinierten Vorlage verwenden, die einen Punkt (.) im Namen enthält, müssen Sie den Wert in eckige Klammern setzen ([ ]).

Wenn Sie beispielsweise den Wert kubernetes.cluster_name in Ihre Benachrichtigung aufnehmen möchten, müssen Sie den Wert wie folgt eingeben:

"CloudLogs_Shared_Summary": "{{data.log_example.[kubernetes.cluster_name]}}"