Rozszerzenie Google Stackdriver Logging

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

Wersja 2.0.1

Zapisywanie wpisów w logach Stackdriver Logging.

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

Wymagania wstępne

Zanim zaczniesz używać tego rozszerzenia w proxy interfejsu API, musisz:

1. w IAM przypisać członkowi projektu uprawnienie Rejestrowanie > Zapisywanie logów, które będzie reprezentować Twoje rozszerzenie w systemie Stackdriver Logging. Instrukcje przyznawania ról znajdziesz w artykule Przyznawanie ról kontu usługi w przypadku określonych zasobów. Więcej informacji o rolach związanych z rejestrowaniem znajdziesz w przewodniku po kontroli dostępu.

2. wygenerować klucz konta usługi w konsoli Google Cloud.

3. podczas dodawania i konfigurowania rozszerzenia użyć treści wynikowego pliku JSON z kluczem, korzystając z dokumentacji konfiguracji.

Informacje o Stackdriver Logging

Stackdriver Logging jest częścią pakietu usług Stackdriver w Google Cloud. Obejmuje on miejsce na logi, interfejs użytkownika o nazwie Przeglądarka logów oraz interfejs API do programowego zarządzania logami. Dzięki Stackdriver Logging możesz odczytywać i zapisywać wpisy logów, wyszukiwać i filtrować logi, eksportować je oraz tworzyć wskaźniki oparte na logach.

To rozszerzenie zapisuje wpisy w logu.

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.

Log globalny

Ta zasada zapisuje wiadomość „To jest test” w logu 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 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 logu.

To działanie zapisuje wpis logu Stackdriver. Wpisy w logach składają się z metadanych i danych wpisu. Więcej informacji o wpisach w logach znajdziesz w dokumentacji wpisu. Informacje o zawartości właściwości metadata znajdziesz w dokumentacji Stackdriver Logging w artykule LogEntry.

<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" : "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ź

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

Dokumentacja konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użytku w proxy interfejsu API użyj tych informacji.

Wspólne właściwości rozszerzenia

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

Właściwości tego pakietu rozszerzenia

Określ wartości tych właściwości konfiguracji specyficznych dla tego rozszerzenia.