Charge utile d'événement envoyée depuis IBM Cloud Logs vers IBM Cloud Event Notifications

Les événements réussis générés par IBM Cloud Logs contiennent divers champs qui vous aident à identifier la source et les détails d'un événement.

Les événements générés par le service IBM Cloud Logs ne contiennent que des propriétés de métadonnées, telles que les noms ou les identifiants des ressources. Les données sensibles, par exemple les clés d'API ou les mots de passe, ne sont pas incluses dans les événements générés.

Les propriétés envoyées à Event Notifications varient en fonction du type et du sous-type d'événement. Par exemple, si un événement d' StandardMoreThanAlertEvent:AlertTriggered s se produit dans une instance, IBM Cloud Logs envoie une charge utile de notification à Event Notifications qui est similaire à l'exemple suivant.

Contenu

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

Consultez le tableau suivant pour plus d'informations sur les propriétés de notification d'événements.

Propriétés d'une charge utile de notification d'événement
Propriété Description
alert_definition
  • alert_type: Le type d'alerte qui a déclenché une notification.
  • condition: Configuration des alertes lorsque des alertes peuvent être déclenchées.
  • description:La description de l'alerte.
  • id: L'identifiant unique de l'alerte déclenchée. Il s'agit du même identifiant que celui qui peut être utilisé dans les appels à l'API.
  • name nom de l'alerte : Le nom de l'alerte donnée.
  • query_statement la requête de recherche Lucene de l'alerte donnée.
  • severity le niveau de gravité de l'alerte donnée.
  • versioned_id le niveau de gravité de l'alerte donnée : l'ID versionné de l'alerte déclenchée. Il s'agit de l'identifiant généré lors de la mise à jour de la définition de l'alerte.
latest_event_timestamp La date et l'heure auxquelles l'événement a été généré.
links
  • edit_alert: Lien vers la page permettant de modifier les configurations de l'alerte.
  • view_alert: Lien vers la page permettant de vérifier les détails de l'alerte.
priority Priorité de la condition qui a déclenché l'alerte.
status Le statut de l'alerte donnée.
ibmendefaultshort Le nom de l'alerte donnée.
ibmendefaultlong La combinaison de l'action, déclenchée ou résolue, et le nom de l'alerte.
ibmenseverity La gravité de l'alerte.
ibmensourceid Nom de ressource de cloud (CRN) qui identifie de manière unique votre instance de service IBM Cloud Logs.
id L'identifiant fourni par IBM Cloud Logs qui permettrait d'identifier l'événement dans IBM Cloud Logs
notification_id L'identifiant créé par Event Notifications.
source Nom de ressource de cloud (CRN) qui identifie de manière unique votre instance de service IBM Cloud Logs.
time Moment où une notification d'alerte est déclenchée.
type La combinaison du type d'événement qui a déclenché une notification et du sous-type qui correspond au type d'événement qui a déclenché une notification.

Taille des données

Dans un événement, les longueurs suivantes s'appliquent :

Taille des données
Nom de zone Nombre maximum de caractères
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

Chaque champ de la charge utile a une taille spécifique. Si un champ dépasse le nombre maximal de caractères, la charge utile sera tronquée.

Tenez compte des informations suivantes :

  • Si un champ de type chaîne de caractères dépasse le nombre maximal de caractères, il sera tronqué et une ellipse (...) sera ajoutée pour indiquer que le contenu a été coupé.

  • Les méta-étiquettes seront incluses dans la limite.

  • Les clés et valeurs des méta-étiquettes seront comptabilisées dans la limite.

  • Si le champ log_example dépasse le nombre maximal de caractères, il sera converti en une chaîne contenant une partie des données du journal suivie de points de suspension (...) pour indiquer la troncature.

  • Les champs supplémentaires suivants sont ajoutés aux données pour indiquer quand un échantillon ou des étiquettes sont tronqués :

    log_example_truncated: Ce champ sera ajouté à la charge utile pour indiquer qu'une entrée de journal d'exemple a été tronquée.

    Si log_example_truncated est true, le JSON tronqué est envoyé à IBM Cloud Event Notifications sous la forme d'un JSON filigrané.

    meta_labels_truncated: Ce champ sera ajouté pour indiquer que les étiquettes de métadonnées ont été tronquées.

Caractères spéciaux dans les valeurs de modèles personnalisés

Si vous utilisez une valeur dans un modèle personnalisé dont le nom contient un point (.), vous devez placer la valeur entre crochets ([ ]).

Par exemple, si la valeur que vous souhaitez inclure dans votre notification est kubernetes.cluster_name, vous devez inclure la valeur similaire à celle-ci :

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