Новогодний подарок любителям подебажить: модуль отладчик

Кто работал с каким-либо дебаггером кода, знает, как это бывает удобно для быстрой отладки: код можно выполнять построчно в поисках ошибки. PHP из коробки не имеет такой возможности, но можно поставить xdebug настроить GUI и получить тот же результат. На практике это хорошо работает для локальных скриптов, но настройка сильно усложняется когда скрипт работает на дальнем сервере. Когда речь идет о поддержке, то почти всегда приходится работать с дальним кодом. Мне давно хотелось решить эту проблему.
[spoiler]

Изначально сделал скрипт, который работает с xdebug по протоколу DBGp. Он реализовывал базовые функции отладки, но всё равно был сложен в реализации и требовал настройки сервера. На долгое время проект был заморожен.

Затем, работая с трейсом xdebug, поймал себя на мысли, что постоянно приходится открывать исходный код, чтобы лучше понять картину происходящего. Если вы не работали с трейсами xdebug, должен сказать, что сама по себе - это прекрасная штука. При наличии подгруженного модуля xdebug в php вы можете просто указать в любом месте вызов xdebug_start_trace(), и получите в отдельном файле информацию, подобную этой:
При внимательном прочтении тут можно найти всё, что надо о работе своего (или чужого) скрипта. Однако, задача выглядит не такой радостной, когда трейс файл имеет размер - несколько десятков или сотен мегабайт. Тут уже хочется иметь какой-то инструмент.

Сначала это был простой скрипт, а теперь модуль bitrix.xdebug в marketplace, который при внешней простоте скрывает много возможностей.

Отладчик
Что мы видим при открытии трейса:


Сверху кнопки навигации по файлу трейса:
Начало - переход к первой записи в файле,
Шаг влево - переход на строчку вверх в трейсе (на предыдущий вызов функции - этой возможности в дебаггерах нет т.к. программы не умеют выполняться назад),
     Шаг вниз - на одну запись в трейсе, на следующий вызов функции или определение переменной (если информация о присвоении переменных есть в трейсе, параметр xdebug.collect_assignments)
     Шаг вправо - переход далее не заходя внутрь функции,
     Шаг вверх - выйти из текущей функции и перейти к следующему шагу.

После включения опции "отображать результат выполнения функций" вы увидите возвращаемые значения после вызова функции (если была включена опция xdebug.collect_return при отладке). Имейте ввиду, что информацию об этом в файле трейса появляется после отработки всех вложенных функций, что может потребовать времени на поиск.

Есть полезная особенность навигации: все запросы идут через ajax, но текущая позиция сохраняется в адресной строке в виде якоря, это значит, что вы можете всегда нажать F5 и оказаться на том же месте.

Поиск в трейсе:


Все опции ищут с учетом регистра по подстроке и работают по условию "логическое И". К адресу файла можно дописать номер строки после двоеточия для перехода на конкретную строку.

В исходном коде все номера строк кликабельные:

Затем нажимаем "далее" и переходим к помеченной строке.


Для построения текущей картинки не используется предобработка (трейс строится в момент хита), что позволяет перейти в любое место трейса:


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

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


В настройках модуля можно изменить размер буфера чтения, по умолчанию стоит 100 Кб, что очень быстро, 1 Мб - приемлемо, 10 Мб и более уже ощущаются заметные тормоза.

Все вызовы функций в стеке кликабельны, позволяют перейти к месту их вызова.


В исходном файле текущая строка подсвечивается, прошлая строка меняет цвет на бледный.


Если вы загрузили себе трейс, полученный на другом сайте, и исходный код недоступен, все прелести отладки остаются доступны, а вместо исходного кода отображается нужный фрагмент трейса:


Модуль имеет настройки:


Можно по своему правилу на PHP можно включить отладку на определенное время. Дело в том, что модуль регистрируется на событие OnPageStart и не требует модификации кода или конфигов php. При достижении условия срабатывает вызов xdebug_start_trace(), при этом в обработчике фиксируются серверные переменные, которые потом могут потребоваться для отладки.


Для большего удобства сделана поддержка специальной cookie и ссылки для неё. Перетащите ссылку на панель закладок и получите возможность включать/выключать сбор отладки для текущего сайта:


По отладке всё, помимо этого есть ещё интересный функционал: профилировщик.
Но об этом я хочу рассказать в другой раз отдельно.

Включение xdebug на виртуальной машине Битрикс

На нашей виртуальной машине xdebug поставляется с первых версий. Для включения модуля надо просто раскомментировать его подключение в /etc/php.d/xdebug.ini

Войдите под пользователем root, выполните:

в редакторе и замените:
на
Это можно сделать через sftp или mc.

Затем перезапустите Apache: При этом никакие дополнительные настройки xdebug делать не надо, это делается на лету в момент запуска отладки.

Надеюсь, новый модуль сильно облегчит жизнь разработчикам под Битрикс.