Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
.Wersja 1.6.0
Zapisz wpisy w logach Cloud Logging.
W tym artykule znajdziesz informacje na temat konfigurowania i używania tego rozszerzenia.
Wymagania wstępne
Przed użyciem tego rozszerzenia z serwera proxy interfejsu API musisz:
W sekcji Uprawnienia przypisz do niej Logowanie > Zapisujący logi użytkownikowi projektu, który będzie reprezentował rozszerzenie w systemie Cloud Logging. Instrukcje przypisywania ról znajdziesz w artykule Przypisywanie ról do konta usługi w przypadku określonych zasobów. Więcej informacji o rolach logowania znajdziesz w przewodniku po kontroli dostępu.
Wygeneruj klucz dla konta usługi za pomocą konsoli Google Cloud.
Użyj zawartości wynikowego pliku JSON klucza podczas dodawania i konfigurowania rozszerzenia w dokumentacji konfiguracji.
To rozszerzenie obsługuje funkcję wywoływania przez zasadę ExtensionCallout w PostClientFlow.
Jeśli chcesz używać zasad rozszerzeniaCallout, aby wywoływać to rozszerzenie z poziomu
PostClientFlow sprawdź, czy 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 natrue
w Twojej organizacji.Jeśli jesteś klientem Apigee Edge dla Private Cloud, użyj Interfejs API aktualizacji właściwości organizacji ustaw flagę
features.allowExtensionsInPostClientFlow
natrue
.
Informacje o Cloud Logging
.Cloud Logging jest częścią usługi Google Cloud pakiet operacyjny. Obejmuje miejsce na logi, interfejs użytkownika o nazwie Logi oraz interfejs API do automatycznego zarządzania dziennikami. Dzięki Cloud Logging możesz: odczytywanie i zapisywanie wpisów w dziennikach, wyszukiwanie i filtrowanie dzienników, eksportowanie logów oraz i tworzą wskaźniki oparte na logach.
Rozszerzenie Cloud Logging obecnie zapisuje wpisy w logu. Aby zobaczyć więcej, zobacz dokumentację Cloud Logging.
Przykłady
Poniższe przykłady pokazują, jak skonfigurować obsługę Cloud Logging działania rozszerzenia, korzystając z zasad rozszerzenia ExtensionCallout.
Log globalny
Ta zasada zapisuje wiadomość This is a test
w logu o nazwie
example-log
w zasobie Cloud Global. W praktyce prawdopodobnie
wiadomość będzie zawarta w zmiennej przepływu, której wartość jest ustawiona w innym miejscu.
za pośrednictwem 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>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>
W tym artykule znajdziesz informacje na temat konfigurowania i używania tego rozszerzenia. Instrukcje konfigurowania rozszerzenia za pomocą konsoli Apigee znajdziesz tutaj: Dodawanie i konfigurowanie rozszerzenia
Działania
log
Zapisuje komunikat w dzienniku.
To działanie powoduje zapisanie wpisu logu Cloud Logging. Wpisy logu zawierają metadane
oraz danych wejściowych. Więcej informacji o wpisach logu znajdziesz w
Odniesienie do wpisu.
Informacje o zawartości właściwości metadata
znajdziesz tutaj:
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ślny | Wymagane |
---|---|---|---|---|
logName |
Nazwa dziennika, do którego należy ten wpis. | Ciąg znaków | Brak | Tak |
metadata |
Metadane wpisu w dzienniku. Więcej informacji oraz opcji związanych z ustawieniem type i labels w usłudze metadata znajdziesz w artykule MonitoredResource. |
JSON | Brak | Nie |
message |
Dane, które mają zostać użyte jako wartość tego wpisu logu. Możesz podać prosty ciąg znaków lub użyć formatu JSON, aby zapisać bardziej uporządkowany komunikat. | Ciąg znaków lub JSON | Brak | Tak |
Odpowiedź
None
, jeśli wiadomość została zapisana w dzienniku. W przeciwnym razie żądanie zwróci błąd. Więcej informacji znajdziesz w artykule Debugowanie rozszerzenia.
Dokumentacja konfiguracji
Podczas konfigurowania i wdrażania tego rozszerzenia na potrzeby serwerów proxy interfejsów API użyj poniższych wskazówek.
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ń
Określ wartości następujących właściwości konfiguracji specyficznych dla tego rozszerzenia.
Właściwość | Opis | Domyślny | Wymagane |
---|---|---|---|
projectId |
Identyfikator projektu Google Cloud, w którym mają być tworzone logi. | Brak | Tak |
credentials |
Wprowadzona w konsoli Apigee Edge plik ten zawiera zawartość pliku klucza konta usługi. W przypadku wysyłania przez interfejs API zarządzania jest to wartość zakodowana w formacie base64 generowana na podstawie pliku klucza konta usługi. | Brak | Tak |