Carga útil del evento que se envía desde IBM Cloud Logs a IBM Cloud Event Notifications

Los eventos generados con éxito por IBM Cloud Logs contienen varios campos que le ayudan a identificar la fuente y los detalles de un evento.

Los eventos generados por el servicio IBM Cloud Logs contienen únicamente propiedades de metadatos, como nombres o identificadores de recursos. Los datos confidenciales, por ejemplo claves de API o contraseñas, no se incluyen en los sucesos generados.

Las propiedades que se envían a Event Notifications varían en función del tipo y subtipo de evento. Por ejemplo, si un evento de StandardMoreThanAlertEvent:AlertTriggered tiene lugar en una instancia, IBM Cloud Logs envía una carga de notificación a Event Notifications que es similar al siguiente ejemplo.

Carga útil

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

Revise la tabla siguiente para obtener más información sobre las propiedades de notificación de sucesos.

Propiedades en una carga útil de notificación de evento
Propiedad	Descripción
`alert_definition`	`alert_type`: Tipo de alerta que desencadena una notificación. `condition`: La configuración de alertas cuando se pueden activar alertas. `description` descripción de la alerta. `id` el identificador único de la alerta activada. Es el mismo ID que se puede utilizar en las llamadas a la API. `name` el nombre de la alerta. `query_statement` la consulta de búsqueda Lucene de la alerta dada. `severity` el nivel de gravedad de la alerta. `versioned_id` el ID versionado de la alerta activada. Es el ID que se genera cuando se actualiza la definición de la alerta.
`latest_event_timestamp`	La fecha y hora en que se generó el evento.
`links`	`edit_alert`: Enlace a la página para modificar las configuraciones de la alerta. `view_alert`: Enlace a la página para comprobar los detalles de la alerta.
`priority`	La prioridad de la condición que activó la alerta.
`status`	El estado de la alerta dada.
`ibmendefaultshort`	El nombre de la alerta dada.
`ibmendefaultlong`	La combinación de la acción, desencadenada o resuelta, y el nombre de la alerta.
`ibmenseverity`	La gravedad de la alerta.
`ibmensourceid`	El nombre de recurso de nube (CRN) que identifica de forma exclusiva su instancia de servicio de IBM Cloud Logs.
`id`	El identificador proporcionado por IBM Cloud Logs que identificaría el evento en IBM Cloud Logs
`notification_id`	El identificador creado por Event Notifications.
`source`	El nombre de recurso de nube (CRN) que identifica de forma exclusiva su instancia de servicio de IBM Cloud Logs.
`time`	Momento en el que se activa una notificación de alerta.
`type`	La combinación del tipo de evento que activó una notificación y el subtipo que corresponde al tipo de evento que activó una notificación.

Tamaño de datos

En un evento, se aplican las siguientes duraciones:

Tamaño de datos
Nombre de campo	Número máximo de caracteres
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

Cada campo de la carga útil tiene un tamaño específico. Si algún campo supera el número máximo de caracteres, la carga útil se truncará.

Tenga en cuenta la información siguiente:

Si un campo de cadena supera su número máximo de caracteres, se truncará y se añadirán puntos suspensivos (...) para indicar que el contenido se ha cortado.
Se incluirán metaetiquetas hasta el límite.
Las claves y valores de las etiquetas meta se tendrán en cuenta para el límite.
Si el campo log_example supera su número máximo de caracteres, se convertirá en una cadena que contiene parte de los datos de registro seguidos de puntos suspensivos (...) para indicar el truncamiento.
Los siguientes campos adicionales se añaden a los datos para indicar cuándo una muestra o etiquetas están truncadas:

log_example_truncated: Este campo se añadirá a la carga útil para indicar que se ha truncado una entrada de registro de ejemplo.

Si log_example_truncated es true, el JSON truncado se envía a IBM Cloud Event Notifications como JSON stringificado.

meta_labels_truncated: Este campo se añadirá para indicar que las etiquetas de metadatos se truncaron.

Caracteres especiales en valores de plantilla personalizados

Si está utilizando un valor en una plantilla personalizada que incluye un punto (.) en el nombre, debe poner el valor entre corchetes ([ ]).

Por ejemplo, si el valor que desea incluir en su notificación es kubernetes.cluster_name, debe incluir el valor similar a este:

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