Logging zu API-Deployments hinzufügen

Logs in Oracle Cloud Infrastructure Logging mit der Konsole konfigurieren und aktivieren

So konfigurieren und aktivieren Sie API-Deployment-Logs mit der Konsole, um Logs in Oracle Cloud Infrastructure Logging zu speichern:

1. Erstellen oder aktualisieren Sie ein API-Deployment mit der Konsole, wählen Sie die Option Völlig neu aus, und geben Sie auf der Seite Basisinformationen Details ein.

   Weitere Informationen finden Sie unter API durch das Erstellen eines API-Deployment in einem API-Gateway bereitstellen und API-Gateway aktualisieren.

2. Geben Sie auf der Seite Basisinformationen im Abschnitt API-Logging-Policys eine der folgenden Optionen als Ausführungslogebene an, um Informationen zur Verarbeitung im API-Gateway aufzuzeichnen:

   • Informationen: Zeichnen Sie eine Übersicht über jede Verarbeitungsphase auf. Dies ist die Standardoption.
   • Warnung: Zeichnen Sie nur transiente Fehler auf, die während der Verarbeitung auftreten. Beispiel: Eine zurückgesetzte Verbindung.
   • Fehler: Zeichnen Sie nur persistente Fehler auf, die während der Verarbeitung auftreten. Beispiel: Ein interner Fehler oder ein Aufruf einer Funktion, die eine 404-Meldung zurückgibt.

3. Wählen Sie zweimal Weiter aus, um Details zu einzelnen Routen im API-Deployment auf der Seite Routen einzugeben, und wählen Sie Routenlogging-Policys anzeigen aus.

4. Geben Sie eine der folgenden Optionen als Override für Ausführungslogebene an, der für eine einzelne Route gilt (um die vom API-Deployment geerbte Ausführungslogebene außer Kraft zu setzen):

   • Informationen: Zeichnen Sie eine Übersicht über jede Verarbeitungsphase auf.
   • Warnung: Zeichnen Sie nur transiente Fehler auf, die während der Verarbeitung auftreten. Beispiel: Eine zurückgesetzte Verbindung.
   • Fehler: Zeichnen Sie nur persistente Fehler auf, die während der Verarbeitung auftreten. Beispiel: Ein interner Fehler oder ein Aufruf einer Funktion, die eine 404-Meldung zurückgibt.
5. Wählen Sie Weiter aus, um die Details zu prüfen, die Sie für das API-Deployment eingegeben haben.
6. Wählen Sie Erstellen oder Änderungen speichern aus, um das API-Deployment zu erstellen oder zu aktualisieren.

   Das API-Deployment wird auf der Seite API-Deployment-Details angezeigt.

7. Wählen Sie unter Ressourcen die Option Logs aus, und wählen Sie den Schieber Logging aktivieren aus, um ein neues API-Deployment-Log im Oracle Cloud Infrastructure Logging-Service im Eingabebereich Log erstellen zu erstellen und zu aktivieren:
   • Compartment: Standardmäßig das aktuelle Compartment.
   • Loggruppe: Standardmäßig die erste Loggruppe im Compartment.
   • Logkategorie: Wählen Sie Ausführung oder Zugriff aus.
   • Logname: Standardmäßig <deployment-name>_execution oder <deployment-name>_access, je nachdem, welche Kategorie Sie auswählen.

   Weitere Informationen finden Sie unter Logging für eine Ressource aktivieren.

8. Wählen Sie Log aktivieren aus, um das neue Log zu erstellen und zu aktivieren.

JSON-Datei bearbeiten, um die Ausführungslogebene für in Oracle Cloud Infrastructure Logging gespeicherte Logs festzulegen

So bearbeiten Sie die API-Deployment-Spezifikation in einer JSON-Datei, um die Logebene für Ausführungslogs festzulegen, die in Oracle Cloud Infrastructure Logging gespeichert sind:

1. Bearbeiten Sie in Ihrem bevorzugten JSON-Editor die vorhandene API-Deployment-Spezifikation, in der Sie die Loggingebene für in Oracle Cloud Infrastructure Logging gespeicherte Logs festlegen möchten, oder erstellen Sie eine neue API-Deployment-Spezifikation (siehe API-Deployment-Spezifikation erstellen).

   Die API-Deployment-Spezifikation beinhaltet zumindest einen routes-Abschnitt, der Folgendes enthält:

   • Einen Pfad. Beispiel: /hello
   • Mindestens eine Methode. Beispiel: GET
   • Eine Definition eines Backends. Beispiel: Eine URL oder die OCID einer Funktion in OCI Functions.

   Beispiel: Die folgende Basisspezifikation für das API-Deployment definiert eine einfache serverlose Hello World-Funktion in OCI Functions als einzelnes Backend:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

