Visão Geral do Formato de Registro em Log
Detalhes do formato de nível superior do Oracle Cloud Infrastructure Logging.
- Envelope unificado
- Metadados específicos da Oracle (oracle.*)
- Conteúdo da linha de log (dados)
Formato de Envelope Externo
Todas as mensagens enviadas ao frontend de ingestão usam o formato de envelope externo e só alteram o corpo da mensagem com base no tipo de log. O formato do envelope externo está em conformidade com a especificação CloudEvents v1.0, com campos de extensão definidos para fins de registro em log. A tabela a seguir descreve esse formato.
| Nome | Obrigatório | Posição | Tipo | Descrição |
|---|---|---|---|---|
| Versão da Especificação | Sim | Corpo: specversion | String | A versão da especificação CloudEvents com a qual esta mensagem está em conformidade. |
| Id | Sim | Corpo: id | String | Um identificador exclusivo de origem para esta mensagem. As mensagens duplicadas podem ter o mesmo ID. Os consumidores podem presumir que os eventos com os mesmos IDs são exclusivos. |
| Tipo | Sim | Corpo: type | String | O tipo da mensagem. Os consumidores usam type e specversion para determinar como interpretar o corpo. Padrão: com.oraclecloud.{service}.{resource-type}.{category}. Por exemplo: com.oraclecloud.compute.instance.terminated |
| Origem | Sim | Corpo: source | Referência de URI |
A origem da mensagem. Quando emitido por um serviço, refere-se ao nome do recurso que gerou a mensagem, por exemplo, o nome do bucket do serviço Object Storage e o Nome da Instância. Quando emitida por um agente, com base na origem/entrada usada para ler eventos. Por exemplo, o nome da instância (não o OCID) ou o nome do host do ativo em um ambiente local. |
| Assunto | Não | Corpo: subject | String |
Um sub-recurso específico que gerou o evento, se aplicável à origem. Isso é útil para origens com sub-recursos. Exemplos:
|
| Hora | Não | Corpo: time | Timestamp | A hora em que a mensagem foi gerada. Se houver, deve seguir o formato especificado em RFC 3339. Se não for fornecido, será usado o relógio do host de ingestão que recebe a solicitação. |
| Esquema de Dados | Não | Corpo: dataschema | String | A versão do esquema do campo data. Essa informação não é necessária e, se não for fornecida, será considerada a versão inicial. |
| Tipo de Conteúdo de Dados | Não | Corpo: datacontenttype | String | O formato no qual o corpo da mensagem é codificado. Se não for fornecido, o padrão será JSON (equivalente a datacontenttype: application/json). |
| Corpo da Mensagem | Sim | Corpo: data | Objeto | O corpo da mensagem codificado no formato definido por datacontenttype. Se datacontenttype não for especificado, espera-se que seja JSON (equivalente a datacontenttype: application/json). |
| Metadados do Oracle Cloud | Sim | Corpo: oracle | Objeto | Mais metadados específicos da Oracle são fornecidos em um mapa de atributos no nível superior do envelope. Isso está em conformidade com a especificação Extensões de Atributo CloudEvents v1. Consulte a tabela a seguir para obter os atributos de metadados do Oracle Cloud Infrastructure suportados. |
Atributos de Metadados da Oracle
Os atributos a seguir são suportados no campo de extensão oci do formato da mensagem. A nomenclatura para esses atributos está em conformidade com a Convenção de Nomenclatura de Atributos CloudEvents v1, ou seja, eles são identificadores alfanuméricos minúsculos com menos de 20 caracteres.
| Nome | Obrigatório para Ingestão | Aprimorado para Recuperação | Tipo | Descrição |
|---|---|---|---|---|
| logid | Sim | - | String | O OCID do objeto de log ao qual a mensagem foi enviada. |
| loggroupid | Não | Sim | String | O OCID do grupo de logs no qual o objeto reside. |
| tenantid | Não | Sim | String | O OCID do tenant que possui o objeto de log. |
| compartmentid | Não | Sim | String | O OCID do compartimento no qual o objeto de log residia no momento em que a mensagem foi ingerida. |