Carga útil do evento que é enviada de IBM Cloud Logs para IBM Cloud Event Notifications

Os eventos bem-sucedidos gerados pelo site IBM Cloud Logs contêm vários campos que o ajudam a identificar a origem e os detalhes de um evento.

Os eventos gerados pelo serviço IBM Cloud Logs contêm apenas propriedades de metadados, como nomes ou identificadores de recursos. Os dados sensíveis, por exemplo, chaves de API ou senhas, não são incluídos nos eventos gerados.

As propriedades que são enviadas para Event Notifications variam de acordo com o tipo e o subtipo do evento. Por exemplo, se um evento StandardMoreThanAlertEvent:AlertTriggered ocorrer em uma instância, IBM Cloud Logs enviará uma carga de notificação para Event Notifications que é semelhante ao exemplo a seguir.

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 a tabela a seguir para obter mais informações sobre propriedades de notificação de eventos.

Propriedades em uma carga útil de notificação de evento
Propriedade	Descrição
`alert_definition`	`alert_type`: O tipo de alerta que acionou uma notificação. `condition`: Configuração de alertas quando os alertas podem ser acionados. `description`: A descrição do alerta. `id`: O identificador exclusivo do alerta acionado. Este é o mesmo ID que pode ser usado em chamadas de API. `name`: O nome do alerta fornecido. `query_statement`: A consulta de pesquisa Lucene do alerta fornecido. `severity`: O nível de gravidade do alerta fornecido. `versioned_id`: O ID versionado do alerta acionado. Essa é a ID gerada quando a definição do alerta é atualizada.
`latest_event_timestamp`	A data e a hora em que o evento foi gerado.
`links`	`edit_alert` link para a página para modificar as configurações do alerta. `view_alert` link para a página de verificação dos detalhes do alerta.
`priority`	A prioridade da condição que acionou o alerta.
`status`	O status do alerta fornecido.
`ibmendefaultshort`	O nome do alerta fornecido.
`ibmendefaultlong`	A combinação da ação, acionada ou resolvida, e o nome do alerta.
`ibmenseverity`	A gravidade do alerta.
`ibmensourceid`	O Cloud Resource Name (CRN) que identifica exclusivamente sua instância de serviço do IBM Cloud Logs.
`id`	O identificador fornecido por IBM Cloud Logs que identificaria o evento em IBM Cloud Logs
`notification_id`	O identificador criado por Event Notifications.
`source`	O Cloud Resource Name (CRN) que identifica exclusivamente sua instância de serviço do IBM Cloud Logs.
`time`	O horário em que uma notificação de alerta é acionada.
`type`	A combinação do tipo de evento que acionou uma notificação e o subtipo que corresponde ao tipo de evento que acionou uma notificação.

Tamanho dos Dados

Em um evento, aplicam-se as seguintes durações:

Tamanho dos dados
Nome do 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 no payload tem um tamanho específico. Se algum campo exceder o número máximo de caracteres, a carga útil será truncada.

Considere as informações a seguir:

Se um campo de cadeia de caracteres exceder o número máximo de caracteres, ele será truncado e uma elipse (...) será anexada para indicar que o conteúdo foi cortado.
Os meta-rótulos serão incluídos até o limite.
As chaves e os valores do meta-rótulo contarão para o limite.
Se o campo log_example exceder o número máximo de caracteres, ele será convertido em uma cadeia de caracteres que contém parte dos dados de registro, seguida de reticências (...) para indicar truncamento.
Os seguintes campos adicionais são adicionados aos dados para indicar quando uma amostra ou rótulos são truncados:

log_example_truncated: Esse campo será adicionado à carga útil para indicar que uma entrada de registro de exemplo foi truncada.

Se log_example_truncated for true, o JSON truncado será enviado para IBM Cloud Event Notifications como JSON encadeado.

meta_labels_truncated: Esse campo será adicionado para indicar que os rótulos de metadados foram truncados.

Caracteres especiais em valores de modelos personalizados

Se estiver usando um valor em um modelo personalizado que inclua um ponto (.) no nome, será necessário colocar o valor entre colchetes ([ ]).

Por exemplo, se o valor que você deseja incluir em sua notificação for kubernetes.cluster_name, será necessário incluir um valor semelhante a este:

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