Documentation sur Oracle Cloud Infrastructure

Aperçu du format de journalisation

Informations détaillées sur le format du service 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 la spécification de mise en oeuvre JSON de CloudEvents v1.0. Une ligne de journal comporte trois sections principales :
  • Enveloppe unifiée
  • Métadonnées propres à Oracle (oracle.*)
  • Contenu de la ligne de journal (données)

Format d'enveloppe externe

Tous les messages envoyés vers le serveur frontal d'ingestion utilisent le format d'enveloppe externe et modifient seulement le corps du message en fonction du type de journal. Le format d'enveloppe externe est conforme à la spécification CloudEvents v1.0, avec des champs d'extension définis à des fins de journalisation. Le tableau suivant décrit ce format.

Nom Obligatoire Position Type Description
Version de spécification Oui Corps : specversion Chaîne Version de la spécification CloudEvents à laquelle ce message est conforme.
ID Oui Corps : id Chaîne Identificateur unique de la source pour ce message. Les messages en double peuvent avoir le même ID. Les consommateurs peuvent supposer que les événements ayant les mêmes ID sont uniques.
Type Oui Corps : 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 Corps : source Référence URI

Source du message.

Lorsqu'il est émis par un service, référence le nom de la ressource qui a généré le message, par exemple, le nom du seau du service de stockage d'objets, le nom de l'instance.

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

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

  • Exemple pour le service de stockage d'objets :

    Source: my-bucket
    Subject: image.png

  • Exemple de journalisation personnalisée :

    Source: hostname
    Subject: /var/log/some.log
Heure Non Corps : time Horodatage Heure de génération du message. Si présente, doit respecter le format spécifié dans RFC 3339. Sinon, l'horloge murale de l'hôte d'ingestion qui reçoit la demande est utilisée.
Schéma de données Non Corps : dataschema Chaîne Version du schéma pour le champ data. Ce n'est pas obligatoire et, si elle n'est pas fournie, elle est supposée être la version initiale.
Type de contenu de données Non Corps : datacontenttype Chaîne Format dans lequel le corps du message est encodé. S'il n'est pas indiqué, le format par défaut est JSON (équivalent à datacontenttype: application/json).
Corps du message Oui Corps : data Objet Le corps du message est encodé dans le format défini par datacontenttype. Si datacontenttype n'est pas spécifié, JSON est attendu (équivalent à datacontenttype: application/json).
Métadonnées Oracle Cloud Oui Corps : oracle Objet D'autres métadonnées propres à Oracle sont fournies dans une mappe d'attributs au niveau supérieur de l'enveloppe. Cela est conforme à la spécification Extensions d'attribut CloudEvents v1. Voir le tableau suivant pour les attributs de métadonnées d'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. L'attribution de nom pour ces attributs est conforme à la convention d'attribution de nom d'attribut CloudEvents v1, c'est-à-dire qu'il s'agit d'identificateurs alphanumériques en minuscules de moins de 20 caractères.

Nom Requis pour l'ingestion Enrichi pour 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 responsable de l'objet de journal.
compartmentid Non Oui Chaîne OCID du compartiment dans lequel réside l'objet de journal au moment de l'ingestion du message.