Планирование окна обслуживания
Окно обслуживания охватывает период, когда от ресурсов ожидается нештатное поведение: ночь установки исправлений, проверка отработки отказа, миграция. Во время окна Excubius продолжает наблюдать и записывать данные, но никого не оповещает. В этом руководстве описаны три способа создать окно — из консоли и через API.
Перед началом работы
- Вам нужна роль Operator (оператор) или выше в сущности. Наблюдатели видят окна, но не могут их создавать.
- Определите область: вся сущность (все, что находится в ней и ниже) или отдельные ресурсы (и все, что обнаружено под ними, например группы доступности и базы данных экземпляра).
Выбор способа запуска
| Задача | Что использовать |
|---|---|
| Работы начинаются прямо сейчас | Start maintenance now: от 1 минуты до 7 дней |
| Плановая ночь | Schedule a window › Once: начало и окончание по времени вашего браузера, длительность до года |
| Регулярный интервал | Schedule a window › Every week: дни недели, местное время начала, длительность и часовой пояс |
Планирование еженедельного окна
- Откройте Settings › Maintenance windows и выберите сущность в средстве выбора, например ООО «Лукоморье» › Production.
- Выберите Schedule a window.
- Напишите причину в поле Reason. Это внутренний текст: он отображается в консоли, на временных шкалах оповещений и в журнале аудита, но никогда — на странице состояния.
- Выберите Every week.
- Укажите Days, Local start time, Duration (minutes) и Time zone, например суббота в 23:00 длительностью 180 минут в часовом поясе
America/Santo_Domingo. - В разделе Covers оставьте вариант All of Production — в нем указано имя выбранной сущности — или выберите Only some resources и отметьте нужные ресурсы.
- При необходимости выберите Announce on the status page и укажите Public title и Public description. Публикуются только эти два текста.
- Выберите Save window. Окно появится в разделе Next 14 days.
Для однократного окна на шаге 4 выберите Once и укажите, когда оно Starts и Ends, по времени вашего браузера.
Запуск обслуживания сейчас
- Откройте Settings › Maintenance windows и выберите сущность.
- В разделе Start maintenance now укажите For (minutes) и Reason, например 45 минут и Установка исправлений на sql-ventas-02 (изменение CHG-2231).
- В разделе Covers оставьте всю сущность, например All of Production, или выберите Only some resources и отметьте нужные ресурсы.
- Выберите Start now.
Окно появится в разделе Active now со временем окончания. Если работы завершились раньше, выберите в окне End now.
Что охватывает окно
| Область | Что охватывает |
|---|---|
| Сущность | Каждый ресурс сущности и каждой сущности ниже нее в том виде, в каком дерево существует в данный момент: ресурсы, добавленные в ветвь или перемещенные в нее позже, тоже охватываются |
| Отдельные ресурсы | Выбранные ресурсы сущности или сущностей ниже нее и все, что обнаружено под ними: группы доступности, базы данных и связанные серверы экземпляра |
Оповещение, возникшее на экземпляре и касающееся одной из его баз данных или одного из связанных серверов, охватывается, если охвачен этот дочерний ресурс. Окно для одной базы данных подавляет оповещения только этой базы данных, а не остальные оповещения экземпляра.
Что происходит во время окна
- Охваченные ресурсы вместо работоспособности показывают состояние Обслуживание на карточках панели мониторинга, в списках ресурсов и на странице ресурса.
- Проверки продолжают выполняться, а метрики — сохраняться, поэтому история остается полной, а настоящее состояние возвращается сразу после окончания окна.
- Оповещение, которое открывается, помечается окном, и ничего не отправляется. На его временной шкале указано, что оно открылось во время обслуживания.
- Оповещение, которое закрывается до окончания окна, разрешается без уведомлений, поскольку о нем ничего не объявлялось.
- Оповещение, которое все еще открыто к окончанию окна, объявляется в этот момент, как если бы оно только что открылось, — по обычной маршрутизации, с учетом периода тишины и отключений уведомлений.
- На временной шкале ресурса записано, когда начиналось и когда заканчивалось каждое окно и не завершил ли его кто-либо досрочно.
Окно обслуживания — это не отключение уведомлений. Отключение уведомлений на время подавляет одно существующее оповещение, а окно подавляет на период все, что связано с набором ресурсов, включая оповещения, которых еще нет.
Еженедельные окна и переход на летнее время
- Когда часы переводят вперед, время начала, которого не существует, наступает сразу после скачка.
- Когда часы переводят назад, время начала, которое наступает дважды, берется по первому разу.
- Длительность — это фактически прошедшее время, поэтому окно, которое охватывает переход, заканчивается на час раньше или позже по настенным часам.
- Окно может пересекать полночь или конец недели: окно, которое начинается в воскресенье в 23:00 и длится три часа, заканчивается в понедельник в 02:00. Одно повторение длится не более недели.
- End now в еженедельном окне прерывает только текущее повторение, а следующие проходят по плану. Изменение расписания отменяет это прерывание.
Изменение и удаление окна
В списке All windows показаны собственные окна сущности, окна сущностей ниже нее и окна, унаследованные от ее предков, — с пометкой From и именем сущности. У каждого окна есть действия изменения и удаления.
Удаление активного окна сначала завершает его, и на его временной шкале сохраняются начало и окончание. Оповещения, которые оно пометило, сохраняют запись на временной шкале, но теряют ссылку на удаленное окно.
Роли и аудит
| Действие | Роль в сущности окна |
|---|---|
| Просмотр окон — активных и предстоящих | Viewer |
| Создание, запуск, изменение, завершение или удаление | Operator |
Каждое изменение записывается в журнал аудита: maintenance.create, maintenance.start_now, maintenance.update, maintenance.end и maintenance.delete.
Через API
$BASE — это https://<your server>/api/v1, а $TOKEN — ваш токен доступа; см. раздел Краткое руководство. Добавление экземпляра SQL Server с помощью API.
# a two-hour weekly slot for the whole Production branch
curl -sS -X POST "$BASE/maintenance-windows" -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' -d '{
"entity_id": "'"$PROD"'", "kind": "weekly", "reason": "Weekly index maintenance",
"weekly": {"days": ["sun"], "start_time": "02:00", "duration_minutes": 120,
"timezone": "America/Santo_Domingo"}}'
# sql-ventas-02 is being patched now, for 45 minutes
curl -sS -X POST "$BASE/maintenance-windows/now" -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' -d '{
"entity_id": "'"$PROD"'", "resource_ids": ["'"$SQL02"'"], "minutes": 45,
"reason": "Patching sql-ventas-02 (change CHG-2231)"}'
# done early
curl -sS -X POST "$BASE/maintenance-windows/$WINDOW/end" -H "Authorization: Bearer $TOKEN"
| Запрос | Назначение |
|---|---|
GET /maintenance-windows?entity={id} | Окна сущности вместе с окнами ниже нее и унаследованными; фильтруйте с помощью state=active,scheduled,ended |
GET /maintenance-windows/active и /upcoming | Что находится на обслуживании сейчас и что будет дальше |
POST /maintenance-windows | Создание окна: kind — once (с starts_at и ends_at) или weekly (с weekly); scope — entity или resources (с resource_ids) |
POST /maintenance-windows/now | Запуск окна сейчас на minutes минут для сущности или для resource_ids |
PATCH /maintenance-windows/{id} | Изменение любого поля |
POST /maintenance-windows/{id}/end | Немедленное завершение активного повторения |
DELETE /maintenance-windows/{id} | Удаление окна; активное окно сначала завершается |
Чтобы объявить окно на странице состояния, добавьте "public": true и public_title, а при необходимости и public_description. Еженедельное окно можно ограничить необязательными полями starts_at и ends_at: учитываются только повторения, которые начинаются между этими моментами. Для однократного окна можно записать в поле timezone часовой пояс, в котором оно планировалось.
Связанное содержимое
- Подтверждение оповещения и работа с ним
- Сущности, теги и наследование: окна, заданные для сущности, охватывают все, что находится ниже нее
- Настройка общедоступной страницы состояния