2. (Optional) So legen Sie die Logebene für Ausführungslogs fest, die global für alle Routen in der API-Deployment-Spezifikation gilt:

   1. Fügen Sie einen loggingPolicies-Abschnitt vor dem routes-Abschnitt ein. Beispiel:

      
      {
        "loggingPolicies": {},
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

   2. Geben Sie die Detailebene an, mit der die Verarbeitung innerhalb des API-Gateways für alle Routen aufgezeichnet werden soll, indem Sie die executionLog-Policy in den Abschnitt loggingPolicies aufnehmen und die logLevel-Eigenschaft auf einen der folgenden Werte setzen:

      • INFO, um eine Übersicht über jede Verarbeitungsphase aufzuzeichnen.
      • WARN, um nur transiente Fehler aufzuzeichnen, die während der Verarbeitung auftreten. Beispiel: Eine zurückgesetzte Verbindung.
      • ERROR, um nur persistente Fehler aufzuzeichnen, die während der Verarbeitung auftreten. Beispiel: Ein interner Fehler oder ein Aufruf einer Funktion, die eine 404-Meldung zurückgibt.

      Beispiel:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

3. (Optional) So legen Sie die Logebene für Ausführungslogs für eine bestimmte Route fest (und setzen die vom API-Deployment geerbte globale Ausführungslogebene außer Kraft):

   1. Fügen Sie einen loggingPolicies-Abschnitt nach dem backend-Abschnitt der Route ein. Beispiel:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "loggingPolicies": {}
          }
        ]
      }

   2. Geben Sie die Detailebene an, mit der die Verarbeitung innerhalb des API-Gateways für die Route aufgezeichnet werden soll, indem Sie die executionLog-Policy in den Abschnitt loggingPolicies aufnehmen und die logLevel-Eigenschaft auf einen der folgenden Werte setzen:

      • INFO, um eine Übersicht über jede Verarbeitungsphase aufzuzeichnen.
      • WARN, um nur transiente Fehler aufzuzeichnen, die während der Verarbeitung auftreten. Beispiel: Eine zurückgesetzte Verbindung.
      • ERROR, um nur persistente Fehler aufzuzeichnen, die während der Verarbeitung auftreten. Beispiel: Ein interner Fehler oder ein Aufruf einer Funktion, die eine 404-Meldung zurückgibt.

      Beispiel:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "loggingPolicies": {
              "executionLog": {
                "logLevel": "ERROR"
              }
            }
          }
        ]
      }

4. Speichern Sie die JSON-Datei, die die API-Deployment-Spezifikation enthält.

5. Verwenden Sie die API-Deployment-Spezifikation, wenn Sie ein API-Deployment wie folgt erstellen oder aktualisieren:

   • Durch Angabe der JSON-Datei in der Konsole bei Auswahl der Option Vorhandene API hochladen
   • Durch Angabe der JSON-Datei in einer Anforderung an die REST-API von API-Gateway

   Weitere Informationen finden Sie unter API durch das Erstellen eines API-Deployments in einem API-Gateway bereitstellen.

6. Nachdem Sie die Logebene für Ausführungslogs festgelegt haben, befolgen Sie die Anweisungen unter Logging für eine Ressource aktivieren, um ein neues API-Deployment-Log im Oracle Cloud Infrastructure Logging-Service zu erstellen und zu aktivieren.

Logs in Oracle Cloud Infrastructure Logging anzeigen

Sie können den Inhalt eines API-Deployment-Logs in Oracle Cloud Infrastructure Logging auf der Seite API-Deployment-Details anzeigen. Wählen Sie unter Ressourcen die Option Logs aus, und wählen Sie dann den Namen des Logs aus, das Sie anzeigen möchten.

Alternativ können Sie den Inhalt eines API-Deployment-Logs auf der Seite Logsuche von Oracle Cloud Infrastructure Logging anzeigen. Siehe Details eines Logs abrufen.

Weitere Informationen zum Inhalt von Zugriffs- und Ausführungslogs finden Sie unter:

• API-Deployment-Zugriffslog
• API-Deployment-Ausführungslog