Documentation Oracle Cloud Infrastructure

Présentation du format de journalisation

Détails du format Oracle Cloud Infrastructure Logging de niveau supérieur.

Chaque ligne de journal est normalisée dans un format d'événement commun pour faciliter la corrélation. Ce format est basé sur l'implémentation JSON de la spécification CloudEvents version 1.0. Une ligne de journal comporte trois sections principales :
  • une enveloppe unifiée ;
  • des métadonnées propres à Oracle (oracle.*) ;
  • le contenu de la ligne de journal (données).

Format d'enveloppe externe

Tous les messages envoyés au composant frontal d'inclusion utilisent le format de l'enveloppe externe et modifient uniquement le corps du message en fonction du type de journal. Le format d'enveloppe externe est conforme à la spécification CloudEvents version 1.0, avec des champs d'extension définis à des fins de journalisation. Le tableau suivant décrit ce format :

Nom Requis Position Type Description
Version de la spécification Oui Body: specversion Chaîne Version de la spécification CloudEvents à laquelle ce message est conforme.
ID Oui Body: id Chaîne Identificateur unique source de ce message. Les messages en double peuvent avoir le même ID. Les consommateurs peuvent supposer que les événements portant les mêmes ID sont uniques.
Type Oui Body: type Chaîne Type du message. Les consommateurs utilisent type et specversion pour déterminer comment interpréter le corps. Modèle : com.oraclecloud.{service}.{resource-type}.{category}. Par exemple : com.oraclecloud.compute.instance.terminated
Source Oui Body: source Référence d'URI

Source du message.

Lorsqu'elle est émise par un service, elle fait référence au nom de la ressource qui a généré le message. Par exemple, le nom du bucket Object Storage ou le nom de l'instance.

Lorsqu'elle est émise par un agent, elle est basée sur la source/l'entrée utilisée pour lire les événements. Par exemple, le nom d'instance (et non l'OCID) ou le nom d'hôte de la ressource dans un environnement sur site.
Objet Non Body: subject Chaîne

Sous-ressource spécifique qui a généré l'événement, le cas échéant, pour la source. Ce champ est utile pour les sources qui comportent des sous-ressources. Exemples :

  • Exemple dans Object Storage :

    Source: my-bucket
    Subject: image.png

  • Exemple de journalisation personnalisée :

    Source: hostname
    Subject: /var/log/some.log
Heure Non Body: time Horodatage Heure de génération du message. Si elle est indiquée, elle doit respecter le format indiqué dans RFC 3339. Si elle n'est pas indiquée, l'horloge de l'hôte d'inclusion qui reçoit la demande est utilisée.
Schéma de données Non Body: dataschema Chaîne Version de schéma pour le champ data. Cette option n'est pas obligatoire et, si elle n'est pas fournie, la version par défaut est la version initiale.
Type de contenu de données Non Body: datacontenttype Chaîne Format dans lequel le corps du message est encodé. S'il n'est pas indiqué, la valeur par défaut est JSON (équivalent à datacontenttype: application/json).
Corps du message Oui Body: data Objet Corps du message encodé au format défini par datacontenttype. Si datacontenttype n'est pas indiqué, il s'agit probablement de JSON (équivalent à datacontenttype: application/json).
Métadonnées Oracle Cloud Oui Body: oracle Objet D'autres métadonnées propres à Oracle sont fournies dans une correspondance d'attributs au niveau supérieur de l'enveloppe. Cela est conforme à la spécification CloudEvents version 1 sur les extensions d'attributs. Reportez-vous au tableau suivant pour découvrir les attributs de métadonnées Oracle Cloud Infrastructure pris en charge.

Attributs de métadonnées Oracle

Les attributs suivants sont pris en charge dans le champ d'extension oci du format de message. La dénomination de ces attributs est conforme à la spécification CloudEvents version 1 sur la convention de dénomination des attributs, c'est-à-dire qu'il s'agit d'identificateurs alphanumériques en minuscules de moins de 20 caractères.

Nom Requis pour l'inclusion Enrichi pour l'extraction Type Description
logid Oui - Chaîne OCID de l'objet de journal auquel le message a été envoyé.
loggroupid Non Oui Chaîne OCID du groupe de journaux dans lequel réside l'objet.
tenantid Non Oui Chaîne OCID du locataire qui possède l'objet de journal.
compartmentid Non Oui Chaîne OCID du compartiment dans lequel l'objet de journal se trouvait au moment de l'inclusion du message.