Окна обслуживания
Окна обслуживания в Ключ-АСТРОМ
Назначение
В работе системы бывают плановые и внеплановые периоды обслуживания, во время которых возможны перебои в работе сервисов. В такие периоды не нужно получать уведомления о недоступности сервисов, и эти периоды не должны учитываться при контроле доступности системы. Чтобы исключить такие периоды, задают окна обслуживания.
Окна обслуживания позволяют Ключ-АСТРОМ распознавать периоды возможно ненормальной работы: простои, периоды сниженной производительности, всплески трафика при нагрузочных тестах. Окно, заданное на время ненормальной работы, снижает поток оповещений и сохраняет чистоту базовых линий, от которых зависит точность мониторинга и оповещений.
> Держите систему мониторинга производительности в курсе плановых работ, чтобы данные мониторинга оставались точными.
Задать окно можно двумя способами: через Configuration API или через веб-интерфейс.
Ограничение: до 2000 окон обслуживания на одну среду мониторинга. Лимит действует на все окна независимо от их состояния.
Типы окон
Ключ-АСТРОМ различает два типа окон обслуживания.
| Плановое | Внеплановое |
|---|---|
| Задаётся заранее | Задаётся задним числом или на текущий сбой |
| Исключается из обычного расчёта базовой линии | Исключается из обычного расчёта базовой линии |
Влияние на расчёт базовой линии
После определения окна Ключ-АСТРОМ автоматически исключает заданный период из расчёта базовых линий. Аномалии времени отклика, возникшие внутри окна, не влияют на общие базовые линии сервисов и приложений.
Как работают окна
После создания окна на странице «Проблемы» появляется фильтр «На обслуживании»: он показывает список проблем, возникших в периоды обслуживания.
Если для окна выбрано полное отключение обнаружения проблем, обнаруженные проблемы не отображаются на странице «Проблемы».
На странице объекта при выборе общего интервала времени, в который попадает период обслуживания объекта, сведения выводятся на плитке «Обслуживание». Если объект попадает в несколько периодов обслуживания, показывается последнее окно и количество окон, которые объект пережил за выбранный интервал.
Способы определения окна
| Способ | Где |
|---|---|
| Веб-интерфейс | Настройки → Окна обслуживания → Мониторинг, оповещение и доступность |
| Configuration API | раздел Maintenance windows API, см. ниже |
Определение окна в веб-интерфейсе
Каждое окно имеет имя и описание: в них указывают контекст и цель окна.
- Откройте Настройки → Окна обслуживания → Мониторинг, оповещение и доступность.
- Нажмите Добавить окно обслуживания.
- Задайте Имя окна.
- При необходимости заполните Описание с целью окна.
- В поле Тип обслуживания выберите Плановое или Внеплановое.
- Задайте расписание повторения (один раз, ежедневно, еженедельно, ежемесячно), интервал повторения и часовой пояс.
- В поле Обнаружение проблем и оповещение укажите, что делать при проблеме на наблюдаемом компоненте во время окна:
- Обнаруживать проблемы и оповещать. Ключ-АСТРОМ обнаруживает и сообщает обо всех проблемах как обычно, а на каждой проблеме, обнаруженной во время окна, отображает иконку окна обслуживания.
- Обнаруживать проблемы, но не оповещать. Проблемы обнаруживаются, но оповещения по ним не отправляются. Каждая проблема выводится на странице «Проблемы» с иконкой окна обслуживания.
- Отключить обнаружение проблем. Проблемы не обнаруживаются и оповещения не отправляются. Проблемы, возникшие во время планового окна, не попадают на страницу «Проблемы».
- При необходимости включите Отключить выполнение синтетического монитора на время окна.
- При необходимости задайте область действия окна. Если область не задана, окно действует на всю среду.
Созданное окно включено по умолчанию. Отключить или удалить его можно на странице настроек Окна обслуживания. Колонки списка: Включено, Состояние, Итог. Состояние выводится латиницей: Upcoming (окно ещё не началось), Expired (закончилось). Кнопка Удалить просроченные окна обслуживания удаляет просроченные окна списком.
Окна обслуживания могут исключаться из расчёта доступности синтетического мониторинга. Это глобальная настройка синтетического мониторинга, а не свойство отдельного окна.
Отключение выполнения синтетических мониторов
В окне обслуживания можно включить Отключить выполнение синтетического монитора. Во время окна HTTP- и браузерные мониторы в области действия окна не выполняются.
Чтобы отключение сработало, синтетические мониторы должны попадать в область действия окна. Выполнение отключается только для тех мониторов, которые в неё включены.
Браузерные и HTTP-мониторы, связанные с сервисами, а также веб-, мобильными и пользовательскими приложениями из области действия окна, тоже не выполняются.
Например: если окно задано одним фильтром по приложению, все браузерные и HTTP-мониторы, связанные с этим приложением, отключаются, хотя в окне явно не перечислены.
Область действия окна
По умолчанию окно действует на всю среду. Область можно сузить до конкретных наблюдаемых объектов, оставив остальные без изменений.
Область задаётся одним или несколькими фильтрами (кнопка Добавить фильтр).
Каждый фильтр применяется отдельно: объект, подходящий под любой из фильтров, включается в окно. Например: фильтр по браузерным мониторам с тегами easytravel и frontend и второй фильтр по HTTP-мониторам с тегом easytravel-api дают окно, в которое входят браузерные мониторы с обоими тегами и HTTP-мониторы с тегом easytravel-api.
Внутри одного фильтра объект должен соответствовать всем заданным условиям, чтобы попасть в окно.
Условия фильтра
- Тип объекта. Тип выбирается из подсказок при вводе. На один фильтр можно добавить только один тип объекта. Если других условий нет, в окно попадают все объекты указанного типа. Сузить выбор можно тегами объекта или зонами управления.
- Объект. Сначала выбирается тип объекта, затем объект из списка имён и идентификаторов. На один фильтр можно добавить только один объект по идентификатору.
- Теги объекта. Одна или несколько пар «ключ-значение» (кнопка Добавить тег). Можно указать необязательный тип объекта. Несколько тегов означают, что объект должен соответствовать всем тегам. Регистр в тегах учитывается.
- Зоны управления. Одна или несколько зон из списка. Несколько зон означают, что объект должен соответствовать всем зонам.
Пустой фильтр сохранить нельзя: карточка выдаёт сообщение «Необходимо хотя бы одно значение фильтра».
Родительские и групповые связи
При определении области действия Ключ-АСТРОМ учитывает связи объектов с родителями и группами.
Если в окно попал родительский объект, его непосредственные дочерние объекты тоже считаются находящимися на обслуживании. Например: окно задано для хоста, значит его диски тоже на обслуживании. Если проблема возникла на диске, а родительский хост на обслуживании, диск считается на обслуживании.
Если в окно попала группа объектов, её непосредственные элементы тоже считаются на обслуживании. Например: окно задано для группы хостов, значит её хосты на обслуживании. Но диски этих хостов на обслуживании не считаются, если хосты не включены в окно явно.
Рекомендации по фильтрам
Фильтры применяются отдельно, внутри фильтра объект должен соответствовать всем условиям.
- Указан только тип объекта без других условий: в окно попадают все объекты этого типа.
- Для каждого типа объекта, который нужно добавить в окно, создавайте отдельный фильтр. Если в одном фильтре указать один тип объекта и тег, который всегда стоит на объектах другого типа, в окно не попадёт ни один объект.
- Чтобы добавить объект по идентификатору, не задавайте в этом фильтре других условий: иначе объект может не попасть в окно.
- Чтобы добавить в окно все объекты с заданным тегом, оставьте в фильтре единственное условие с этим тегом. Для каждого такого тега создавайте отдельный фильтр.
- Чтобы добавить в окно все объекты заданной зоны управления, оставьте в фильтре единственное условие с этой зоной. Для каждой такой зоны создавайте отдельный фильтр.
API
Configuration API окон обслуживания позволяет управлять окнами и простоями из сторонних инструментов.
| Метод | Назначение |
|---|---|
GET /api/config/v1/maintenanceWindows
|
Список всех окон в среде |
GET /api/config/v1/maintenanceWindows/{id}
|
Параметры окна по идентификатору |
POST /api/config/v1/maintenanceWindows
|
Создание окна |
PUT /api/config/v1/maintenanceWindows/{id}
|
Изменение окна |
DELETE /api/config/v1/maintenanceWindows/{id}
|
Удаление окна |
curl -s -H "Authorization: Api-Token $ASTROMKEY_API_TOKEN" \ "https://<host>/e/<env-id>/api/config/v1/maintenanceWindows" | jq .
Документация помечает этот API как устаревший и предлагает Settings API со схемой Maintenance windows (builtin:alerting.maintenance-window).
curl -s -H "Authorization: Api-Token $ASTROMKEY_API_TOKEN" \ "https://<host>/e/<env-id>/api/v2/settings/schemas/builtin:alerting.maintenance-window" | jq '.types'
