Аннотации Google Cloud Monitoring
Аннотации накладывают насыщенную информацию о событиях поверх графиков. С помощью аннотаций можно отмечать важные события, развёртывания или инциденты на дашбордах.
Прежде чем начать
Перед настройкой аннотаций убедитесь в наличии следующего:
- Настроенный источник данных Google Cloud Monitoring.
- Дашборд, на который вы хотите добавить аннотации.
Ограничения аннотаций
Учитывайте следующие ограничения при использовании аннотаций:
- Производительность: отрисовка аннотаций ресурсоёмка. Ограничивайте количество возвращаемых строк, чтобы поддерживать производительность дашборда.
- Нативные события: нет поддержки отображения нативных аннотаций и событий Google Cloud Monitoring. Однако аннотации хорошо работают с пользовательскими метриками в Google Cloud Monitoring.
Добавление запроса аннотации
Чтобы добавить запрос аннотации на дашборд:
- Перейдите к дашборду, который хотите изменить, и нажмите Edit.
- Нажмите значок Add new element (синий знак плюса).
- Нажмите Annotation query.
- Введите имя для запроса аннотации.
- Если вы не хотите использовать запрос аннотации сразу, снимите флажок Enabled.
- Выберите цвет для маркеров событий аннотации.
- Выберите вариант в раскрывающемся списке Show annotation controls in, чтобы управлять тем, где на дашборде отображается аннотация.
- Выберите вариант в раскрывающемся списке Show in, чтобы управлять тем, на каких панелях отображается аннотация.
- Нажмите Open query editor, чтобы открыть диалоговое окно Annotation Query.
- Выберите ваш источник данных Google Cloud Monitoring в раскрывающемся списке Data source.
- Настройте запрос аннотации и сопоставления полей.
- (Необязательно) Нажмите Test annotation query, чтобы убедиться, что запрос работает корректно.
- Нажмите Close, когда завершите настройку запроса.
- Нажмите Save.
- (Необязательно) Введите описание внесённых изменений.
- Нажмите Save.
- Нажмите Exit edit.
Настройка запроса аннотации
С помощью редактора запросов для аннотаций можно выбрать метрику и фильтры, чтобы определить, какие точки данных создают аннотации.
Поля Title и Text поддерживают шаблонизацию и могут использовать данные, возвращённые запросом.
Например, поле Title может содержать следующий текст:
{{metric.type}} has value: {{metric.value}}
Пример результата: monitoring.googleapis.com/uptime_check/http_status has this value: 502
Шаблоны аннотаций
Используйте следующие шаблоны в полях Title и Text для отображения данных метрик в ваших аннотациях:
Пример: аннотации сбоев проверки доступности
Чтобы создать аннотации для сбоев проверки доступности (uptime check):
- Добавьте запрос аннотации с использованием источника данных Google Cloud Monitoring.
- Выберите метрику
monitoring.googleapis.com/uptime_check/check_passed. - Добавьте фильтр
check_passed = false. - Задайте для Title значение:
Uptime check failed: {{metric.label.check_id}} - Задайте для Text значение:
Region: {{resource.label.zone}}
Это создаёт маркер аннотации на графике каждый раз, когда проверка доступности завершается неудачно.