Carico utile dell'evento inviato da IBM Cloud Logs a IBM Cloud Event Notifications

Gli eventi riusciti generati da IBM Cloud Logs contengono vari campi che aiutano a identificare la fonte e i dettagli di un evento.

Gli eventi generati dal servizio IBM Cloud Logs contengono solo proprietà di metadati, come nomi o identificatori di risorse. I dati sensibili, ad esempio le chiavi API o le password, non sono inclusi negli eventi generati.

Le proprietà inviate a Event Notifications variano a seconda del tipo e del sottotipo di evento. Ad esempio, se in un'istanza si verifica un evento di tipo " StandardMoreThanAlertEvent:AlertTriggered ", " IBM Cloud Logs " invia un payload di notifica a " Event Notifications " simile al seguente esempio.

Payload

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

Consulta la tabella seguente per ulteriori informazioni sulle proprietà di notifica degli eventi.

Proprietà in un payload di notifica evento
Proprietà Descrizione
alert_definition
  • alert_type il tipo di avviso che ha attivato una notifica.
  • condition configurazione degli avvisi quando gli avvisi possono essere attivati.
  • description la descrizione dell'avviso.
  • id l'identificatore univoco dell'avviso attivato. È lo stesso ID che può essere usato nelle chiamate API.
  • name: Il nome dell'avviso dato.
  • query_statement la query di ricerca Lucene dell'avviso dato.
  • severity il livello di gravità dell'avviso.
  • versioned_id l'ID versionato dell'avviso attivato. È l'ID generato quando la definizione di avviso viene aggiornata.
latest_event_timestamp La data e l'ora di generazione dell'evento.
links
  • edit_alert: Link alla pagina per modificare le configurazioni dell'avviso.
  • view_alert: Link alla pagina per controllare i dettagli dell'avviso.
priority La priorità della condizione che ha attivato l'avviso.
status Lo stato dell'allarme dato.
ibmendefaultshort Il nome dell'avviso dato.
ibmendefaultlong La combinazione dell'azione, attivata o risolta, e il nome dell'allarme.
ibmenseverity La gravità dell'avviso.
ibmensourceid Il Cloud Resource Name (CRN) che identifica in modo univoco l'istanza del servizio IBM Cloud Logs.
id L'identificatore fornito da IBM Cloud Logs che identificherebbe l'evento in IBM Cloud Logs
notification_id L'identificatore creato da Event Notifications.
source Il Cloud Resource Name (CRN) che identifica in modo univoco l'istanza del servizio IBM Cloud Logs.
time L'ora in cui viene attivata una notifica di allerta.
type La combinazione del tipo di evento che ha attivato una notifica e il sottotipo che corrisponde al tipo di evento che ha attivato una notifica.

Dimensione dati

In un evento, si applicano le seguenti lunghezze:

Dimensione dati
Nome campo Massimo numero di caratteri
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

Ogni campo nel payload ha una dimensione specifica. Se un campo supera il numero massimo di caratteri, il payload verrà troncato.

Considera le seguenti informazioni:

  • Se un campo stringa supera il numero massimo di caratteri, verrà troncato e verranno aggiunti puntini di sospensione (...) per indicare che il contenuto è stato tagliato.

  • Le meta etichette saranno incluse fino al limite.

  • Le chiavi e i valori delle meta-etichette verranno conteggiati nel limite.

  • Se il campo log_example supera il numero massimo di caratteri, verrà convertito in una stringa contenente parte dei dati di registro seguita da puntini di sospensione (...) per indicare il troncamento.

  • I seguenti campi aggiuntivi vengono aggiunti ai dati per indicare quando un campione o delle etichette sono troncati:

    log_example_truncated: Questo campo verrà aggiunto al carico utile per indicare che una voce di registro di esempio è stata troncata.

    Se log_example_truncated è true, il JSON troncato viene inviato a IBM Cloud Event Notifications come JSON stringato.

    meta_labels_truncated: Questo campo verrà aggiunto per indicare che le etichette dei metadati sono state troncate.

Caratteri speciali nei valori dei modelli personalizzati

Se si utilizza un valore in un modello personalizzato che include un punto (.) nel nome, è necessario racchiudere il valore tra parentesi quadre ([ ]).

Ad esempio, se il valore che si desidera includere nella notifica è kubernetes.cluster_name, è necessario includere un valore simile a questo:

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