Документация

Монитор транзакции управляет настоящим headless-браузером Chromium и проходит список шагов, который вы описали: открыть страницу, ввести текст в поле, нажать кнопку, дождаться чего-то, проверить, что на экране появилось нужное. Проверка успешна, только если прошли все шаги. Это единственный монитор в PingZen, который видит сайт так же, как его видит браузер, — и самый дорогой из всех, поэтому вторая половина страницы посвящена цене.

Для чего подходит

Для чего не подходит

Браузер медленный, дорогой и за один раз проходит только один сценарий. У большинства вопросов есть ответ дешевле:

Что делает одна проверка

1. Ждёт свободный слот браузера. В одном серверном процессе одновременно работают только два экземпляра Chromium, поэтому в загруженный момент здесь можно потерять заметные секунды.
2. Запускает headless-браузер Chromium, открывает новый контекст и пустую страницу. Ничего не наследуется от прошлой проверки: ни cookie, ни localStorage, ни открытая сессия.
3. Выполняет ваши шаги по порядку. Любая ошибка немедленно останавливает прогон — шаги после сломанного не выполняются.
4. Делает скриншот, если шаг упал и включён скриншот при ошибке.
5. Закрывает контекст и браузер и записывает общее время прогона как время отклика.

Поле URL самого монитора не открывается. Браузер стартует с пустой страницы, поэтому первым шагом должен быть шаг navigate — иначе селекторы будут искать элементы в пустоте.

Каждый шаг получает свою долю таймаута монитора: таймаут делится на количество шагов, но доля никогда не бывает меньше 5 секунд. При таймауте по умолчанию в 60 секунд и трёх шагах у каждого шага 20 секунд; при двадцати шагах у каждого остаётся нижняя граница в 5 секунд — именно поэтому длинные транзакции могут прожить дольше собственного таймаута (см. таблицу статусов ниже).

Действия шагов

У шага может быть имя. Если оставить его пустым, ошибка будет выглядеть как «Step 3: click» — читаемо, но хуже, чем «Отправить заказ».

Селекторы — это CSS-селекторы. Выбирайте что-то устойчивое: data-testid, id, атрибут name у поля формы. Селектор, собранный из сгенерированных имён классов, сломается на следующей сборке фронтенда и разбудит вас ночью из-за смены дизайна.

Проверки

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

Проверка ищет элемент сразу, а не ждёт его появления. Если элемент появляется через мгновение после клика, поставьте перед проверкой шаг wait.

Логика статусов

У монитора транзакции нет состояния «деградация». Либо прошли все шаги, либо проверка неуспешна.

И DOWN, и TIMEOUT считаются простоем и открывают инцидент после порога подтверждения — по умолчанию это три неуспешные проверки подряд. При минимальном интервале в 5 минут от первого сломанного прогона до алерта проходит около 10 минут — и до 15 с момента, когда сценарий действительно сломался. Если для этого сценария так слишком долго, снизьте порог до 1 или 2 и примите, что нестабильный селектор будет будить вас зря.

Шаг, упавший по таймауту, попадает в разбивке отказов в категорию «таймаут», хотя статус при этом DOWN, — так монитор, который постоянно упирается в бюджет шага, легко заметить на графике отказов.

Что сообщает об ошибке

Когда шаг ломается, проверка запоминает номер и имя упавшего шага, сколько шагов прошло до него и до десяти ошибок консоли браузера. Сообщение, которое сохраняется вместе с проверкой и попадает в историю и в алерт, — это строка «Step failed» или «Step timeout», и она называет шаг. Счётчики шагов и ошибки консоли собираются на каждом прогоне, но в истории проверок не хранятся: сегодня они существуют только внутри самой упавшей проверки.

О скриншотах. Если включён скриншот при ошибке (так по умолчанию), при падении шага сохраняется PNG всей страницы. Он попадает во временный каталог на сервере, который выполнял проверку, и наружу этот каталог нигде не отдаётся: открыть картинку из интерфейса PingZen или через API сейчас нельзя. То же самое относится к шагу screenshot. Считайте обе возможности незавершёнными, а не доказательством, на которое можно посмотреть, и делайте алерт понятным по одному имени шага.

Цена настоящего браузера

Любой другой монитор отправляет запрос. Этот запускает браузер — примерно четверть гигабайта памяти и несколько секунд старта до того, как выполнится первый шаг. PingZen закладывает эту цену в продукт:

О чём стоит подумать заранее:

• Монитор транзакции занимает такое же место в лимите тарифа, как любой другой, но обходится намного дороже в работе. Один хорошо выбранный сценарий лучше пяти пересекающихся.
• Не заводите отдельный монитор на каждую страницу воронки. Одна транзакция, проходящая воронку целиком, даёт то же покрытие за один запуск браузера.
• Держите число шагов честным. Бюджет шага — это таймаут, делённый на количество шагов, с нижней границей в 5 секунд, поэтому двадцать шагов по пять секунд могут выполняться сто секунд — дольше, чем прогон вообще разрешено вести, и он будет прерван как таймаут. Комфортно жить примерно до десяти шагов.
• Где выполняется проверка. Обычно — на центральном сервере PingZen. Проба может её выполнить, только если собрана с браузером, поэтому большинство локаций транзакции не предлагают: в выборе локаций видны лишь те, что их поддерживают.

Настройка

Размер окна, user agent и скриншот при ошибке спрятаны под переключателем «дополнительные параметры» под редактором шагов.

О чём стоит знать

Честные замечания о том, что ещё не доделано, — чтобы вы не потратили на это вечер:

• Поле «Scroll X» в редакторе шагов игнорируется. Шаг прокрутки использует только координату Y; если задать один X, страница прокрутится вниз до конца.
• Проверка no_console_errors ничего не делает. Ошибки консоли собираются, но проверку не роняют.
• Прокрутка к несуществующему селектору проходит молча. Это не способ убедиться, что элемент есть, — для этого используйте element_exists.
• Ожидание смены адреса поддерживается проверяющим кодом, но поля в редакторе шагов для него нет: добраться до него можно только через REST API. В форме вместо этого дождитесь селектора.
• Таймаут отдельного шага задаётся через API полем timeout_ms (в миллисекундах). Поле timeout, которое API тоже принимает, проверяющий код не читает — значение в нём молча игнорируется.
• Скриншоты нельзя посмотреть из интерфейса, как описано выше.

Ключевые возможности

• Ваш сценарий проходит настоящий headless-браузер Chromium, поэтому JavaScript, редиректы и клиентская отрисовка ведут себя так же, как у пользователя
• Двенадцать действий шага и девять типов проверок, собираемых в редакторе перетаскиванием, а не скриптом
• Каждый прогон начинается с чистого браузера — никаких оставшихся cookie и сессий между проверками
• Ошибка называет сломавшийся шаг и считает, сколько шагов прошло до него
• Переходы разрешены только на публичные адреса HTTP и HTTPS, поэтому монитор нельзя направить на внутреннюю инфраструктуру
• Границы интервала и таймаута выставляются за вас, так что браузерную проверку нельзя поставить в расписание как обычный HTTP-пинг