Rozszerzenie Google Stackdriver Logging

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Wersja 1.3.7

Zapisz wpisy w logach Stackdriver Logging.

W tym artykule znajdziesz informacje na temat konfigurowania i używania tego rozszerzenia.

Wymagania wstępne

Przed użyciem tego rozszerzenia z serwera proxy interfejsu API musisz:

1. W sekcji Uprawnienia przypisz do niej Logowanie > Zapisujący logi i Logowanie > Wyświetlający logi użytkownikowi projektu, który będzie reprezentował Twoje rozszerzenie w systemie Stackdriver Logging. Instrukcje przypisywania ról znajdziesz w artykule Przypisywanie ról do konta usługi w przypadku określonych zasobów. Więcej informacji o rolach logowania znajdziesz w przewodniku po kontroli dostępu.

2. Wygeneruj klucz dla konta usługi za pomocą konsoli GCP.

3. Użyj zawartości wynikowego pliku JSON klucza podczas dodawania i konfigurowania rozszerzenia w dokumentacji konfiguracji.

To rozszerzenie obsługuje funkcję wywoływania przez zasadę ExtensionCallout w PostClientFlow. Jeśli chcesz używać zasad rozszerzeniaCallout, aby wywoływać to rozszerzenie z poziomu PostClientFlow sprawdź, czy flaga features.allowExtensionsInPostClientFlow jest ustawiona na true w Twojej organizacji.

• Jeśli korzystasz z Apigee Edge dla Public Cloud, musisz skontaktować się z zespołem pomocy Apigee Edge, aby upewnić się, że Flaga features.allowExtensionsInPostClientFlow jest ustawiona na true w Twojej organizacji.

• Jeśli jesteś klientem Apigee Edge dla Private Cloud, użyj Interfejs API aktualizacji właściwości organizacji ustaw flagę features.allowExtensionsInPostClientFlow na true.

Informacje o Stackdriver Logging

Usługa Stackdriver Logging jest częścią pakietu usług Stackdriver w Google Cloud Platform (GCP). Obejmuje ona miejsce na logi, interfejs o nazwie przeglądarka logów oraz interfejs API do automatycznego zarządzania logami. Dzięki usłudze Stackdriver Logging możesz odczytywać i zapisywać wpisy logów, wyszukiwać i filtrować logi, eksportować logi oraz tworzyć wskaźniki oparte na logach.

To rozszerzenie zapisuje obecnie wpisy w dzienniku. Więcej informacji znajdziesz w dokumentacji usługi Stackdriver Logging.

Przykłady

Poniższe przykłady pokazują, jak skonfigurować obsługę działań rozszerzenia Stackdriver Logging za pomocą zasady ExtensionCallout.

Log globalny

Poniższe zasady zapisują komunikat „To jest test” do logu o nazwie example-log w zasobie Stackdriver Global. W rzeczywistości wiadomość znajduje się prawdopodobnie w zmiennej przepływu, której wartość ustawiasz w innym miejscu na serwerze proxy API.

<?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>

W tym artykule znajdziesz informacje na temat konfigurowania i używania tego rozszerzenia. Instrukcje konfigurowania rozszerzenia za pomocą konsoli Apigee znajdziesz w artykule Dodawanie i konfigurowanie rozszerzenia.

Działania

log

Zapisuje komunikat w dzienniku.

To działanie powoduje zapisanie wpisu logu w usłudze Stackdriver. Wpisy logu składają się z metadanych i danych wpisów. Więcej informacji o wpisach logu znajdziesz w artykule Informacje o wpisach. Informacje o zawartości właściwości metadata znajdziesz w opisie obiektu LogEntry w dokumentacji usługi Stackdriver Logging.

<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" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

Parametry żądania

Odpowiedź

Brak, jeśli wiadomość została zapisana w dzienniku. W przeciwnym razie żądanie zwróci błąd. Więcej informacji znajdziesz w artykule Debugowanie rozszerzenia.

Odniesienie do konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia na potrzeby serwerów proxy interfejsu API użyj poniższych wskazówek.

Typowe właściwości rozszerzeń

Dla każdego rozszerzenia dostępne są poniższe właściwości.

Właściwości tego pakietu rozszerzeń

Określ wartości następujących właściwości konfiguracji specyficznych dla tego rozszerzenia.