Rozszerzenie Google Cloud Logging

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

Wersja 1.6.1

Zapisz wpisy w logach Cloud 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 członkowi projektu, który będzie reprezentować Twoje rozszerzenie systemu Cloud 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 za pomocą konsoli Google Cloud.

  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 Cloud Logging

Cloud Logging jest częścią pakietu operacyjnego Google Cloud. Obejmuje miejsce na logi, interfejs o nazwie eksplorator logów oraz interfejs API umożliwiający programowe zarządzanie logami. Dzięki Cloud Logging możesz odczytywać i zapisywać wpisy logu, wyszukiwać i filtrować logi, eksportować logi oraz tworzyć wskaźniki oparte na logach.

Rozszerzenie Cloud Logging zapisuje obecnie wpisy w logu. Więcej informacji znajdziesz w dokumentacji Cloud Logging.

Sample

Przykłady poniżej pokazują, jak skonfigurować obsługę działań rozszerzenia Cloud Logging za pomocą zasady ExtensionCallout.

Dziennik globalny

Poniższa zasada zapisuje komunikat This is a test w logu o nazwie example-log w zasobie Cloud Global. W rzeczywistości wiadomość najprawdopodobniej zostałaby zawarta w zmiennej przepływu, której wartość została ustawiona w innym miejscu na serwerze 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>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>

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

Działania

log

Zapisuje komunikat w dzienniku.

To działanie zapisuje wpis logu Cloud Logging. 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 opisie obiektu LogEntry w dokumentacji Cloud Logging.

Składnia

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

Przykład: ciąg znaków

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

Przykład: JSON

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

Parametry żądania

Parametr Opis Typ Domyślne Wymagane
logName Nazwa dziennika, do którego należy ten wpis. Ciąg znaków Brak Tak
metadata Metadane wpisu logu.
Więcej informacji i informacji o ustawieniach type i labels w usłudze metadata znajdziesz w artykule MonitoredResource.
JSON Brak Nie
message Dane do użycia jako wartość tego wpisu logu. Możesz podać prosty ciąg lub użyć formatu JSON, aby zapisać bardziej uporządkowaną wiadomość. Ciąg tekstowy lub JSON Brak Tak

Odpowiedź

None, 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.

Usługa Opis Domyślnie Wymagany
name Nazwa nadana konfiguracji rozszerzenia. Brak Tak
packageName Nazwa pakietu rozszerzeń podana przez Apigee Edge. Brak Tak
version Numer wersji pakietu rozszerzenia, z którego konfigurujesz rozszerzenie. Brak Tak
configuration Wartość konfiguracji specyficzna dla dodawanego rozszerzenia. Zobacz Właściwości tego pakietu rozszerzeń Brak Tak

Właściwości tego pakietu rozszerzeń

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

Właściwość Opis Domyślne Wymagane
projectId Identyfikator projektu Google Cloud, w którym mają być tworzone logi. Brak Tak
credentials Wpisana w konsoli Apigee Edge jest to zawartość pliku klucza konta usługi. Gdy jest wysyłana przez interfejs API zarządzania, jest to wartość zakodowana w formacie base64 wygenerowana z pliku klucza konta usługi. Brak Tak