Cloud Monitoring zbiera wskaźniki dotyczące interfejsów API i usługi oraz zasobów Google Cloud Platform, których używasz. Z tego artykułu dowiesz się, jak skonfigurować usługę Cloud Monitoring oraz jak używać jej do monitorowania użycia interfejsu API, tworzenia paneli i tworzenia alertów.
Cloud Monitoring udostępnia duży zestaw funkcji i opcji. W tym temacie omawiamy usługę Cloud Monitoring i przedstawiamy jej podstawowe przykłady. Informacje o wszystkich funkcjach (w tym wiele innych przykładów) znajdziesz w dokumentacji Cloud Monitoring.
Konfigurowanie Cloud Monitoring
Monitorowanie umożliwia wyświetlanie wskaźników i zarządzanie nimi:
- Dla pojedynczego projektu
- Dla wielu projektów w jednej organizacji
- Dla wielu projektów w wielu organizacjach
Aby mieć pewność, że wskaźniki dotyczące Twoich projektów są dostępne, wykonaj te czynności:
- W konsoli Google Cloud wybierz Monitorowanie:
- Sprawdź, czy został wybrany właściwy projekt.
- W panelu nawigacji Monitorowanie kliknij > po prawej stronie opcji Zakres wskaźników.
Poniższy zrzut ekranu przedstawia stronę, która wyświetla się po wybraniu projektu AllEnvironments:
Tabela Wskaźniki monitorowane przez ten projekt zawiera listę projektów, których wskaźniki są dostępne dla bieżącego zakresu wskaźników. Każdy wiersz w tabeli zawiera nazwę projektu i jego roli:
- Projekt określający zakres: w tym projekcie przechowywane są kontrole dostępności, zasady tworzenia alertów, grupy i panele. Zakres wskaźników i projekt określania zakresu występuje w relacji 1:1. W tym przykładzie projekt określania zakresu to projekt AllEnvironments.
- Monitorowany projekt: wskaźniki dotyczące projektu są widoczne w bieżącym zakresie wskaźników. W tym przykładzie projekty przejściowe i produkcyjne są monitorowane.
Tabela Wymienione poniżej projekty mogą wyświetlać wskaźniki tego projektu zawiera listę projektów, których zakres wskaźników obejmuje bieżący projekt. Na poprzednim zrzucie ekranu widać, że żadne inne projekty nie mają dostępu do wskaźników przechowywanych w projekcie AllEnvironments.
Więcej informacji, w tym instrukcje dodawania i usuwania projektów, znajdziesz w artykule Konfigurowanie Cloud Monitoring.
Zbadaj wskaźniki
Aby przeanalizować dane wskaźników, utwórz wykres za pomocą narzędzia Metrics Explorer , które jest dostępne w Cloud Monitoring. Jeśli na przykład chcesz wyświetlić wykorzystanie limitu interfejsu API, możesz użyć narzędzia Metrics Explorer do utworzenia wykresu przedstawiającego najnowsze dane.
Na tej ilustracji znajdziesz wykres ze szczegółowymi informacjami o wykorzystaniu limitu przez interfejsy API Map Google:
W tym przykładzie pokazano skumulowany wykres słupkowy, na którym każdy interfejs API jest reprezentowany przez sekcję słupka. Możesz tworzyć różne typy wykresów, na przykład wykresy liniowe, słupkowe i mapy termiczne. Możesz też utworzyć pojedynczy wykres zawierający do 10 różnych rodzajów danych.
Na tym obrazie:
- Pola Typ zasobu i Wskaźnik po lewej stronie wykresu określają dane wskaźników wyświetlane na wykresie.
- W menu typu wykresu nad wykresem możesz wybrać typ wykresu. W tym przykładzie ustawiona jest wartość Skumulowany wykres słupkowy.
- Przedział czasu nad wykresem jest ustawiony na 1 W (1 tydzień).
- Poniżej wykresu znajduje się lista usług, quota_metrics, metody interfejsu API i wartości wskaźnika, które definiują dane na wykresie. Aby użyć tych informacji do doprecyzowania wyświetlanych danych, kliknij Dodaj filtr.
Gdy opuścisz stronę Metrics Explorer, wykres zostanie odrzucony, więc nie będzie żadnych zbędnych artefaktów do usunięcia. Możesz też zapisać wykres w niestandardowym panelu lub go udostępnić. Więcej informacji o dodawaniu wykresu do panelu znajdziesz w sekcji Tworzenie paneli poniżej.
Przedstaw jeden rodzaj danych na wykresie
Aby skonfigurować wykres za pomocą narzędzia Metrics Explorer:
- W konsoli Cloud wybierz Monitorowanie:
- W panelu nawigacji kliknij Metrics Explorer.
- Na pasku narzędzi z menu typu wykresu wybierz Skumulowany wykres słupkowy, aby wyświetlić dane w postaci wykresu słupkowego.
- Wybierz przedział czasu, na przykład 1 W (1 tydzień).
- Określ dane, które mają być widoczne na wykresie. Aby użyć interfejsu z menu lub dodać filtr, wybierz kartę Konfiguracja. Aby używać języka zapytań monitorowania (MQL), wybierz kartę MQL.
- Aby wyświetlić wykres wykorzystania limitu, wybierz Limit klienta jako Typ zasobu. Jeśli chcesz utworzyć wykres wykorzystania interfejsu API, wybierz Consumed API lub Google Maps API (więcej informacji o wskaźnikach wykorzystania dostępnych dla interfejsów Google Maps Platform API znajdziesz w sekcji Wskaźniki wykorzystania). Najeżdżaj kursorem na poszczególne typy zasobów, aby zobaczyć ich opisy.
- Jako dane wybierz Wykorzystanie limitu stawki. Wykres jest automatycznie aktualizowany, aby wyświetlał dane wskaźników. Zwróć uwagę, że dostępne są też inne opcje limitów dla wskaźnika. Najedź kursorem na poszczególne dane, by wyświetlić ich opis. Więcej informacji o polach narzędzia Metrics Explorer znajdziesz w artykułach o wybieraniu wskaźników i wybieraniu sposobu wyświetlania danych na wykresie.
- (Opcjonalnie) Aby zawęzić wyświetlanie, użyj tych opcji:
- Aby określić podzbiór danych do wyświetlenia, dodaj filtry. Aby dodać filtr, wybierz Dodaj filtr i zamknij okno. Więcej informacji znajdziesz w artykule o filtrowaniu danych na wykresie. Aby na przykład wyświetlić dane dotyczące pojedynczego interfejsu API:
- W polu Etykieta wybierz metodę.
- W polu Porównanie wybierz = (równa się).
- W polu Wartość wybierz nazwę konkretnej metody. Pojawi się prośba o wybranie nazwy metody, której dane mają być wyświetlane.
- Aby zaktualizować wykres, kliknij Gotowe .
- Aby pogrupować ciągi czasowe według etykiety, użyj pola Grupuj według. Wybór wartości w tym polu powoduje automatyczne wybranie wartości w polu Agregator.
- Aby określić sposób łączenia ciągów czasowych, ustaw pole Agregator. Jeśli np. pole Pogrupuj według jest puste, a w polu Agregator znajduje się wartość średnia, na wykresie wyświetlana jest średnia ciągu czasowego.
- Aby skonfigurować sposób przetwarzania poszczególnych ciągów czasowych, wybierz Opcje zaawansowane. Więcej informacji znajdziesz w artykule Wybieranie wskaźników w przypadku korzystania z narzędzia Metrics Explorer.
- Aby określić podzbiór danych do wyświetlenia, dodaj filtry. Aby dodać filtr, wybierz Dodaj filtr i zamknij okno. Więcej informacji znajdziesz w artykule o filtrowaniu danych na wykresie. Aby na przykład wyświetlić dane dotyczące pojedynczego interfejsu API:
Możesz też dodać go do panelu.
Gdy opuścisz stronę Metrics Explorer, wykres zostanie odrzucony. Możesz opcjonalnie wybrać Zapisz wykres, aby zapisać wykres w nowym lub istniejącym panelu. Więcej informacji o dodawaniu wykresu do panelu znajdziesz w sekcji Tworzenie paneli poniżej.
Wyświetlanie wielu danych na wykresie
Czasem może być pożądane wyświetlenie wielu wskaźników na tym samym wykresie. Możesz na przykład pokazać limit na tych samych wykresach, na których pokazujesz wykorzystanie limitu. Na wykresie może wyświetlać się maksymalnie 10 rodzajów danych.
Aby dodać dane do istniejącego wykresu:
- Na dotychczasowym wykresie u dołu ekranu wybierz Dodaj inne dane.
- Wybierz wskaźnik, a następnie określ, jak ma być wyświetlany ciąg czasowy dla tego wskaźnika w taki sam sposób, w jaki został on skonfigurowany powyżej.
Przydatne materiały
Więcej informacji o eksplorowaniu danych znajdziesz w tych artykułach:
- Tworzenie wykresów za pomocą narzędzia Metrics Explorer
- Wybieranie danych w narzędziu Metrics Explorer
- Wskaźniki dostępne dla wszystkich interfejsów Google Cloud APIs
- Dane specyficzne dla interfejsów Google Maps Platform API
- Wykres danych rozkładu
- Wyświetl opcje
Tworzenie paneli
Panele umożliwiają wyświetlanie i monitorowanie danych ciągów czasowych w formie kolekcji wykresów. Cloud Monitoring obsługuje wstępnie zdefiniowane panele i panele niestandardowe:
- Wstępnie zdefiniowane panele są automatycznie instalowane na potrzeby usług Google Cloud Platform, z których korzystasz. Tych paneli nie można konfigurować.
- Panele niestandardowe to panele, które tworzysz. Panele niestandardowe pozwalają określić, jakie dane chcesz wyświetlać, oraz jak je wyświetlać. Możesz na przykład wyświetlić dane wskaźników, zasady tworzenia alertów i logi przechowywane w projekcie. Dane ciągów czasowych możesz wyświetlić na wykresie, za pomocą wskaźnika lub podsumowania statystyk albo w postaci tabeli.
Aby utworzyć niestandardowe panele, możesz użyć konsoli Cloud lub interfejsu Cloud Monitoring API. Poniższy obraz przedstawia panel niestandardowy z 2 wykresami:
- Wykres limitu po lewej stronie
- Wykres liczby interfejsów API po prawej stronie
Utwórz panel niestandardowy, tworząc wykresy wskaźników, a następnie dodając je do panelu. Możesz utworzyć wykres w Metrics Explorer, a następnie dodać go do nowego lub istniejącego panelu. Możesz też utworzyć panel, a potem dodać do niego wykres.
Jeśli zdecydujesz się zarządzać panelami niestandardowymi za pomocą interfejsu Cloud Monitoring API, Metrics Explorer udostępnia 2 przydatne narzędzia:
- Aby wygenerować reprezentację JSON dla wykresu, który chcesz dodać do panelu, skonfiguruj wykres za pomocą narzędzia Metrics Explorer. Będzie ona wtedy dostępna do reprezentacji JSON po kliknięciu menu Więcej opcji na pasku narzędzi Metrics Explorer.
- Aby zidentyfikować składnię filtra usługi Monitoring, który jest używany z interfejsem Cloud Monitoring API, skonfiguruj wykres za pomocą menu z interfejsem Metrics Explorer. Po wybraniu wskaźnika i filtrów przełącz się na tryb filtra bezpośredniego, aby wyświetlić odpowiedni filtr monitorowania.
Tworzenie panelu niestandardowego
Aby utworzyć panel niestandardowy:
- W konsoli Cloud wybierz Monitorowanie:
- W panelu nawigacji kliknij Panele.
- Na stronie Przegląd paneli kliknij Utwórz panel.
- W przypadku każdego wykresu, który chcesz dodać do panelu, wykonaj te czynności:
Wybierz typ wykresu, korzystając z opcji Dodaj wykres, lub przeciągnij go z biblioteki do obszaru wykresu.
Zostanie wyświetlony wstępnie skonfigurowany wykres wybranego typu. Poniższy przykład przedstawia wykres liniowy i jego panel konfiguracji:
- Wybierz Typ zasobu i Wskaźnik, a następnie zastosuj filtry tak jak powyżej podczas tworzenia wykresu.
Więcej informacji o dostępnych opcjach znajdziesz w artykule o dodawaniu widżetów panelu.
- (Opcjonalnie) Na pasku narzędzi panelu kliknij Dodaj wykres, aby dodać kolejny wykres, a następnie powtórz poprzednie kroki, aby dostosować wykres.
- Gdy skończysz edytowanie, kliknij strzałkę w lewo, aby opuścić panel, lub wybierz dowolną pozycję w menu Monitorowanie. Panel zostanie zapisany automatycznie.
Wyświetl panel
Aby wyświetlić panel:
- W konsoli Cloud wybierz Monitorowanie:
- W panelu nawigacji kliknij Panele.
- Wybierz z listy panel niestandardowy lub wstępnie zdefiniowany panel.
Przydatne materiały
Więcej informacji o tworzeniu paneli znajdziesz w tych artykułach:
- Panele i wykresy
- Zarządzanie panelami niestandardowymi w konsoli
- Zarządzanie panelami za pomocą interfejsu API
Dane na temat wykorzystania
Do monitorowania wykorzystania interfejsów API Google Maps Platform dostępne są 2 grupy wskaźników: wskaźniki Serviceruntime (typ zasobu consumed_api) dostępne dla większości interfejsów Google Cloud APIs i wskaźniki Google Maps Platform oraz wskaźniki dotyczące interfejsów API Google Maps Platform (typ zasobu maps.googleapis.com/Api).
Oba wskaźniki obsługują ten sam zestaw etykiet zasobów do podziału ruchu związanego z wykorzystaniem interfejsów API: project_id, service, method, version, location i credential_id. Zapoznaj się z opisami etykiet zasobów w dokumentacji odpowiednich zasobów Wskaźników:
Każda grupa wskaźników ma 2 typy wskaźników monitorowania wykorzystania: Liczba żądań i Opóźnienie żądań.
W danych Liczba żądań możesz podzielić ruch związany z wykorzystaniem według etykiet wskaźników protocol, grpc_status_code, response_code i response_code_class. Możesz też podzielić użytkowników według wartości platform_type w danych Google Maps Platform.
W danych Opóźnienia żądań możesz podzielić ruch związany z wykorzystaniem według protocol, platform_type, response_code i response_code_class etykiet danych tylko w przypadku danych Google Maps Platform.
Więcej informacji o typach i etykietach wskaźników znajdziesz w dokumentacji odpowiednich grup wskaźników:
Mapowanie etykiet stanu i kodu odpowiedzi
W tabeli poniżej przedstawiono mapowanie między kodem stanu i kodem odpowiedzi HTTP zwracanym w odpowiedzi na żądania do interfejsu Google Maps Platform API oraz etykiety kodu odpowiedzi dostępne w Cloud Monitoring: kod odpowiedzi HTTP, klasa kodu odpowiedzi HTTP, kod stanu GRPC. Kod stanu GRPC to liczbowy kod odpowiedzi gRPC dla żądań gRPC lub odpowiedni kod gRPC dla żądań HTTP.
| Kody odpowiedzi zwrócone w odpowiedziach interfejsu API | Kody odpowiedzi zgłoszone do usługi Monitoring | |||
|---|---|---|---|---|
| Stan interfejsu API Map Google | Kod odpowiedzi HTTP | Kod odpowiedzi HTTP | Klasa kodu odpowiedzi HTTP | Kod stanu GRPC |
| OK | 200, 204, 302 |
200, 204, 302 |
2xx, 3xx |
0 (OK) |
| DATA_NOT_AVAILABLE, NOT_FOUND, ZERO_RESULTS |
200 | 200, 404(1) | 2xx, 4xx(1) |
5 (NIE ZNALEZIONO)(1) |
| INVALID_REQUEST (nieprawidłowa wartość parametru), MAX_ROUTE_LENGTH_EXCEEDED, MAX_WAYPOINTS_EXCEEDED itp. |
200, 400 |
400 | 4xx | 3 (NIEPRAWIDŁOWY_ARG) |
| INVALID_REQUEST (nieprawidłowy lub brakujący parametr, błąd analizy żądania) | 200, 400 |
400 | 4xx | 3 (NIEPRAWIDŁOWY_ARG) |
| REQUEST_DENIED | 200, 403, 200, 400 |
403, 401(1) |
4xx(1) | 7 (PERMISSION_DENIED), 16 (BEZ UWIERZYTELNIANIA) |
| OVER_DAILY_LIMIT, OVER_QUERY_LIMIT, RESOURCE_EXHAUSTED, dailyLimitExceeded, rateLimitExceeded, userRateLimitExceeded |
200, 403, 429 |
429(1) | 4xx(1) | 8 (RESOURCE_EXHAUSTED) |
| UNKNOWN_ERROR | 200, 500, 503 |
500(1), 503 |
5xx(1) | 2 (NIEZNANY)/13 (WEWNĘTRZNE)(1), 14 (NIEDOSTĘPNE) |
<br class="2
2-klasa_2
<br/2}
<ph="28
2002002002002002xx2xx2xx2xx2xx4044xx4xx4xx4xx4xx4xx4xx0OK5NOT_FOUNDNOT_FOUNDDATA_NOT_AVAILABLEZERO_RESULTS4004034034037PERMISSION_DENIEDREQUEST_DENIEDREQUEST_DENIED40116UNAUTHENTICATED429OVER_QUERY_LIMITdailyLimitExceededrateLimitExceededuserRateLimitExceeded5005xx2UNKNOWN13INTERNALUNKNOWN_ERROR
W okresie przejściowym możesz zobaczyć oba kody odpowiedzi. Kody odpowiedzi zwracane w odpowiedziach interfejsu API Map Google nie się zmieniają. Zestawienie kodów odpowiedzi zgłaszanych w czasie możesz sprawdzić w narzędziu Metrics Explorer.
|
||||
Tworzenie alertów
Alerty informują o problemach w aplikacjach, dzięki czemu możesz je szybko rozwiązać. Zasady tworzenia alertów w Cloud Monitoring określają, w jakich okolicznościach i w jaki sposób chcesz otrzymywać alerty.
Zasady tworzenia alertów mogą być proste lub złożone. Zasady tworzenia alertów pozwalają określić, czy pojedynczy ciąg czasowy może powodować spełnienie warunku, czy też wiele ciągów czasowych musi spełnić warunek, zanim zostanie spełniony. Przykład:
- Powiadamiaj mnie, gdy liczba żądań dla określonego interfejsu API przekroczy 1000 żądań w ciągu 5 minut.
- Powiadom zespół dyżurny, gdy 90 centyl odpowiedzi HTTP 200 przekracza czas oczekiwania 100 ms w co najmniej 3 interfejsach API.
Poniższy obraz przedstawia definicję alertu generującą powiadomienie, gdy liczba żądań do interfejsu API przekroczy 20 w ciągu 5 minut:
Na tym obrazie:
- Wykres przedstawia liczbę wywołań interfejsu API w danym okresie dla różnych interfejsów API.
- Czerwona linia pokazuje próg alertu. Alert aktywuje wywołania interfejsu API, które przez 5 minut przekraczają ten próg. W tym przykładzie widać, że 1 interfejs API przekroczył limit.
Gdy są spełnione warunki zasady tworzenia alertów, Cloud Monitoring otwiera incydent i powiadomienia o problemach:
- Incydent to stały rekord, w którym są przechowywane informacje o monitorowanych zasobach, gdy warunek został spełniony. Gdy warunek przestanie być spełniony, incydent zostanie automatycznie zamknięty. W panelu alertów możesz wyświetlić wszystkie otwarte i zamknięte incydenty.
- Przy konfigurowaniu zasady tworzenia alertów określasz, kto ma być powiadamiany. Monitoring obsługuje popularne kanały powiadomień, takie jak poczta e-mail, aplikacja Cloud Mobile App i usługi, takie jak PagerDuty czy Slack. Pełną listę kanałów powiadomień znajdziesz w sekcji Opcje powiadomień.
Typy alertów
Cloud Monitoring obsługuje wiele typów alertów. Możesz na przykład zdefiniować:
- Alerty dotyczące progów wskaźników: aktywuj alert, gdy wskaźnik wzrośnie lub spadnie poniżej wartości w określonym okresie trwania albo gdy wartość wzrośnie lub spadnie o określoną z góry wartość procentową.
- Alerty dotyczące budżetu: ustaw reguły progowe, aby otrzymywać powiadomienia, gdy koszty (rzeczywiste lub prognozowane) przekroczą określony procent budżetu (na podstawie ustawionych przez Ciebie reguł). Alert nie ogranicza wykorzystania interfejsu API, tylko informuje, gdy kwota wydatków zbliży się do określonej kwoty.
- Alerty dotyczące limitów: w Google Cloud Platform obowiązują różne limity, których możesz używać do śledzenia i ograniczania zasobów zużywanych przez projekt lub organizację. Używaj alertów, aby wysyłać powiadomienia, gdy wykorzystanie zbliża się do limitu.
Więcej informacji znajdziesz w artykule Typy zasad tworzenia alertów.
Zarządzanie zasadami tworzenia alertów
Zasady tworzenia alertów możesz dodać do projektu za pomocą konsoli Cloud lub interfejsu Cloud Monitoring API. Informacje o tym, jak wyświetlić listę zasad tworzenia alertów na podstawie wskaźników w projekcie oraz jak je modyfikować:
- Zarządzanie zasadami tworzenia alertów za pomocą konsoli Cloud
- Zarządzanie zasadami tworzenia alertów przy użyciu interfejsu Cloud Monitoring API
Utwórz alert
Podczas tworzenia alertu:
- Na podstawie danych wskaźników określ warunki, które mają wywoływać alerty.
- Zdefiniuj kanały powiadomień, do których będą wysyłane powiadomienia o alertach.
Poniższy przykład pokazuje, jak skonfigurować alert, który uruchamia się, gdy wskaźnik wykorzystania usługi Google Maps Platform dla dowolnego interfejsu API przekracza 2 żądania w ciągu 5-minutowego okresu.
Aby utworzyć alert:
- W konsoli Cloud wybierz Monitorowanie:
- Wybierz Alerty.
- Wybierz Edytuj kanał powiadomień, aby określić sposób wywoływania alertu. W tym przykładzie użyjesz swojego adresu e-mail.
- W polu Kanał e-mail wybierz Dodaj nowy.
- Wpisz adres e-mail i wyświetlaną nazwę.
- Kliknij Zapisz.
- Wybierz Alerty.
- Wybierz Utwórz zasadę.
- Wybierz przedział czasu, np. 7 dni.
- W sekcji Warunki alertów wybierz Nowy warunek:
- Kliknij Wybierz wskaźnik, wybierz Consumed API jako zasób i Liczba żądań jako wskaźnik, a potem kliknij Zastosuj.
- (Opcjonalnie) Pod wykresem znajdują się listy usług, quota_metrics, metody interfejsu API i wartości wskaźnika. Aby filtrować dane na podstawie tych informacji, kliknij Dodaj filtr. Na przykład za pomocą filtra możesz określić, że metoda musi mieć wartość google.places.Autocomplete.http, aby alert został wyzwolony.
- W sekcji Przekształcanie danych wybierz 5 min w polu Okno przesuwania i średnia dla funkcji okna ciągłego.
- Kliknij Dalej.
- W sekcji Skonfiguruj aktywator alertu ustaw Wartość progu na 2, aby aktywować alert, gdy w 5-minutowym oknie pojawią się więcej niż 2 żądania. Zwróć uwagę, że na wykresie wyświetlana jest teraz czerwona linia, która wskazuje limit alertów w wybranym przedziale czasu. Na wykresie możesz sprawdzić, gdzie zostałby aktywowany alert. Korzystając z tego wykresu, możesz dostosować limit w razie potrzeby.
- Kliknij Dalej.
- Na stronie Skonfiguruj powiadomienia i dokończ alert:
- Wybierz adres e-mail utworzony dla kanału powiadomień.
- W polu Nazwij alert wpisz Mój alert testowy.
- Wybierz Utwórz zasadę.
- Wykonaj żądania do interfejsu API. Aby wygenerować e-maila z powiadomieniem o alercie, wykonaj więcej niż 2 żądania do interfejsu API w ciągu 5 minut.
- Gdy otrzymasz e-maila z alertem, otwórz stronę Alerty.
- Kliknij alert w tabeli z listą alertów, aby wyświetlić więcej informacji.
- Kliknij nazwę alertu, aby wyświetlić informacje o nim, w tym wykres przedstawiający zdarzenie, które go spowodowało.
Przydatne materiały
Więcej informacji o alertach: