Rozszerzenie Google Stackdriver Logging

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

Wersja 1.3.7

Zapisywanie wpisów w logach Stackdriver Logging.

Te treści zawierają informacje o konfigurowaniu i używaniu tego rozszerzenia.

Wymagania wstępne

Zanim użyjesz tego rozszerzenia w proxy interfejsu API, musisz:

1. W IAM przypisz rolę Rejestrowanie > Zapisujący logi i Rejestrowanie > Wyświetlający logi do członka projektu, który będzie reprezentować Twoje rozszerzenie w systemie Stackdriver Logging. Instrukcje przyznawania ról znajdziesz w artykule Przyznawanie ról kontu usługi w odniesieniu do określonych zasobów. Więcej informacji o rolach logowania znajdziesz w przewodniku po kontroli dostępu.

2. Wygeneruj klucz konta usługi w konsoli GCP

3. Podczas dodawania i konfigurowania rozszerzenia za pomocą dokumentacji konfiguracji użyj zawartości utworzonego pliku JSON z kluczem.

To rozszerzenie obsługuje wywoływanie przez zasadę ExtensionCallout znajdującą się w PostClientFlow. Jeśli chcesz użyć zasady ExtensionCallout, aby wywołać to rozszerzenie z poziomu PostClientFlow, upewnij się, że w Twojej organizacji flaga features.allowExtensionsInPostClientFlow jest ustawiona na true.

• Jeśli jesteś klientem Apigee Edge w chmurze publicznej, 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 (Aktualizowanie właściwości organizacji), aby ustawić flagę features.allowExtensionsInPostClientFlow na true.

Informacje o Stackdriver Logging

Stackdriver Logging to jedna z usług wchodzących w skład pakietu Stackdriver w Google Cloud Platform (GCP). Obejmuje on miejsce na dane logów, interfejs użytkownika o nazwie Przeglądarka logów oraz interfejs API do programowego zarządzania logami. Usługa Stackdriver Logging umożliwia odczytywanie i zapisywanie wpisów w logach, wyszukiwanie i filtrowanie logów, eksportowanie logów oraz tworzenie wskaźników opartych na logach.

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

Przykłady

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

Dziennik globalny

Poniższa zasada zapisuje wiadomość „This is a test” w dzienniku o nazwie example-log w zasobie globalnym Stackdriver. W praktyce wiadomość prawdopodobnie będzie zawarta w zmiennej przepływu, której wartość ustawisz 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>

Te treści zawierają informacje o konfigurowaniu i używaniu tego rozszerzenia. Instrukcje konfigurowania rozszerzenia za pomocą konsoli Apigee znajdziesz w artykule Dodawanie i konfigurowanie rozszerzenia.

Działania

log

Zapisuje wiadomość w dzienniku.

Ta czynność zapisuje wpis logu Stackdriver. Wpisy logów składają się z metadanych i danych wpisu. Więcej informacji o wpisach w dzienniku znajdziesz w materiałach referencyjnych dotyczących wpisów. Informacje o zawartości właściwości metadata znajdziesz w obiekcie LogEntry w dokumentacji 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.

Odwołanie do konfiguracji

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

Wspólne 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 tych właściwości konfiguracji, które są specyficzne dla tego rozszerzenia.