Google Cloud Logging-Erweiterung

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Version 1.6.1

Schreiben Sie Einträge in Cloud Logging-Logs.

Dieser Inhalt bietet eine Referenz zum Konfigurieren und Verwenden dieser Erweiterung.

Vorbereitung

Bevor Sie diese Erweiterung über einen API-Proxy verwenden können, müssen Sie:

1. Weisen Sie in IAM die Methode Logging > Logautor auf das Projektmitglied, das die Erweiterung im Cloud Logging-System darstellt. Eine Anleitung zum Zuweisen von Rollen finden Sie unter Einem Dienstkonto Rollen für bestimmte Ressourcen zuweisen. Weitere Informationen zu Logging-Rollen finden Sie in der Anleitung zur Zugriffssteuerung.

2. Generieren Sie mit der Google Cloud Console einen Schlüssel für das Dienstkonto.

3. Verwenden Sie den Inhalt der resultierenden JSON-Schlüsseldatei, wenn Sie die Erweiterung mithilfe der Konfigurationsreferenz hinzufügen und konfigurieren.

Diese Erweiterung kann über eine ExtensionCallout-Richtlinie aufgerufen werden, die sich in PostClientFlow befindet. Wenn Sie die ExtensionCallout-Richtlinie verwenden möchten, um die Erweiterung über eine PostClientFlow, achten Sie darauf, dass das Flag features.allowExtensionsInPostClientFlow ist in Ihrer Organisation auf true festgelegt.

• Wenn Sie Apigee Edge for Public Cloud-Kunde sind, müssen Sie sich an den Apigee Edge-Support wenden, um sicherzustellen, dass die Das Flag features.allowExtensionsInPostClientFlow ist in Ihrer Organisation auf true festgelegt.

• Wenn Sie Kunde von Apigee Edge für Private Cloud sind, verwenden Sie die API für Organisationseigenschaften aktualisieren um das Flag features.allowExtensionsInPostClientFlow auf true festzulegen.

Informationen zu Cloud Logging

Cloud Logging gehört zu den Operations-Suite. Es enthält Speicher für Logs, eine Benutzeroberfläche namens „Logs“ Explorer und eine API zur programmatischen Verwaltung von Logs. Mit Cloud Logging können Sie Lesen und Schreiben von Logeinträgen, Suchen und Filtern von Logs, Exportieren Ihrer Logs und Logbasierte Messwerte erstellen

Die Cloud Logging-Erweiterung schreibt derzeit Einträge in das Log. Weitere Informationen finden Sie in der Cloud Logging-Dokumentation.

Beispiele

Die folgenden Beispiele veranschaulichen, wie die Unterstützung für Cloud Logging konfiguriert wird Erweiterungsaktionen mithilfe der ExtensionCallout-Richtlinie.

Globales Log

Die folgende Richtlinie schreibt die Nachricht This is a test in ein Log namens example-log in der globalen Cloud-Ressource. In der Praxis würden Sie wahrscheinlich die Nachricht in einer Flussvariablen enthalten sein, deren Wert Sie an anderer Stelle festlegen im API-Proxy.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
    <DisplayName>Logging Connector</DisplayName>
    <Connector>cloud-extension-sample</Connector>
    <Action>log</Action>
    <Input><![CDATA[{
        "logName": "example-log",
        "metadata": {
            "resource": {
                "type": "global",
                "labels": {
                    "project_id": "my-test"
                }
            }
        },
        "message": "This is a test."
    }]]></Input>
</ConnectorCallout>

Dieser Inhalt bietet eine Referenz zum Konfigurieren und Verwenden dieser Erweiterung. Schritte zum Konfigurieren einer Erweiterung mit der Apigee-Konsole finden Sie unter Erweiterung hinzufügen und konfigurieren

Aktionen

log

Schreibt eine Nachricht in das Protokoll.

Durch diese Aktion wird ein Cloud Logging-Logeintrag geschrieben. Logeinträge bestehen aus Metadaten und die Eintragsdaten. Weitere Informationen zu Logeinträgen finden Sie in der Referenz des Eintrags: Informationen zum Inhalt des Attributs metadata findest du in der LogEntry -Objekt in der Cloud Logging-Dokumentation.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "cloud-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message": "This is a test."
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

Anfrageparameter

Antwort

None, wenn die Nachricht in das Log geschrieben wurde. Andernfalls gibt die Anfrage einen Fehler zurück. Weitere Informationen finden Sie unter Fehlerbehebung bei Erweiterungen.

Konfigurationsreferenz

Verwenden Sie Folgendes, wenn Sie diese Erweiterung zur Verwendung in API-Proxys konfigurieren und bereitstellen.

Allgemeine Erweiterungseigenschaften

Für jede Erweiterung sind die folgenden Eigenschaften vorhanden.

Eigenschaften für dieses Erweiterungspaket

Geben Sie Werte für die folgenden Konfigurationseigenschaften an, die für diese Erweiterung spezifisch sind.