Rozszerzenie Google Cloud Logging

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wersja 2.0.0

zapisywać wpisy w logach Cloud Logging.

Te treści zawierają informacje na temat konfigurowania i używania tego rozszerzenia.

Wymagania wstępne

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

1. W usłudze IAM przypisz rolę Rejestrowanie > Zapisujący logi użytkownikowi projektu, który będzie reprezentować Twoje rozszerzenie w systemie Cloud Logging. Instrukcje przyznawania ról znajdziesz w artykule Przypisywanie ról kontu usługi w przypadku określonych zasobów. Więcej informacji o logowaniu ról znajdziesz w przewodniku po kontroli dostępu.

2. Wygeneruj klucz konta usługi w konsoli Google Cloud.

3. Użyj zawartości utworzonego pliku klucza JSON podczas dodawania i konfigurowania rozszerzenia za pomocą dokumentacji konfiguracji.

To rozszerzenie może być wywoływane przez zasady dotyczące rozszerzenia objaśnień znajdujące się w PostClientFlow. Jeśli chcesz użyć zapisu w zasadach ExtensionCallout, aby wywołać to rozszerzenie z PostClientFlow, upewnij się, że w Twojej organizacji flaga features.allowExtensionsInPostClientFlow jest ustawiona na true.

• Jeśli jesteś klientem Apigee Edge for Public Cloud, musisz skontaktować się z zespołem pomocy Apigee Edge, aby upewnić się, że w Twojej organizacji flaga features.allowExtensionsInPostClientFlow ma wartość true.

• Jeśli jesteś klientem Apigee Edge for Private Cloud, użyj interfejsu API Update organization properties (Aktualizuj 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. Zawiera miejsce na logi, interfejs użytkownika o nazwie eksplorator logów oraz interfejs API do zarządzania logami w sposób programowy. Dzięki Cloud Logging możesz odczytywać i zapisywać wpisy w logach, wyszukiwać i filtrować logi, eksportować logi oraz tworzyć wskaźniki oparte na logach.

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

Przykłady

Poniższe przykłady pokazują, jak skonfigurować obsługę działań rozszerzenia Cloud Logging za pomocą zasad dotyczących powiadomień o rozszerzeniu.

Dziennik globalny

Podana niżej zasada zapisuje wiadomość This is a test w logu o nazwie example-log w zasobie globalnym Cloud. W praktyce wiadomość będzie prawdopodobnie zawarta w zmiennej przepływu, której wartość ustawisz w innym miejscu w interfejsie 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>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>

Te treści zawierają 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 wiadomość w dzienniku.

To działanie powoduje zapisanie wpisu w logach Cloud Logging. Wpisy logów składają się z metadanych i danych wpisu. Więcej informacji o rekordach logowania znajdziesz w materiałach referencyjnych. Informacje o zawartości właściwości metadata znajdziesz w dokumentacji Cloud Logging dotyczącej obiektu LogEntry.

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

Parametry żądania

Odpowiedź

None, jeśli wiadomość została zapisana w dzienniku. W przeciwnym razie żądanie zwróci błąd. Zobacz też Debugowanie rozszerzenia.

Informacje o konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użycia w serwerach proxy API postępuj zgodnie z tymi instrukcjami.

Właściwości wspólne rozszerzeń

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

Właściwości tego pakietu rozszerzeń

Podaj wartości tych właściwości konfiguracji, które są specyficzne dla tego rozszerzenia.