Cloud Monitoring zbiera wskaźniki dotyczące Twoich interfejsów API i usług oraz używanych przez Ciebie zasobów Google Cloud Platform. Z tego artykułu dowiesz się, jak skonfigurować Cloud Monitoring oraz jak za jego pomocą monitorować wykorzystanie interfejsu API, tworzyć panele i tworzyć alerty.
Cloud Monitoring udostępnia wiele funkcji i opcji. W tym temacie przedstawiamy Cloud Monitoring i przedstawiamy podstawowe przykłady. Informacje o wszystkich funkcjach, w tym o wielu innych przykładach, znajdziesz w dokumentacji Cloud Monitoring.
Skonfiguruj Cloud Monitoring
Dzięki monitorowaniu możesz wyświetlać te dane i nimi zarządzać:
- Pojedynczy projekt
- Wiele projektów w ramach 1 organizacji
- Wiele 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 Console wybierz Monitorowanie:
- Sprawdź, czy został wybrany właściwy projekt.
- W panelu nawigacji Monitorowanie kliknij ikonę > po prawej stronie opcji Zakres wskaźników.
Poniższy zrzut ekranu przedstawia stronę wyświetlaną po wybraniu projektu AllEnvironments:
Tabela o nazwie Wskaźniki monitorowane przez ten projekt zawiera projekty, których wskaźniki są dostępne dla bieżącego zakresu wskaźników. Każdy wiersz w tabeli zawiera projekt i jego rolę:
- Projekt określania zakresu: ten projekt przechowuje kontrole dostępności, zasady tworzenia alertów, grupy i panele informacyjne. Między zakresami wskaźników a projektem określania zakresu istnieje relacja 1:1. W tym przykładzie projekt AllEnvironments to projekt określania zakresu.
- Monitorowany projekt: wskaźniki projektu są widoczne w bieżącym zakresie wskaźników. W tym przykładzie projekty i środowiska produkcyjne są monitorowane.
Tabela oznaczona etykietą Projekty wymienione poniżej mogą wyświetlać wskaźniki tego projektu zawierają listę projektów, których zakres wskaźników obejmuje bieżący projekt. Poprzedni zrzut ekranu pokazuje, że żadne inne projekty nie mają dostępu do wskaźników przechowywanych przez projekt AllEnvironments.
Więcej informacji, w tym instrukcje dodawania i usuwania projektów, znajdziesz w artykule Konfigurowanie Cloud Monitoring.
Zbadaj wskaźniki
Aby przejrzeć dane wskaźników, utwórz wykres za pomocą narzędzia Metrics Explorer dostępnego w Cloud Monitoring. Jeśli na przykład chcesz wyświetlić limit wykorzystania interfejsu API, możesz za pomocą narzędzia Metrics Explorer utworzyć wykres przedstawiający najnowsze dane.
Poniższa ilustracja przedstawia wykres wykorzystania limitów przez interfejsy API Map Google:
W tym przykładzie skumulowany wykres słupkowy jest reprezentowany przez każdy słupek interfejsu API. Możesz tworzyć różne typy wykresów, np. wykresy liniowe, słupkowe i mapy termiczne. Możesz też utworzyć pojedynczy wykres przedstawiający maksymalnie 10 rodzajów danych.
Na tym obrazie:
- Pola Typ zasobu i Wskaźnik po lewej stronie wykresu definiują dane wyświetlane na wykresie.
- Typ wykresu nad wykresem pozwala wybrać typ wykresu. W tym przykładzie ustawiono na Skumulowany wykres słupkowy.
- Przedział czasu nad wykresem jest ustawiony na 1 W (tydzień).
- Pod wykresem znajdziesz listę usług, quota_metrics, metody interfejsu API oraz wartości wskaźników, które definiują dane na wykresie. Kliknij Dodaj filtr, aby wykorzystać te informacje do zawężania wyświetlanych danych.
Gdy opuścisz stronę Metrics Explorer, wykres zostanie usunięty z karty, dzięki czemu nie będziesz mieć żadnych niechcianych artefaktów. Możesz też zapisać wykres w panelu niestandardowym lub udostępnić go. Więcej informacji o dodawaniu wykresu do panelu znajdziesz w sekcji Tworzenie paneli poniżej.
Wykres pojedynczego wskaźnika
Aby skonfigurować wykres za pomocą narzędzia Metrics Explorer:
- W konsoli Google Cloud wybierz Monitorowanie:
- W panelu nawigacji kliknij Metrics Explorer.
- Na pasku narzędzi wybierz Wykres słupkowy skumulowany, aby wyświetlić dane wskaźników w postaci wykresu słupkowego.
- Wybierz przedział czasu, np. 1 W (tydzień).
- Określ dane do wyświetlenia na wykresie. Aby użyć interfejsu menu lub wpisać filtr, wybierz kartę Konfiguracja. Aby użyć języka MQL do monitorowania, wybierz kartę MQL.
- Aby zobaczyć wykres wykorzystania limitu, wybierz Typ konsumenta jako Typ zasobu. Jeśli chcesz utworzyć wykres wykorzystania interfejsu API, wybierz Przekroczenie API lub Interfejs API Map Google (więcej informacji o danych wykorzystania dostępnych w interfejsach Google Maps Platform API znajdziesz w sekcji Wskaźniki wykorzystania). Najedź kursorem na każdy typ zasobu, aby zobaczyć jego opis.
- Jako dane wybierz Wykorzystanie limitu stawki. Wykres automatycznie aktualizuje dane wskaźników. Zwróć uwagę, że istnieją inne opcje limitu wskaźników. Najeżdżaj kursorem na poszczególne dane, aby wyświetlać ich opisy. Więcej informacji o polach Metrics Explorer znajdziesz w artykułach o wybieraniu danych i wybieraniu sposobu wyświetlania danych na wykresie.
- (Opcjonalnie) Użyj tych opcji, aby zawęzić ekran:
- Aby określić podzbiór danych do wyświetlenia, dodaj filtry. Aby dodać filtr, wybierz Dodaj filtr i uzupełnij okno. Więcej informacji znajdziesz w artykule Filtrowanie danych na wykresie. Aby na przykład wyświetlić dane dotyczące jednego interfejsu API:
- W polu Etykieta wybierz metoda.
- W polu Porównanie wybierz = (równa się).
- W polu Wartość wybierz nazwę określonej metody. Pojawi się prośba o wybranie nazwy metody, która ma być wyświetlana.
- Kliknij Gotowe , aby zaktualizować wykres.
- Aby zgrupować serie czasowe według etykiety, użyj pola Grupuj według. Wybranie wartości w tym polu spowoduje automatyczne wybranie wartości w polu Agregator.
- Aby określić, jak połączyć ciągi czasowe, ustaw pole Agregator. Jeśli na przykład pole Grupuj według jest puste, a pole Agregator jest ustawione na średnią, na wykresie pojawi się ś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 podczas korzystania z Metrics Explorer.
- Aby określić podzbiór danych do wyświetlenia, dodaj filtry. Aby dodać filtr, wybierz Dodaj filtr i uzupełnij okno. Więcej informacji znajdziesz w artykule Filtrowanie danych na wykresie. Aby na przykład wyświetlić dane dotyczące jednego interfejsu API:
Opcjonalnie dodaj do panelu.
Gdy opuścisz stronę Metrics Explorer, wykres zostanie odrzucony. Możesz też 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.
Pokaż wiele wskaźników
W niektórych sytuacjach możesz chcieć wyświetlać wiele danych na tym samym wykresie. Możesz na przykład ustawić limit na tych samych wykresach co jego wykorzystanie. Wykres może wyświetlać maksymalnie 10 wskaźników.
Aby dodać dane do istniejącego wykresu:
- Na dole istniejącego wykresu wybierz opcję Dodaj kolejny wskaźnik u dołu ekranu.
- Wybierz wskaźnik, a następnie określ sposób wyświetlania ciągu czasowego dla tego wskaźnika w taki sam sposób, w jaki został skonfigurowany oryginalny wskaźnik powyżej.
Przydatne materiały
Więcej informacji o korzystaniu z danych znajdziesz w tych artykułach:
- Tworzenie wykresów za pomocą narzędzia Metrics Explorer
- Wybieranie danych podczas korzystania z narzędzia Metrics Explorer
- Wskaźniki dostępne dla wszystkich interfejsów API Google Cloud
- Dane dotyczące interfejsów API Google Maps Platform
- Dane dotyczące dystrybucji na wykresie
- Opcje widoku danych
Tworzenie paneli
Panele umożliwiają wyświetlanie i monitorowanie danych ciągów czasowych jako zbioru wykresów. Cloud Monitoring obsługuje panele wstępnie zdefiniowane i niestandardowe:
- Wstępnie zdefiniowane panele są automatycznie instalowane dla usług Google Cloud Platform, których używasz. Tych paneli nie można konfigurować.
- Panele niestandardowe to panele, które tworzysz. Panele niestandardowe pozwalają określić, które dane chcesz wyświetlić oraz jak je wyświetlić. Możesz na przykład wyświetlić dane wskaźnika, zasady tworzenia alertów i logi zapisane w Twoim projekcie. Dane ciągów czasowych możesz wyświetlać na wykresie wraz ze wskaźnikiem lub tabelą wyników albo w formie tabeli.
Do tworzenia paneli niestandardowych możesz używać Cloud Console lub interfejsu Cloud Monitoring API. Poniższa ilustracja przedstawia panel niestandardowy z 2 wykresami:
- Wykres limitów po lewej stronie
- Wykres liczby interfejsów API po prawej stronie
Utwórz niestandardowy panel, tworząc wykresy wskaźników, a następnie dodając je do panelu. Wykres możesz utworzyć w eksploratorze wskaźników, a następnie dodać go do nowego lub istniejącego panelu. Możesz też utworzyć panel, a potem go edytować, aby dodać wykres.
Jeśli zdecydujesz się zarządzać panelami niestandardowymi za pomocą interfejsu Cloud Monitoring API, eksplorator wskaźników udostępnia 2 przydatne narzędzia:
- Aby wygenerować wykres JSON dla wykresu, który chcesz dodać do panelu, skonfiguruj wykres za pomocą narzędzia Metrics Explorer. Dzięki temu wartość JSON będzie dostępna w menu Więcej opcji na pasku narzędzi Metrics Explorer.
- Aby zidentyfikować składnię filtra Monitoring, która jest używana przez interfejs Cloud Monitoring API, skonfiguruj interfejs wykresu za pomocą menu Metrics Explorer. Po wybraniu wskaźnika i filtrów przełącz się na tryb filtra bezpośredniego, aby wyświetlić odpowiednik filtra monitorowania.
Tworzenie panelu niestandardowego
Aby utworzyć panel niestandardowy:
- W konsoli Google Cloud wybierz Monitorowanie:
- W panelu nawigacji wybierz Panele.
- Na stronie Przegląd paneli kliknij Utwórz panel.
- W przypadku każdego wykresu, który chcesz dodać do panelu:
Wybierz typ wykresu z listy Dodaj wykres lub przeciągnij go z biblioteki do obszaru wykresu.
Wyświetli się wstępnie skonfigurowany wykres wybranego typu. Poniższy przykład przedstawia wykres liniowy i jego panel konfiguracji:
- Wybierz Typ zasobu oraz Wskaźnik i zastosuj filtry w sposób opisany powyżej podczas tworzenia wykresu.
Więcej informacji o dostępnych opcjach znajdziesz w artykule Dodawanie widżetów na panelu.
- (Opcjonalnie) Na pasku narzędzi panelu kliknij Dodaj wykres, aby dodać kolejny wykres, a następnie powtórz poprzednie czynności, aby dostosować go do swoich potrzeb.
- Gdy skończysz edytowanie, kliknij strzałkę w lewo, aby opuścić panel, lub wybierz inną opcję menu Monitorowanie. Twój panel jest zapisywany automatycznie.
Wyświetlanie panelu
Aby wyświetlić panel:
- W konsoli Google Cloud wybierz Monitorowanie:
- W panelu nawigacji wybierz Panele.
- Wybierz z listy panel niestandardowy lub wstępnie zdefiniowany.
Przydatne materiały
Więcej informacji o tworzeniu paneli znajdziesz tutaj:
- Panele i wykresy
- Zarządzanie panelami niestandardowymi w konsoli
- Zarządzanie panelami przy użyciu interfejsu API
Dane na temat wykorzystania
Do monitorowania korzystania z interfejsów API Google Maps Platform dostępne są 2 grupy wskaźników: Wskaźniki czasu działania (typ zasobu consumed_api) dostępne dla większości danych Google Cloud API i danych Google Maps Platform, dane 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 interfejsami API: project_id
, service
, method
, version
, location
i credential_id
. Zapoznaj się z opisami etykiet zasobów w dokumentacji odpowiedniego zasobu wskaźników:
Każda grupa wskaźników ma 2 typy wskaźników monitorowania wykorzystania: liczba żądań i opóźnienia żądań.
W danych Liczba żądań możesz podzielić ruch związany z użytkowaniem według etykiet wskaźników protocol
, grpc_status_code
, response_code
i response_code_class
. Możesz też podzielić wartość według platform_type
w Google Maps Platform.
W przypadku danych Opóźnienia żądań możesz podzielić ruch związany z użytkowaniem według etykiet wskaźników protocol
, platform_type
, response_code
i response_code_class
tylko w wskaźnikach Google Maps Platform.
Więcej informacji o typach i etykietach danych znajdziesz w dokumentacji dotyczącej odpowiednich grup danych:
Mapowanie stanu i etykiety kodu odpowiedzi
W tabeli poniżej znajdziesz mapowanie między kodem stanu odpowiedzi a kodem odpowiedzi HTTP zwracanym w odpowiedzi na żądania do interfejsu Google Maps Platform API oraz etykietami kodu odpowiedzi dostępnymi w Cloud Monitoring: kod odpowiedzi HTTP, klasa kodu odpowiedzi HTTP i kod stanu GRPC. Kod stanu gRPC to liczbowy kod odpowiedzi gRPC dla żądań gRPC lub kod równoważny gRPC dla żądań HTTP.
Kody odpowiedzi zwracane 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) |
NOT_FOUND (Street View Static API, Geolocation i interfejsy Roads API), ZERO_RESULTS (Street View Static API) |
404 | 404 | 4xx | 5 (NIE_ZNALEZIONO) |
INVALID_REQUEST (nieprawidłowa wartość parametru), MAX_ROUTE_LENGTH_EXCEEDED, MAX_WAYPOINTS_EXCEEDED, itd. |
200/400 | 400 | 4xx | 3 (INVALID_RESULT) |
INVALID_REQUEST (nieprawidłowy lub brakujący parametr, błąd analizy żądania) | 200/400 | 400 | 4xx | 3 (INVALID_RESULT) |
NIEDOZWOLONA | 200/403, 200/400 |
403, 401(1) |
4xx(1) | 7 (PERMISSION_DENIED), 16 (UNAUTHENTICATED) |
OVER_DAILY_LIMIT, OVER_QUERY_LIMIT, RESOURCE_EXHAUSTED, dailyLimitPrzekroczono, RateLimitExceeded, userRateLimitExceeded |
200/403, 429 |
429(1) | 4xx(1) | 8 (ZASOBY WYMAGANE) |
UNKNOWN_ERROR | 200/500, 503 |
500(1), 503 |
5xx(1) | 2 (NIEZNANE)/13 (WEWNĘTRZNE)(1), 14 (NIEDOSTĘPNE) |
wybrane: Wybyśmybyśmybyśmywwbyśmywwwwwwwwwww w w w w w w w w w w w w wwwwwww w w w w w w w w w serwisu w serwisu w serwisu firmy firmy firmy w w ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich ich im im im można???????? Jeśli200 200 200 200 200 2xx 2xx 2xx 2xx 2xx 404 4xx 4xx 4xx 4xx 4xx 4xx 4xx 0 OK 5 NOT_FOUND NOT_FOUND DATA_NOT_AVAILABLE ZERO_RESULTS 400 403 403 403 7 PERMISSION_DENIED REQUEST_DENIED REQUEST_DENIED 401 16 UNAUTHENTICATED 429 OVER_QUERY_LIMIT dailyLimitExceeded rateLimitExceeded userRateLimitExceeded 500 5xx 2 UNKNOWN 13 INTERNAL UNKNOWN_ERROR
W okresie przejściowym możesz zobaczyć oba kody odpowiedzi. Kody odpowiedzi zwracane w odpowiedziach interfejsu API Map Google nie się zmieniają. Możesz przejrzeć zestawienie kodów odpowiedzi zgłoszonych w czasie w narzędziu Metrics Explorer.
|
Tworzenie alertów
Alerty informują użytkowników o problemach w aplikacjach, dzięki czemu można je szybko rozwiązywać. Zasada tworzenia alertów w Cloud Monitoring opisuje okoliczności, w których chcesz otrzymywać alerty, i sposób, w jaki chcesz otrzymywać powiadomienia.
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 spowodować spełnienie warunku, czy też kilka ciągów czasowych musi spełniać warunek, zanim zostanie spełniony. Przykład:
- Powiadamiaj mnie, gdy liczba żądań dla określonego interfejsu API przekroczy 1000 żądań w ciągu 5-minutowego okresu.
- Powiadom zespół dyżurny, gdy 90 centyl odpowiedzi HTTP 200 przekroczy 100 ms w przypadku co najmniej 3 interfejsów API.
Ten obraz przedstawia definicję alertu, aby wygenerować powiadomienie, gdy liczba żądań do interfejsu API przekroczy 20 żądań w 5-minutowym okresie:
Na tym obrazie:
- Wykres przedstawia liczbę wywołań interfejsu API na przestrzeni czasu.
- Czerwona linia pokazuje próg alertu. Alert będzie wywoływał wywołania interfejsu API przekraczające ten próg przez 5 minut. W tym przykładzie widać, że jeden interfejs API przekroczył limit.
Gdy są spełnione warunki zasad tworzenia alertów, Cloud Monitoring otwiera informacje o incydentach i problemach:
- Incydent to rekord trwały, który zawiera informacje o monitorowanych zasobach w przypadku spełnienia warunku. Gdy warunek przestanie być spełniony, incydent zostanie automatycznie zamknięty. Wszystkie incydenty (otwarte i zamknięte) możesz wyświetlić w panelu alertów.
- Przy konfigurowaniu zasad tworzenia alertów określasz, kto ma otrzymać powiadomienie. Monitorowanie obsługuje popularne kanały powiadomień, w tym pocztę e-mail, aplikację mobilną Cloud oraz usługi takie jak PagerDuty lub Slack. Pełną listę kanałów powiadomień znajdziesz w artykule Opcje powiadomień.
Typy alertów
Cloud Monitoring obsługuje wiele typów alertów. Możesz na przykład zdefiniować:
- Alerty dotyczące progu: wyzwalaj alert, jeśli wskaźnik wzrośnie w danym przedziale czasu lub spadnie poniżej wartości określonej przez okres czasu trwania albo zwiększy się lub zmniejszy we wstępnie zdefiniowanym procencie.
- Alerty dotyczące budżetu: możesz ustawić reguły, aby otrzymywać powiadomienia, gdy koszty (rzeczywiste lub prognozowane) przekroczą określony procent budżetu (zgodnie z ustawionymi przez Ciebie regułami). Alert nie ogranicza wykorzystania API. Informuje tylko o tym, czy kwota wydatków zbliża się do wskazanej kwoty.
- Alerty dotyczące limitów: Google Cloud Platform określa różne limity, których możesz użyć do śledzenia i ograniczania zasobów uż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ądzaj zasadami tworzenia alertów
Możesz dodać zasadę tworzenia alertów do projektu za pomocą Cloud Console lub interfejsu Cloud Monitoring API. Informacje o tym, jak wyświetlić listę zasad tworzenia alertów opartych na wskaźnikach oraz jak modyfikować te zasady, znajdziesz w tych artykułach:
- Zarządzanie zasadami tworzenia alertów za pomocą Cloud Console
- Zarządzanie zasadami tworzenia alertów za pomocą interfejsu Cloud Monitoring API
Utwórz alert
Gdy utworzysz alert:
- Zdefiniuj warunki, które wywołują alerty, na podstawie danych dotyczących wskaźników.
- Zdefiniuj kanały powiadomień, na które będą wysyłane powiadomienia o alertach.
Przykład poniżej pokazuje, jak skonfigurować alert, gdy wskaźnik wykorzystania usług Google Maps Platform dla dowolnego interfejsu API przekroczy 2 żądania w ciągu 5 minut.
Aby utworzyć alert, wykonaj te czynności:
- W konsoli Google Cloud wybierz Monitorowanie:
- Wybierz Alerty.
- Wybierz Edytuj kanał powiadomień, aby określić sposób, w jaki alert ma wysyłać powiadomienia. W tym przykładzie użyjesz adresu e-mail.
- W polu Kanał e-mail wybierz Dodaj nowy.
- Wpisz adres e-mail i wyświetlaną nazwę.
- Kliknij Zapisz.
- Wybierz Alerty.
- Kliknij Utwórz zasadę.
- Wybierz przedział czasu, np. 7 dni.
- W sekcji Warunki alertów wybierz Nowy warunek:
- Kliknij Wybierz wskaźnik, wybierz Konsument API jako zasób, a Wskaźnik liczby żądań jako wskaźnik, a następnie Zastosuj.
- (Opcjonalnie) Poniżej wykresu znajdziesz listę usług, quota_metrics, metody interfejsu API oraz wartości wskaźników. Kliknij Dodaj filtr, aby filtrować dane według tych informacji. Możesz np. użyć filtra, by określić, że metoda musi równać google.places.Autocomplete.http, aby aktywować alert.
- W sekcji Przekształć dane wybierz 5 min w przypadku Okno kroczące i Średnia dla funkcji Okres obserwacji.
- Kliknij Dalej.
- W sekcji Skonfiguruj regułę alertu ustaw Wartość progu na 2, aby określić, czy alert ma być wywoływany, gdy w 5-minutowym okresie pojawi się więcej niż 2 żądania. Zwróć uwagę, że na wykresie pojawi się teraz czerwona linia wskazująca limit alertów dla wybranego przedziału czasu. Na wykresie możesz sprawdzić, gdzie zostałby aktywowany alert. W razie potrzeby możesz wykorzystać ten wykres do skorygowania limitu.
- Kliknij Dalej.
- Na stronie Konfigurowanie powiadomień i finalizowanie alertów:
- Wybierz adres e-mail utworzony dla kanału powiadomień.
- W sekcji Nazwij alert wpisz Mój alert testowy.
- Kliknij Utwórz zasadę.
- Wykonaj kilka żądań do interfejsu API. Aby wygenerować alert e-mail z powiadomieniem, wyślij więcej niż 2 żądania API w ciągu 5 minut.
- Gdy otrzymasz e-maila z alertem, otwórz stronę Alerty.
- Kliknij alert, aby wyświetlić więcej informacji.
- Kliknij nazwę alertu, aby wyświetlić informacje o alercie, w tym wykres przedstawiający zdarzenie, które go wywołało.
Przydatne materiały
Więcej informacji o alertach znajdziesz w tych artykułach: