Rozszerzenie Google Stackdriver Logging

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wersja 1.3.7

Utwórz wpisy w logach Stackdriver Logging.

Ta treść zawiera informacje na temat konfigurowania tego rozszerzenia i korzystania z niego.

Wymagania wstępne

Zanim użyjesz tego rozszerzenia z poziomu serwera proxy interfejsu API, musisz:

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

2. Wygeneruj klucz konta usługi w konsoli GCP.

3. Podczas dodawania i konfigurowania rozszerzenia przy użyciu dokumentu dotyczącego konfiguracji użyj zawartości powstałego klucza pliku JSON.

To rozszerzenie jest wywoływane przez zasadę ExtensionCallout znajdującą się w elemencie PostClientFlow. Jeśli chcesz używać zasady Extensionobjaśnień do wywoływania tego rozszerzenia z poziomu PostClientFlow, upewnij się, że 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 korzystasz z Apigee Edge dla Private Cloud, użyj interfejsu API Aktualizowanie właściwości organizacji, aby ustawić flagę features.allowExtensionsInPostClientFlow na true.

Informacje o usłudze Stackdriver Logging

Stackdriver Logging jest częścią pakietu usług Stackdriver w Google Cloud Platform (GCP). Obejmuje miejsce na logi, interfejs użytkownika o nazwie Przeglądarka logów oraz interfejs API, który umożliwia programowe zarządzanie logami. Usługa Stackdriver Logging pozwala odczytywać i zapisywać wpisy logu, przeszukiwać i filtrować logi, eksportować logi oraz tworzyć wskaźniki oparte na logach.

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

Sample

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

Dziennik globalny

Poniższa zasada zapisuje komunikat „To jest test” w logu o nazwie example-log w zasobie usługi Stackdriver Global. W rzeczywistym użyciu wiadomość prawdopodobnie zostałaby zawarta w zmiennej przepływu, której wartość została ustawiona w innym miejscu serwera proxy interfejsu 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>

Ta treść zawiera informacje na temat konfigurowania tego rozszerzenia i korzystania z niego. Instrukcje konfigurowania rozszerzenia w konsoli Apigee znajdziesz w artykule Dodawanie i konfigurowanie rozszerzenia.

Działania

log

Zapisuje komunikat w dzienniku.

To działanie zapisuje wpis logu usługi Stackdriver. Wpisy logu składają się z metadanych i danych wpisu. Więcej informacji o wpisach w dzienniku znajdziesz w dokumentacji wpisu. Informacje o zawartości właściwości metadata znajdziesz w sekcji dotyczącej 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. Zobacz też Debugowanie rozszerzenia.

Dokumentacja konfiguracji

Skorzystaj z podanych niżej instrukcji podczas konfigurowania i wdrażania tego rozszerzenia na potrzeby serwerów proxy interfejsów API.

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ń

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