Страница статуса Orbit

Страница статуса - это публичный URL без необходимости входа, который показывает, работает ли ваш проект, как он работал недавно и что вы развернули. Включение этой функции также запускает проверку времени доступности, которая проверяет связь с вашим проектом каждую минуту, поэтому вы получаете мониторинг как побочный эффект публикации.

Где находятся параметры страницы статуса

Откройте Orbit, нажмите на проект и выберите Status page в группе Observability на вкладке проекта. Страница называется Public status page.

Включение

1. Включите Enable public status page.
2. Выберите Public slug. Это становится частью публичного URL, поэтому выберите что-то узнаваемое, например название вашего продукта.
3. При необходимости установите Ping path. По умолчанию это /.
4. Заполните Page title и Tagline, отображаемые в верхней части публичной страницы.
5. Решите, нужно ли Show recent deploys и Show recent incidents.
6. Нажмите Save settings.

После сохранения страница показывает значок Live и подтверждает, что ваша страница статуса опубликована и проверяется каждую минуту. Ссылка позволяет перейти на публичную страницу, чтобы увидеть, что видят посетители.

Правила для slug

Slug должен состоять из строчных букв, цифр и дефисов, содержать не более 80 символов и не может начинаться или заканчиваться дефисом. Slug'и уникальны во всем Orbit, а не только в вашей учётной записи, поэтому часто используемое слово может быть уже занято. Если это так, сохранение вернёт сообщение о том, что slug уже занят, и вы выберете другой.

Выбирайте slug внимательно: это публичный адрес, который вы будете указывать в своей документации и в ответах поддержки, а его изменение позже нарушит каждую ссылку на него.

Что видят посетители

Публичная страница создаётся из тех же данных, что и вкладки вашего проекта:

• Current status из последнего развёртывания: Operational, Building, Deploying, Queued, Awaiting Approval, Build Failed, Cancelled или Rolled Back.
• Uptime, рассчитанный за скользящие окна из 24 часов, 7 дней и 30 дней на основе проверок каждую минуту.
• Recent deployments с процентом успеха, если вы включили этот раздел.
• 30-day statistics: процент успеха, среднее время сборки и всего развёртываний.
• Core Web Vitals как p75 за последние 30 дней, если вы их собираете.
• Incidents, взятые из аннотаций, которые вы отметили на временной шкале проекта.

Страница обновляется сама по себе, поэтому клиент, который оставит её открытой во время инцидента, увидит обновление без перезагрузки.

Инциденты берутся из Timeline

Раздел инцидентов - это не отдельный редактор. Он показывает аннотации типа Incident из Timeline проекта, поэтому рабочий процесс во время простоя: отметьте аннотацию инцидента, и она появится публично.

Это сделано специально. Это означает, что ваша внутренняя временная шкала и ваши публичные сообщения остаются синхронизированными без того, чтобы кто-то ведал две записи. См. Orbit Timeline Annotations, чтобы узнать, как её написать.

Проверка времени доступности

Включение страницы статуса запускает проверку, которая получает продакшн-URL вашего проекта по установленному вами пути ping один раз в минуту. Каждый результат сохраняется, и процентные показатели времени доступности на публичной странице рассчитываются из этих записей.

Проверки хранятся в течение 90 дней, а более старые автоматически удаляются.

Выбор хорошего пути Ping

По умолчанию / работает для большинства проектов. Две причины выбрать что-то другое:

• Ваша главная страница тяжелая. Лёгкий путь - это более справедливая и дешевая вещь для опроса один раз в минуту.
• Ваша главная страница может быть доступна, в то время как приложение сломано. Кэшированная статическая оболочка охотно вернёт 200, пока ваш API вниз. Путь, например /api/health, который действительно использует приложение, говорит правду.

Если у вас уже настроена проверка здоровья для автоматического отката, использование здесь же пути сохранит оба сигнала согласованными. См. Deploying Your Project для параметров проверки здоровья.

Удаление страницы статуса

Нажмите Remove page и подтвердите. Подтверждение явное: вся история времени доступности будет удалена.

Стоит в этом помедлить. Удаление страницы - это не кнопка паузы. Проверка прекращается, публичный URL перестаёт работать, и накопленная запись времени доступности исчезает вместе с ней. Если вы хотите только временно скрыть страницу, скрытого режима нет: подумайте, подходит ли вам выключение переключателя включения и оставление конфигурации на месте лучше, чем удаление её.

Slug освобождается при удалении страницы, поэтому кто-то другой может позже его заявить.

Практические советы

Опубликуйте, прежде чем это потребуется. Страница статуса, созданная во время простоя - это страница, которую никто не добавил в закладки. Поместите ссылку в ваш подвал, вашу документацию и вашу подпись поддержки, пока всё хорошо.

Не обещайте слишком много. Показатель времени доступности на странице основан на проверке один раз в минуту по одному пути. Это честный мониторинг, а не договорное SLA, и его не следует представлять как таковой.

Держите tagline коротким. Он расположен под заголовком на странице, которую люди открывают, когда они уже расстроены. Одна строка, говорящая, что это за сервис, и больше ничего.

Устранение неполадок

Время доступности показывает 0% или намного ниже, чем в действительности. Путь ping возвращает ответ, отличный от 2xx. Откройте его в приватном окне браузера: редирект на страницу входа, 404 из пути, который больше не существует, или географический блок - вот обычные причины.

Публичный URL возвращает 404. Страница сохранена, но переключатель включения отключён, или slug в вашей ссылке не совпадает с сохранённым. Скопируйте ссылку со страницы параметров.

Slug отклонён. Он занят, содержит недопустимый символ или начинается или заканчивается дефисом.

На публичной странице не отображаются метрики. Метрики поступают из скрипта сборщика на вашем сайте. См. Orbit Web Vitals.

Инциденты не отображаются, хотя они были. Аннотация должна быть типа Incident, и переключатель Show recent incidents должен быть включён.

Куда пойти дальше

• Orbit Timeline Annotations для публикации обновлений инцидентов.
• Orbit Webhooks для уведомления раньше, чем ваши клиенты.
• Orbit Web Vitals для показателей производительности, отображаемых публично.