Oracle Cloud Infrastructure-Dokumentation

Loggingformat - Überblick

Details zum Oracle Cloud Infrastructure Logging-Format der obersten Ebene.

Jede Logzeile wird in ein allgemeines Ereignisformat normalisiert, um die Korrelation zu vereinfachen. Dieses Format basiert auf der Spezifikation JSON-Implementierung von CloudEvents v1.0. Eine Logzeile enthält drei Schlüsselabschnitte:
  • Einheitlicher Envelope
  • Oracle-spezifische Metadaten (oracle.*)
  • Inhalt der Logzeile (Daten)

Außen-Envelope-Format

Alle an das Aufnahme-Frontend gesendeten Nachrichten verwenden das Außen-Envelope-Format und ändern nur den Nachrichtentext basierend auf dem Logtyp. Das Außen-Envelope-Format entspricht der Spezifikation von CloudEvents v1.0, wobei Erweiterungsfelder für Loggingzwecke definiert sind. In der folgenden Tabelle wird dieses Format beschrieben.

Name Erforderlich Position Typ Beschreibung
Spezifikationsversion Ja Text: specversion Zeichenfolge Die Version der CloudEvents-Spezifikation, mit der diese Nachricht übereinstimmt.
ID Ja Text: id Zeichenfolge Eine ID mit eindeutiger Quelle für diese Nachricht. Doppelte Nachrichten können dieselbe ID haben. Consumer können davon ausgehen, dass Ereignisse mit denselben IDs eindeutig sind.
Typ Ja Text: type Zeichenfolge Der Typ der Nachricht. Consumer bestimmen mit type und specversion, wie der Text interpretiert wird. Muster: com.oraclecloud.{service}.{resource-type}.{category}. Beispiel: com.oraclecloud.compute.instance.terminated
Quelle Ja Text: source URI-Referenz

Die Nachrichtenquelle.

Wenn von einem Service ausgegeben, bezieht sie sich auf den Namen der Ressource, die die Nachricht generiert hat, z.B. den Objektspeicher-Bucket-Namen oder den Instanznamen.

Wenn von einem Agent ausgegeben, basiert sie auf der Quelle/Eingabe, die zum Lesen von Ereignissen verwendet wird. Zum Beispiel der Instanzname (nicht die OCID) oder der Hostname des Assets in einer On-Premise-Umgebung.
Betreff Nein Text: subject Zeichenfolge

Eine bestimmte Unterressource, die das Ereignis generiert hat, sofern für die Quelle zutreffend. Dies ist nützlich für Quellen mit Unterressourcen. Beispiele:

  • Beispiel für Object Storage:

    Source: my-bucket
    Subject: image.png

  • Beispiel für benutzerdefiniertes Logging:

    Source: hostname
    Subject: /var/log/some.log
Zeit Nein Text: time Zeitstempel Die Zeit, zu der die Nachricht generiert wurde. Wenn vorhanden, muss sie dem in RFC 3339 angegebenen Format entsprechen. Andernfalls wird die Systemuhrzeit des Aufnahmehosts verwendet, der die Anforderung empfängt.
Datenschema Nein Text: dataschema Zeichenfolge Die Schemaversion für das Feld data. Die Schemaversion ist nicht erforderlich. Wenn sie nicht angegeben ist, wird davon ausgegangen, dass es sich um die ursprüngliche Version handelt.
Dateninhaltstyp Nein Text: datacontenttype Zeichenfolge Das Format, in dem der Nachrichtentext codiert wird. Wenn keine Angabe gemacht wird, ist der Standardwert JSON (entspricht datacontenttype: application/json).
Nachrichtentext Ja Text: data Objekt Der Nachrichtentext, der in dem von datacontenttype definierten Format codiert ist. Wenn datacontenttype nicht angegeben ist, wird davon ausgegangen, dass JSON verwendet wird (entspricht datacontenttype: application/json).
Oracle Cloud-Metadaten Ja Text: oracle Objekt Weitere Oracle-spezifische Metadaten werden in einer Map von Attributen auf der obersten Ebene des Envelopes bereitgestellt. Dies entspricht der Spezifikation Erweiterungen zu Attributen von CloudEvents v1. In der folgenden Tabelle werden die unterstützten Oracle Cloud Infrastructure-Metadatenattribute beschrieben.

Oracle-Metadatenattribute

Die folgenden Attribute werden im Erweiterungsfeld oci des Nachrichtenformats unterstützt. Die Benennung dieser Attribute entspricht der Attributbenennungskonvention von CloudEvents v1 , d.h. es handelt sich um alphanumerische IDs in Kleinbuchstaben mit weniger als 20 Zeichen.

Name Für Aufnahme erforderlich Angereichert für Abruf Typ Beschreibung
logid Ja - Zeichenfolge Die OCID des Logobjekts, an das die Nachricht gesendet wurde.
loggroupid Nein Ja Zeichenfolge Die OCID der Loggruppe, in der sich das Objekt befindet.
tenantid Nein Ja Zeichenfolge Die OCID des Mandanten, der Eigentümer des Logobjekts ist.
compartmentid Nein Ja Zeichenfolge Die OCID des Compartments, in dem sich das Logobjekt zum Zeitpunkt der Nachrichtenaufnahme befand.