Cloud Monitoring собирает показатели ваших API и сервисов, а также ресурсов Google Cloud Platform, которые вы используете. В этом разделе описывается, как настроить Cloud Monitoring и как использовать его для мониторинга использования API, создания информационных панелей и оповещений.
Cloud Monitoring имеет большой набор функций и опций. В этом разделе представлен облачный мониторинг и приведены основные примеры. Информацию обо всех функциях, включая множество других примеров, см. в документации Cloud Monitoring .
Настройка облачного мониторинга
Мониторинг позволяет просматривать и управлять метриками:
- Для одного проекта
- Для нескольких проектов в одной организации
- Для нескольких проектов в нескольких организациях
Чтобы обеспечить доступность метрик для ваших проектов, выполните следующие действия:
- В Google Cloud Console выберите Мониторинг :
- Убедитесь, что вы выбрали правильный проект.
- На панели навигации «Мониторинг» нажмите > справа от области метрик . На следующем снимке экрана показана страница, которая отображается при выборе проекта AllEnvironments:
В таблице « Метрики, отслеживаемые этим проектом», перечислены проекты, метрики которых доступны для текущей области метрик. В каждой строке таблицы указан проект и роль этого проекта:
- Проект определения области действия : в этом проекте хранятся проверки работоспособности, политики оповещений, группы и информационные панели, которые вы настраиваете. Между объемом метрик и объемом проекта существует соотношение 1:1. В этом примере проект AllEnvironments является проектом области действия.
- Контролируемый проект : метрики проекта видны в текущей области метрик. В этом примере проекты подготовки и производства являются отслеживаемыми проектами.
В таблице с надписью «Проекты, перечисленные ниже, можно просматривать метрики этого проекта», перечислены проекты, область метрик которых включает текущий проект. На предыдущем снимке экрана показано, что никакие другие проекты не могут получить доступ к метрикам, хранящимся в проекте AllEnvironments.
Дополнительные сведения, в том числе о том, как добавлять и удалять проекты, см. в разделе Настройка облачного мониторинга .
Изучите метрики
Чтобы изучить данные метрик, постройте диаграмму с помощью обозревателя метрик , который входит в состав Cloud Monitoring. Например, если вы хотите просмотреть использование квот API, вы можете использовать Обозреватель метрик, чтобы построить диаграмму, отображающую самые последние данные.
На следующем изображении показана диаграмма с подробным описанием использования квот для Maps API:
В этом примере показана составная гистограмма, где каждый API представлен частью столбца. Вы можете создавать различные типы диаграмм, например линейные диаграммы, гистограммы и тепловые карты. Вы также можете создать одну диаграмму, на которой будет отображаться до 10 различных показателей.
На этом изображении:
- Поля «Тип ресурса» и «Метрика» слева от диаграммы определяют данные метрик, отображаемые на диаграмме.
- Раскрывающийся список типа диаграммы над диаграммой позволяет выбрать тип диаграммы. В этом примере установлено значение «Сложенная гистограмма» .
- Временной интервал над графиком установлен на 1W (одна неделя).
- Под диаграммой находится список сервисов , quota_metrics , метода API и значения метрики, которые определяют данные диаграммы. Выберите «Добавить фильтр» , чтобы использовать эту информацию для уточнения отображаемых данных.
Когда вы уходите со страницы обозревателя метрик, диаграмма удаляется, поэтому у вас не остается ненужных артефактов, которые можно было бы удалить. Кроме того, вы можете сохранить диаграмму на пользовательской информационной панели или поделиться ею. Дополнительные сведения о добавлении диаграммы на панель мониторинга см. ниже в разделе «Создание панелей мониторинга» .
Диаграмма одной метрики
Чтобы настроить диаграмму с помощью обозревателя метрик, выполните следующие действия:
- В облачной консоли выберите Мониторинг :
- В области навигации выберите Обозреватель метрик .
- На панели инструментов выберите «Сложенная гистограмма» в раскрывающемся списке «Тип диаграммы», чтобы просмотреть данные показателей в виде гистограммы.
- Выберите временной интервал, например 1W (одна неделя).
- Укажите данные, которые будут отображаться на диаграмме. Чтобы использовать интерфейс на основе меню или ввести фильтр, выберите вкладку «Конфигурация» . Чтобы использовать язык запросов мониторинга (MQL), выберите вкладку MQL .
- Чтобы составить диаграмму использования квоты, выберите «Потребительская квота» в качестве типа ресурса . Альтернативно, если вы хотите создать диаграмму использования API, выберите «Потребляемый API» или API Google Maps (более подробную информацию о показателях использования, доступных для API платформы Google Maps, см. в разделе «Метрики использования »). Наведите указатель мыши на каждый тип ресурса, чтобы увидеть его описание.
- В качестве показателя выберите Скорость использования квоты . Диаграмма автоматически обновляется для отображения данных показателей. Обратите внимание, что для этого показателя существуют и другие параметры квоты. Наведите указатель мыши на каждую метрику, чтобы увидеть описание. Дополнительные сведения о полях обозревателя метрик см. в разделах Выбор метрик и Выбор способа отображения данных в виде диаграммы .
- (Необязательно) Используйте следующие параметры для уточнения отображения:
- Чтобы указать подмножество данных для отображения, добавьте фильтры . Чтобы добавить фильтр, выберите «Добавить фильтр» и заполните диалоговое окно. Дополнительные сведения см. в разделе Фильтрация данных диаграммы . Например, чтобы просмотреть данные для одного API:
- В поле «Метка» выберите метод .
- В поле «Сравнение» выберите = (равно) .
- В поле Значение выберите имя конкретного метода. Вам будет предложено выбрать имя метода с данными для отображения.
- Выберите Готово , чтобы обновить диаграмму.
- Чтобы сгруппировать временные ряды по метке, используйте поле Группировать по . Выбор значения для этого поля автоматически выбирает значение для поля «Агрегатор» .
- Чтобы указать, как объединять временные ряды, установите поле «Агрегатор» . Например, если поле «Группировать по » пусто, а в поле «Агрегатор» установлено значение «значение», на диаграмме отображается среднее значение временного ряда.
- Чтобы настроить способ обработки отдельных временных рядов, выберите «Дополнительные параметры» . Дополнительные сведения см. в разделе Выбор метрик при использовании обозревателя метрик .
- Чтобы указать подмножество данных для отображения, добавьте фильтры . Чтобы добавить фильтр, выберите «Добавить фильтр» и заполните диалоговое окно. Дополнительные сведения см. в разделе Фильтрация данных диаграммы . Например, чтобы просмотреть данные для одного API:
При желании добавьте на панель мониторинга.
При выходе со страницы обозревателя метрик диаграмма удаляется. При желании вы можете выбрать «Сохранить диаграмму» , чтобы сохранить диаграмму на новой или существующей информационной панели. Дополнительные сведения о добавлении диаграммы на панель мониторинга см. ниже в разделе «Создание панелей мониторинга» .
Диаграмма нескольких показателей
В некоторых ситуациях вам может потребоваться отобразить несколько показателей на одной диаграмме. Например, вы можете захотеть отобразить ограничение квоты на тех же диаграммах, что и использование квоты. На диаграмме может отображаться максимум 10 показателей.
Чтобы добавить метрику в существующую диаграмму, выполните следующие действия:
- На существующей диаграмме выберите Добавить еще одну метрику в нижней части экрана.
- Выберите метрику, а затем укажите, как отображать временной ряд для этой метрики так же, как вы настроили исходную метрику выше.
Связанные ресурсы
Дополнительную информацию об изучении показателей см. в разделах:
- Создание диаграмм с помощью обозревателя метрик
- Выбор метрик при использовании Metrics Explorer
- Метрики доступны для всех API Google Cloud.
- Метрики, специфичные для API платформы Google Maps
- Показатели распределения диаграммы
- Посмотреть варианты
Создание информационных панелей
Панели мониторинга позволяют просматривать и отслеживать данные временных рядов в виде набора диаграмм. Cloud Monitoring поддерживает предопределенные и пользовательские панели мониторинга:
- Предопределенные панели мониторинга автоматически устанавливаются для используемых вами сервисов Google Cloud Platform. Эти информационные панели не настраиваются.
- Пользовательские панели мониторинга — это панели мониторинга, которые вы создаете. Пользовательские информационные панели позволяют вам определить данные, которые вы хотите просмотреть, и способы просмотра этих данных. Например, вы можете отображать данные метрик, политики оповещений и журналы, хранящиеся в вашем проекте. Данные временных рядов можно отображать на диаграмме, с помощью шкалы или системы показателей, а также в табличной форме.
Для создания пользовательских информационных панелей вы можете использовать Cloud Console или Cloud Monitoring API. На следующем изображении показана пользовательская панель мониторинга с двумя диаграммами:
- Диаграмма квот слева
- Диаграмма количества API справа
Создайте пользовательскую панель мониторинга, создав диаграммы показателей, а затем добавив диаграммы на панель мониторинга. Вы можете создать диаграмму в обозревателе метрик , а затем добавить ее на новую или существующую панель мониторинга. Или вы можете создать панель мониторинга, а затем отредактировать ее, добавив диаграмму.
Если вы решите управлять настраиваемыми панелями мониторинга с помощью Cloud Monitoring API , обозреватель метрик предоставляет вам две полезные утилиты:
- Чтобы создать представление JSON для диаграммы, которую вы планируете добавить на панель мониторинга, настройте диаграмму с помощью обозревателя метрик. Затем вы можете получить доступ к представлению JSON из пункта меню Дополнительные параметры на панели инструментов Обозревателя метрик.
- Чтобы определить синтаксис фильтра мониторинга, который используется с API Cloud Monitoring, используйте управляемый меню интерфейс обозревателя метрик для настройки диаграммы. После выбора метрики и фильтров переключитесь в режим прямого фильтра , чтобы просмотреть эквивалентный фильтр мониторинга.
Создайте персонализированную панель мониторинга
Чтобы создать собственную панель мониторинга, выполните следующие действия:
- В облачной консоли выберите Мониторинг :
- В области навигации выберите Панели мониторинга .
- На странице «Обзор информационных панелей» нажмите « Создать информационную панель» .
- Для каждой диаграммы, которую вы хотите добавить на панель мониторинга, выполните следующие действия:
Выберите тип диаграммы в разделе «Добавить диаграмму» или перетащите ее из библиотеки в область графика.
Отображается предварительно настроенная диаграмма выбранного типа. В следующем примере показана линейная диаграмма и ее панель конфигурации:
- Выберите Тип ресурса и Метрику и примените любые фильтры так же, как вы это делали выше при создании диаграммы.
Дополнительные сведения о выборе см. в разделе Добавление виджетов информационной панели .
- (Необязательно) На панели инструментов панели инструментов нажмите «Добавить диаграмму» , чтобы добавить еще одну диаграмму, а затем повторите предыдущие шаги, чтобы настроить диаграмму.
- Завершив редактирование, щелкните стрелку влево, чтобы выйти из информационной панели, или выберите любой другой пункт меню «Мониторинг» . Ваша информационная панель сохраняется автоматически.
Просмотр панели мониторинга
Чтобы просмотреть панель мониторинга, выполните следующие действия:
- В облачной консоли выберите Мониторинг :
- В области навигации выберите Панели мониторинга .
- Выберите свою собственную панель мониторинга или предопределенную панель мониторинга из списка.
Связанные ресурсы
Дополнительную информацию о создании информационных панелей см.:
- Панели мониторинга и диаграммы
- Управляйте пользовательскими панелями мониторинга в консоли
- Управляйте панелями по API
Метрики использования
Для мониторинга использования API платформы Google Maps доступны две группы метрик: метрики времени выполнения службы (тип ресурса потребляемый_api ), доступные для большинства API Google Cloud , и метрики платформы Google Maps , специфичные для API платформы Google Maps метрики (тип ресурса maps.googleapis.com ). /Апи ).
Обе метрики поддерживают один и тот же набор меток ресурсов для разделения трафика использования API: project_id
, service
, method
, version
, location
и credential_id
. Описания меток ресурсов смотрите в документации соответствующего ресурса Metrics:
Каждая группа метрик имеет два типа метрик для мониторинга использования: количество запросов и задержки запросов .
В метрике Request Count вы можете разделить трафик использования по меткам метрик protocol
, grpc_status_code
, response_code
и response_code_class
. Кроме того, вы можете разделить их по platform_type
в показателях платформы Google Maps.
В показателе «Задержки запросов» вы можете разделить трафик использования по меткам метрик protocol
, platform_type
, response_code
и response_code_class
только в показателях платформы Google Maps.
Подробнее о типах и метках Метрик смотрите в документации соответствующей группы Метрик:
Сопоставление меток статуса ответа и кода ответа
В таблице ниже показано соответствие между кодом состояния ответа и кодом ответа HTTP, возвращаемым в ответ на запросы API платформы Google Maps, и метками кода ответа, доступными в Cloud Monitoring: код ответа HTTP, класс кода ответа HTTP, код состояния GRPC . Код состояния GRPC — это числовой код ответа gRPC для запросов gRPC или эквивалентный код gRPC для запросов HTTP.
Коды ответов, возвращаемые в ответах API | Коды ответов, переданные в мониторинг | |||
---|---|---|---|---|
Статус API Карт | HTTP-код ответа | HTTP-код ответа | Класс кода ответа HTTP | Код состояния GRPC |
ХОРОШО | 200, 204, 302 | 200, 204, 302 | 2хх, 3хх | 0 (ОК) |
ДАННЫЕ_НЕ_AVAILABLE, НЕ НАЙДЕНО, ZERO_RESULTS | 200 | 200, 404 ( 1 ) | 2хх, 4xx ( 1 ) | 5 (НЕ НАЙДЕНО) ( 1 ) |
INVALID_REQUEST (неверное значение параметра), MAX_ROUTE_LENGTH_EXCEEDED, MAX_WAYPOINTS_EXCEEDED, и т. д. | 200, 400 | 400 | 4хх | 3 (INVALID_ARGUMENT) |
INVALID_REQUEST (неверный/отсутствующий параметр, ошибка анализа запроса) | 200, 400 | 400 | 4хх | 3 (INVALID_ARGUMENT) |
REQUEST_DENIED | 200, 403, 200, 400 | 403, 401 ( 1 ) | 4xx ( 1 ) | 7 (PERMISSION_DENIED), 16 (НЕ ПОДТВЕРЖДЕНО) |
OVER_DAILY_LIMIT, OVER_QUERY_LIMIT, РЕСУРС_EXHAUSTED, ежедневный лимит превышен, предел лимита превышения, userRateLimitExceeded | 200, 403, 429 | 429 ( 1 ) | 4хх ( 1 ) | 8 (RESOURCE_EXHAUSTED) |
НЕИЗВЕСТНАЯ_ОШИБКА | 200, 500, 503 | 500 ( 1 ) , 503 | 5xx ( 1 ) | 2 (НЕИЗВЕСТНО)/13 (ВНУТРЕННИЕ) ( 1 ) , 14 (НЕДОСТУПНО) |
1. Чтобы повысить согласованность отчетов о кодах ошибок, API платформы Google Карт переходят: 1) с кода/класса ответа HTTP 200 / 2xx на 404 / 4xx (и кода состояния GRPC с 0 ( OK ) на 5 ( NOT_FOUND )) для Карт. Статусы API: DATA_NOT_AVAILABLE , NOT_FOUND , ZERO_RESULTS — статус , 2) из кода/класса ответа HTTP 200 / 2xx , 400 / 4xx до 403 / 4xx (и код состояния GRPC 7 ( PERMISSION_DENIED )) для статуса Maps API: REQUEST_DENIED , 3) из Код/класс ответа HTTP 200 / 2xx , 403 / 4xx до 401 / 4xx (код состояния GRPC 16 ( UNAUTHENTICATED )) для статуса Maps API: REQUEST_DENIED , 4) из кода ответа HTTP/класса 200 / 2xx , 403 / 4xx до 429 / 4xx для статусов Maps API: OVER_QUERY_LIMIT , dailyLimitExceeded , rateLimitExceeded , userRateLimitExceeded , 5) из кода/класса ответа HTTP 200 / 2xx до 500 / 5xx (и кода состояния GRPC 2 ( UNKNOWN ), 13 ( INTERNAL )) для статуса Maps API: UNKNOWN_ERROR . Оба кода ответа можно увидеть в течение переходного периода. Коды ответов, возвращаемые в ответах Maps API, не изменяются. Вы можете изучить разбивку кодов ответов, сообщаемых с течением времени, в обозревателе метрик . |
Создание оповещений
Оповещения позволяют своевременно узнавать о проблемах в ваших приложениях, чтобы вы могли быстро их решить. В Cloud Monitoring политика оповещений описывает обстоятельства, при которых вы хотите получать оповещения, и способ уведомления.
Политики оповещения могут быть простыми или сложными. Политики оповещений позволяют указать, может ли один временной ряд вызывать выполнение условия или несколько временных рядов должны удовлетворять условию, прежде чем оно будет выполнено. Например:
- Сообщите мне, когда количество запросов для определенного API превысит 1000 запросов за 5-минутный период.
- Уведомляйте дежурную группу, когда 90-й процентиль ответов HTTP 200 превышает задержку 100 мс для 3 или более API.
На следующем изображении показано определение оповещения для создания уведомления, когда количество запросов к API превышает 20 запросов в 5-минутном окне:
На этом изображении:
- На диаграмме показано количество вызовов API с течением времени для разных API.
- Красная линия показывает порог оповещения. Вызовы API, превышающие этот порог в течение 5-минутного окна, вызывают оповещение. В этом примере вы можете видеть, что один API превысил лимит.
При выполнении условий политики оповещений Cloud Monitoring открывает инцидент и отправляет уведомления:
- Инцидент — это постоянная запись, в которой хранится информация о отслеживаемых ресурсах на момент выполнения условия. Когда условие перестает выполняться, инцидент автоматически закрывается. Вы можете просмотреть все инциденты, открытые и закрытые, с помощью панели оповещений.
- Вы указываете, кого следует уведомлять, при настройке политики оповещений. Мониторинг поддерживает распространенные каналы уведомлений, включая электронную почту, облачное мобильное приложение и такие службы, как PagerDuty или Slack. Полный список каналов уведомлений см. в разделе Параметры уведомлений .
Типы оповещений
Cloud Monitoring поддерживает множество типов оповещений. Например, вы можете определить:
- Оповещения о пороговых значениях метрик : активируют оповещение, если метрика поднимается выше или падает ниже значения для определенного окна продолжительности или метрика увеличивается или уменьшается на заранее определенный процент.
- Оповещения о бюджете . Установите пороговые правила, чтобы получать уведомления, когда ваши расходы (фактические или прогнозируемые затраты) превышают определенный процент вашего бюджета (на основе установленных вами правил). Оповещение не ограничивает использование API, оно предупреждает вас только тогда, когда сумма ваших расходов приближается к указанной сумме.
- Оповещения о квотах . Google Cloud Platform устанавливает различные квоты, которые вы можете использовать для отслеживания и ограничения ресурсов, потребляемых проектом или организацией. Используйте оповещения для отправки уведомлений, когда использование приближается к пределу квоты.
Дополнительные сведения см. в разделе Типы политик оповещений .
Управление политиками оповещений
Вы можете добавить политику оповещений в свой проект с помощью Cloud Console или API Cloud Monitoring. Информацию о том, как просмотреть список политик оповещений на основе метрик вашего проекта и как изменить эти политики, см. в следующих статьях:
- Управление политиками оповещений с помощью Cloud Console
- Управление политиками оповещений с помощью Cloud Monitoring API
Создать оповещение
Создавая оповещение, вы:
- Определите условия, при которых будут активироваться ваши оповещения, на основе данных метрик.
- Определите каналы уведомлений, на которые будут отправляться оповещения.
В приведенном ниже примере показано, как настроить срабатывание оповещения, когда уровень использования службы платформы Google Maps для любого API превышает 2 запроса в течение 5-минутного окна.
Чтобы создать оповещение, выполните следующие действия:
- В облачной консоли выберите Мониторинг :
- Выберите Оповещение .
- Выберите «Редактировать канал уведомлений», чтобы определить, как оповещение отправляет уведомление. В этом примере вы будете использовать свой адрес электронной почты.
- Для канала электронной почты выберите Добавить новый .
- Введите адрес электронной почты и отображаемое имя .
- Выберите Сохранить .
- Выберите Оповещение .
- Выберите Создать политику .
- Выберите временной интервал, например 7 дней .
- В разделе «Условия оповещения» выберите «Новое условие» :
- Нажмите «Выбрать метрику» , выберите «Потребляемый API» в качестве ресурса и «Количество запросов» в качестве метрики, а затем нажмите « Применить» .
- (Необязательно) Под диаграммой находится список служб , quota_metrics , метод API и значение метрики. Выберите Добавить фильтр, чтобы отфильтровать данные на основе этой информации. Например, вы можете использовать фильтр, чтобы указать, что метод должен быть равен google.places.Autocomplete.http для запуска оповещения.
- В разделе «Преобразование данных» выберите 5 минут для скользящего окна и среднее значение для функции скользящего окна .
- Выберите Далее .
- В разделе «Настроить триггер оповещения» установите для порогового значения значение 2, чтобы указать срабатывание оповещения при наличии более двух запросов в 5-минутном окне. Обратите внимание, что на диаграмме теперь отображается красная линия, обозначающая предел оповещения для выбранного интервала времени. На графике вы можете увидеть, где могло бы сработать оповещение. Вы можете использовать эту диаграмму, чтобы при необходимости скорректировать лимит.
- Нажмите Далее .
- На странице «Настроить уведомления и завершить оповещение» :
- Выберите адрес электронной почты, который вы создали для канала уведомлений .
- В разделе «Назовите оповещение» введите «Мое тестовое оповещение» .
- Выберите Создать политику .
- Сделайте несколько запросов к API. Убедитесь, что вы сделали более двух запросов API в течение пяти минут, чтобы сгенерировать оповещение по электронной почте.
- После получения электронного письма с оповещением перейдите на страницу оповещений .
- В таблице со списком предупреждений щелкните предупреждение, чтобы просмотреть дополнительную информацию.
- Щелкните имя оповещения, чтобы просмотреть информацию о нем, включая диаграмму, показывающую событие, которое его вызвало.
Связанные ресурсы
Дополнительную информацию об оповещениях см.: