Rozszerzenie Google Stackdriver Logging

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

Wersja 1.2.0

zapisywać wpisy w logach Stackdriver 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 uprawnienia Rejestrowanie > Zapisywanie logów członkowi projektu, który będzie reprezentować Twoje rozszerzenie w systemie Stackdriver 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 GCP.

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

Informacje o Stackdriver Logging

Stackdriver Logging jest częścią pakietu usług Stackdriver w Google Cloud Platform (GCP). Zawiera miejsce na dzienniki, interfejs użytkownika o nazwie Podgląd dzienników oraz interfejs API do zarządzania dziennikami w sposób programowy. 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 Logowania Stackdriver za pomocą zapisu ExtensionCalloutPolicy.

Dziennik globalny

Podana niżej zasada zapisuje wiadomość „To jest test” w pliku logów o nazwie example-log w zasobie globalnym Stackdriver. W praktyce wiadomość będzie prawdopodobnie zawarta w zmiennej przepływu, której wartość ustawisz gdzieś indziej w interfejsie 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 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.

Ta czynność zapisuje wpis w logu Stackdriver. Wpisy w logach zawierają metadane i dane wpisu. Więcej informacji o rekordach dziennika znajdziesz w materiałach referencyjnych. Informacje o zawartości właściwości metadata znajdziesz w dokumentacji Stackdriver Logging w obiekcie 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" : "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.

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.