Visión general del formato de registro

Detalles del formato de nivel superior de Oracle Cloud Infrastructure Logging.

Cada línea de log se normaliza en un formato de evento común para facilitar la correlación. Este formato se basa en la especificación Implantación JSON de CloudEvents v1.0. Una línea de log tiene tres secciones clave:
  • Sobre unificado
  • Metadatos específicos de Oracle (oracle.*)
  • Contenido de la línea de log (datos)

Formato de sobre externo

Todos los mensajes enviados al front-end de ingestión utilizan el formato de sobre externo y solo cambian el cuerpo del mensaje según el tipo de log. El formato de sobre externo cumple con la especificación CloudEvents v1.0, con campos de extensión definidos para fines de registro. En la siguiente tabla se describe este formato.

Nombre Necesario Posición Tipo Descripción
Versión de la especificación Cuerpo: specversion Cadena Versión de la especificación CloudEvents a la que se ajusta este mensaje.
ID Cuerpo: id Cadena Identificador único del origen para este mensaje. Los mensajes duplicados pueden tener el mismo identificador. Los consumidores pueden asumir que los eventos con los mismos identificadores son únicos.
Tipo Cuerpo: type Cadena Tipo del mensaje. Los consumidores utilizan type y specversion para determinar cómo interpretar el cuerpo. Patrón: com.oraclecloud.{service}.{resource-type}.{category}. Por ejemplo: com.oraclecloud.compute.instance.terminated
Origen Cuerpo: source Referencia de URI

Origen del mensaje.

Cuando lo emite un servicio, hace referencia al nombre del recurso que generó el mensaje, por ejemplo, el nombre del cubo de Object Storage, nombre de la instancia.

Cuando lo emite un agente, según el origen/entrada utilizado para leer eventos. Por ejemplo, el nombre de la instancia (no el OCID) o el nombre de host del activo en un entorno local.

Asunto No Cuerpo: subject Cadena

Subrecurso específico que generó el evento, si se aplica al origen. Resulta útil para los orígenes con subrecursos. Ejemplos:

  • Ejemplo de Object Storage:

    Source: my-bucket
    Subject: image.png
  • Ejemplo de registro personalizado:

    Source: hostname
    Subject: /var/log/some.log
Hora No Cuerpo: time Registro de hora Hora a la que se ha generado el mensaje. Si está presente, debe debe ajustarse al formato especificado en RFC 3339. Si no se proporciona, se utiliza el reloj de pared del host de ingestión que recibe la solicitud.
Esquema de datos No Cuerpo: dataschema Cadena Versión del esquema para el campo data. No es necesario y, si no se proporciona, se asume que es la versión inicial.
Tipo de contenido de datos No Cuerpo: datacontenttype Cadena Formato en el que se codifica el cuerpo del mensaje. Si no se proporciona, el valor por defecto es JSON (equivale a datacontenttype: application/json).
Cuerpo de mensaje Cuerpo: data Objecto Cuerpo del mensaje codificado en el formato definido por datacontenttype. Si no se especifica datacontenttype, se espera que sea JSON (equivale a datacontenttype: application/json).
Metadatos de Oracle Cloud Cuerpo: oracle Objecto Se proporcionan más metadatos específicos de Oracle en una asignación de atributos en el nivel superior del sobre. Esto se ajusta a la especificación de extensiones de atributo de CloudEvents v1. Consulte la siguiente tabla para conocer los atributos de metadatos de Oracle Cloud Infrastructure soportados.

Atributos de metadatos de Oracle

Los siguientes atributos están soportados en el campo de extensión oci del formato de mensaje. Los nombres de estos atributos se ajustan a la convención de nombre de atributo de CloudEvents v1; es decir, son identificadores alfanuméricos en minúscula con menos de 20 caracteres.

Nombre Necesario para la ingestión Enriquecido para la recuperación Tipo Descripción
logid - Cadena OCID del objeto de log al que se ha enviado el mensaje.
loggroupid No Cadena OCID del grupo de logs en el que reside el objeto.
tenantid No Cadena OCID del inquilino propietario del objeto de log.
compartmentid No Cadena OCID del compartimento en el que residía el objeto de log en el momento de la ingestión del mensaje.