Google Stackdriver 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.2.1

Schreiben Sie Einträge in Stackdriver 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 das Logging > Log-Autor-Berechtigung für das Projektmitglied, das Ihre Erweiterung im Stackdriver 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 GCP 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.

Informationen zu Stackdriver Logging

Stackdriver Logging ist Teil der Stackdriver-Produktsuite der Google Cloud Platform (GCP). Dazu gehören Speicher für Logs, eine Benutzeroberfläche namens „Loganzeige“ und eine API für die programmatische Verwaltung von Logs. Mit Stackdriver Logging können Sie Logeinträge lesen und schreiben, Logs suchen und filtern, Logs exportieren und logbasierte Messwerte erstellen.

Diese Erweiterung schreibt derzeit Einträge in das Protokoll.

Weitere Informationen finden Sie in der Dokumentation zu Stackdriver Logging.

Beispiele

Die folgenden Beispiele zeigen, wie Sie die Unterstützung für Stackdriver Logging-Erweiterungsaktionen mithilfe der ExtensionCallout-Richtlinie konfigurieren.

Globales Log

Die folgende Richtlinie schreibt die Nachricht „Dies ist ein Test“. zu einem Log namens example-log in der globalen Stackdriver-Ressource. In der Praxis würde die Nachricht wahrscheinlich in einer Flussvariablen enthalten sein, deren Wert Sie an anderer Stelle im API-Proxy festlegen.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
    <DisplayName>Logging Connector</DisplayName>
    <Connector>stackdriver-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. Eine schrittweise Anleitung 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 Stackdriver-Logeintrag geschrieben. Logeinträge bestehen aus Metadaten und den Eintragsdaten. Weitere Informationen zu Logeinträgen finden Sie in der Eintragsreferenz. Informationen zum Inhalt des Attributs metadata finden Sie in der Stackdriver Logging-Dokumentation zum Objekt LogEntry.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-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

Keine, wenn die Nachricht in das Protokoll 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.