Настройка общедоступной страницы состояния
Каждая сущность может опубликовать одну страницу состояния для людей без учетной записи: пользователей услуг клиента, сотрудников филиала, партнера. Страница отвечает на один вопрос — работает ли служба, которой я пользуюсь? — под именем, с логотипом и в цветах самой сущности. В этом руководстве показано, как создать страницу, добавить ее компоненты, публиковать инциденты и опубликовать саму страницу.
Перед началом работы
- Вам нужна роль Entity admin (администратор сущности) в сущности, которую представляет страница.
- Должна быть включена функция
ui.public_status_page. Пока она выключена, страницу нельзя открыть, и экран сообщает об этом; суперадминистратор включает функцию в Settings › Instance. - Решите, что должны узнавать посетители: службы, такие как Клиентский портал или Оплата картой, а не имена серверов.
Что видят посетители и чего они не видят никогда
Страница строится поле за полем из списка разрешенных полей и никогда не получается фильтрацией внутренних данных.
| На странице | Никогда на странице |
|---|---|
| Заголовок, введение, логотип, тема и акцентный цвет | Имена ресурсов, имена хостов, типы, теги или идентификаторы |
| Компоненты с названиями, которые вы им даете, в группах и в вашем порядке | Проверки, метрики, значения или пороговые значения |
| Состояние каждого компонента и его полоса доступности за 90 дней | Оповещения, их заголовки, серьезность или количество |
| Инциденты, которые вы публикуете, с каждым обновлением и его временем | Кто опубликовал, кто назначен ответственным, любые данные из входящих оповещений |
| Обслуживание, которое вы решили объявить, с его общедоступными названием и описанием | Внутренняя причина окна обслуживания |
| Ссылки на RSS, Atom и JSON Feed и неприметная ссылка Sign in | Пути сущностей, другие сущности, название и логотип продукта |
Создание страницы
-
Откройте Settings › Status page и выберите сущность в средстве выбора, например ООО «Лукоморье».
-
Выберите Create a status page for ООО «Лукоморье». Страница создается неопубликованной.
-
В разделе Page заполните параметры:
Параметр Примечания Title Также задает название вкладки браузера и веб-каналов Introduction Короткий текст под заголовком Logo address https://…или путь на этом сервере, например/logos/ciguapa.svg. Если поле пусто, используется логотип ветви, если он есть, но никогда не логотип продуктаTheme Любая из тем консоли; по умолчанию Daylight Accent colour Цвет ссылок и рамок фокуса или Use the theme's Time zone of the daily bars Где начинается и заканчивается каждый день полос доступности. Время инцидентов и обслуживания показывается в часовом поясе каждого посетителя Own domain Необязательно, например status.ciguapa.example; см. ниже -
Выберите Save.
Public address имеет вид https://<server>/status/<entity short name>. Кнопка Open the public page открывает страницу, а Show preview показывает ее прямо здесь, опубликована она или нет.
Добавление компонентов
Компонент — это то, что узнают посетители. Он отслеживает ресурсы сущности страницы или сущностей ниже нее (раздел Follows): ресурс целиком или одну проверку ресурса, когда для службы важна только она.
- В разделе Components выберите Add a component.
- Введите Name, например Оплата картой, и при необходимости Description и Group. Компоненты с одинаковой группой показываются вместе.
- В разделе Follows выберите Resource и либо The whole resource, либо одну Check, а затем выберите Follow. Повторите это для каждого ресурса, от которого зависит служба.
- Оставьте выбранным Show the 90-day availability bar, если только процент мало что говорит об этом компоненте.
- Оставьте для Status shown значение From what it follows.
- Выберите Save component.
Чтобы изменить порядок, используйте стрелки. Рядом с каждым компонентом на экране показано, что сообщают отслеживаемые им ресурсы, поэтому устаревшее ручное состояние легко заметить.
| Что сообщают отслеживаемые ресурсы | Состояние компонента |
|---|---|
| Все отслеживаемые ресурсы работоспособны; проверка с серьезностью «информация» считается работоспособной | Operational (работает нормально) |
| Один ресурс в состоянии предупреждения | Degraded performance (снижена производительность) |
| Некоторые ресурсы в критическом состоянии или недоступны | Partial outage (частичный сбой) |
| Все ресурсы, от которых есть данные, в критическом состоянии | Major outage (крупный сбой) |
| Все ресурсы находятся в окне обслуживания | Under maintenance (на обслуживании) |
| Данных пока нет | Operational на странице, No data (нет данных) на полосах |
Ресурсы на обслуживании не учитываются ни в ту, ни в другую сторону: если один узел базы данных на обслуживании, а другой работоспособен, состояние — Operational. Ресурс с отключенными уведомлениями учитывается по реальному состоянию его проверок, потому что отключение уведомлений меняет уведомления, а не службу.
Чтобы переопределить состояние вручную, например указать Major outage, когда вы знаете больше, чем проверки, выберите его в поле Status shown. Затем верните значение From what it follows.
Публикация страницы
- Проверьте страницу с помощью Show preview.
- В разделе Page выберите Published, а затем Save.
Пока страница не опубликована, ее адрес возвращает ответ not found (не найдено); предварительный просмотр продолжает работать.
Сообщение об инциденте
- В разделе Incidents выберите Report an incident.
- Укажите Title, Impact (No impact, Minor impact, Major impact или Critical impact), Affected components, Status и первое Message.
- Выберите Report. Инцидент и его первое обновление появятся на странице и в веб-каналах с указанием времени.
- По мере поступления новых сведений публикуйте обновления с помощью Post update, каждое с этапом (Investigating — расследуется, Identified — причина найдена, Monitoring — наблюдение или Resolved — разрешено) и сообщением.
Открытый инцидент переводит затронутые им компоненты в состояние не лучше, чем его влияние: незначительное влияние — в Degraded performance, существенное — в Partial outage, критическое — в Major outage. Публикация этапа Resolved закрывает инцидент; он остается в разделе Past incidents 30 дней.
Через API можно также исправить текст более раннего обновления (но не его время и не этап) и сообщить об инциденте постфактум, указав время его начала.
Объявление обслуживания
Когда вы создаете окно обслуживания, выберите Announce on the status page и укажите Public title и, при необходимости, Public description; см. раздел Планирование окна обслуживания. Окно появляется на странице каждой сущности, компоненты которой отслеживают охваченные им ресурсы: в разделе Maintenance, пока оно выполняется, а в остальное время — с ближайшим повторением в пределах 30 дней. Для еженедельного окна указано, что оно повторяется, вместо перечисления каждой недели. Показываются только общедоступные название и описание, но никогда не внутренняя причина.
Публикация страницы состояния в собственном домене
Чтобы опубликовать страницу по адресу https://status.ciguapa.example/status/ciguapa, выполните следующие действия.
- Направьте DNS этого имени на сервер с помощью записи
CNAMEилиA. - Попросите суперадминистратора добавить имя как псевдоним в Settings › Server and certificates и, если используется сертификат Let's Encrypt или собственный, оставить это имя среди имен в сертификате. См. раздел Настройка имен и TLS.
- Введите имя в поле Own domain страницы и выберите Save.
Ссылки на странице и в ее веб-каналах тогда используют это имя, если страница открыта через него. Корень этого имени, https://status.ciguapa.example/, по-прежнему открывает страницу входа в консоль, поэтому делитесь полным адресом с /status/<short name>.
Настройка оформления ветви
Settings › Branch appearance задает Default theme и Logo address для сущности; каждая сущность ниже нее наследует их, пока не задаст собственные. In effect показывает результат и откуда он получен. Страница состояния без собственного логотипа использует логотип своей сущности. В этом выпуске сама консоль еще не применяет тему ветви; выбор темы самим пользователем в любом случае имеет приоритет.
Доступность
Каждый компонент записывает, сколько времени он провел в каждом состоянии, по дням часового пояса страницы. В дни перехода на летнее время или обратно в сутках 23 или 25 часов. Полоса показывает по одной ячейке на день — 90 на компьютере, 60 на планшете и 30 на телефоне — и окрашена в цвет самого тяжелого состояния, которое длилось минуту или больше в этот день; подробности отображаются при наведении указателя, касании или фокусе клавиатуры.
- Daily uptime (ежедневная доступность) = 1 − (крупный сбой + 0,3 × частичный сбой) ÷ известное время. Снижение производительности считается работой. Обслуживание и No data не входят в известное время, поэтому плановые работы никогда не снижают показатель.
- Итоговый процент вычисляется по той же формуле за 90 дней. У недавно созданного компонента показывается uptime since его первого дня.
- Период с любым простоем показывает не более 99,99 % и никогда не 100 %.
- История хранится 400 дней. Новый часовой пояс применяется к новым дням; записанные дни сохраняют свои границы.
Веб-каналы и кэширование
Страница ссылается на три веб-канала с обновлениями инцидентов и объявленным обслуживанием: RSS 2.0, Atom 1.0 и JSON Feed 1.1 — по адресам /api/v1/status/<short name>/feed.rss, feed.atom и feed.json. Добавьте ?lang=es, чтобы получить подписи на испанском языке. Подписка по электронной почте пока недоступна.
Общедоступные адреса не требуют входа и обрабатываются с малыми затратами. Страница отвечает с заголовками Cache-Control: public, max-age=30 и ETag, а веб-каналы — с max-age=300, поэтому CDN или прокси-сервер перед ними могут кэшировать их как есть. Ответы содержат Access-Control-Allow-Origin: *, поэтому другие сайты могут читать JSON.
Отключение страницы
- Чтобы скрыть страницу на время, снимите флажок Published и сохраните. Ее адрес сразу возвращает not found.
- Выключение функции
ui.public_status_pageделает то же самое для всех страниц. - Delete the page удаляет страницу вместе с ее компонентами, инцидентами и историей доступности. Это действие нельзя отменить.