artem
21.11.2018
1445

Логирование phpagi

В данной статье изучим структуру логирования библиотеки phpagi. Также рассмотрим возможность дополнительного логирования файла phpagi-asmanager.php.

Рассмотрим, как устроено логирование в библиотеке phpagi. Для начала рассмотрим логирование в файле phpagiasmanager.php.

Сам скрипт модно найти в открытом доступе по следующей ссылке.

В данном файле за логирование отвечает функция log. На вход подаётся два параметра:

                $message — сообщение, которое будет записано в файл лога;

                $level — уровень логирования (принимает значения от 1 до 4, по умолчанию равен 1);

Приведём код данной функции:

function log($message, $level=1)
{
    if($this->pagi != false)
        $this->pagi->conlog($message, $level);

    else

        error_log(date(‘r’) . ‘ — ‘ . $message);
}
 

Как видно, есть два пути выполнения функции. Первый подразумевает наличие объекта pagi. Если он существует, то будем использовать для логирования его метод conlog (его рассмотрим чуть позднее). В другом варианте, воспользуется стандартной функцией php записи логов: error_log. На вход данной функции подаётся строка, которая будет выведена в лог php.

По умолчанию, запись происходит в файл: /var/log/httpd/error_log.

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

fgrep ErrorLog /etc/httpd/conf/httpd.conf

В результате получим строку, вида:

ErrorLog logs/error_log

Соответственно, в конце указано имя файла, содержащего лог.

Теперь вернёмся к рассмотрению второго варианта (когда объект pagi всё же создан). В этом случае будет вызван метод conlog. Сам метод описывается в скрипте phpagi.php. Рассмотрим его:

function conlog($str, $vbl=1)

{

    static $busy = false;

    if($this->config[‘phpagi’][‘debug’] != false)

    {

        if(!$busy) // no conlogs inside conlog!!!

        {

            $busy = true;

            $this->verbose($str, $vbl);

            $busy = false;

        }

    }

}

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

Проверить (а заодно и включить) данную настройку можно в файле /etc/asterisk/phpagi.conf раздел [phpagi] debug.

Затем, если условия выполнены, скрипт пойдёт дальше, передавая параметры в функцию verbose.

function verbose($message, $level=1)

{

    foreach(explode(«n», str_replace(«rn», «n», print_r($message, true))) as $msg)

    {

        @syslog(LOG_WARNING, $msg);

        $ret = $this->evaluate(«VERBOSE «$msg» $level»);

    }

    return $ret;

}

На вход также подаётся два параметра. Значения и смысл их абсолютно аналогичен параметрам функции log файла phpagiasmanager.php, рассмотренной в начале статьи.

В данной функции производится непосредственный вывод сообщения в файл лога.

По умолчанию, функция syslog записывает данные в системный лог.

Для системы CentOS 6.9 данный файл находится по пути: /var/log/messages.

Там и следует искать вывод логов.

Теперь рассмотрим возможность дополнительного логирования файла phpagi-asmanager.php.

Дополнительное логирование

Откроем для редактирования файл phpagi-asmanager.php.

В качестве дополнительного логирования, добавим результат ответов на наши запросы к сокету. По умолчанию, ответы типа «response» не пишутся в лог-файл.

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

switch($type)

{

}

В описание caseresponse добавляем код, получим:

case ‘response’:

    $this->log(‘Get response request with parameters: ‘.print_r($parameters, true));

break;

Дополнительное логирование

Теперь рассмотрим на примере, как выглядит лог с ответами. Сразу уточню, что в нашем примере объект pagi не создан, поэтому запись логов ведётся в файл /var/log/httpd/error_log.

Лог-файл

На этом скриншоте представлен стандартный сеанс обмена данными. Сперва отсылаются данные для аутентификации. В ответ получаем тип Response, со значением Success. Это означает, что авторизация пройдена успешно. Далее отправляется событие, к примеру, Originate. В данный пример включена ошибка в вызываемом номере. Характер ошибки можно увидеть в прилагаемом к ответу сообщении (Message). После выполнения всех команд разлогиневаемся, в ответ получая: Goodbye.

Если не записывать ответы типа Response, предыдущие строки в логах будут отсутствовать.

Таким образом, дебажить, имея в логах ответы с сокета гораздо удобнее.

Также могут быть интересны следующие статьи по логированию в Asterisk:

Сбор логов на одном сервере с нескольких других, посредством SysLog

Расширенное логирование звонков: CEL — Channel Event Logging

Подписаться
Уведомление о
guest
0 Комментарий
Inline Feedbacks
View all comments

Остались вопросы?

Я - Кондрашин Игорь, менеджер компании Voxlink. Хотите уточнить детали или готовы оставить заявку? Укажите номер телефона, я перезвоню в течение 3-х секунд.

VoIP оборудование

ближайшие курсы

ближайшие Вебинары

ONLINE

10 доводов в пользу Asterisk

Распространяется бесплатно.

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

Безопасен в использовании.

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

Надежен в эксплуатации.

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

Гибкий в настройке.

Зачастую возможности Asterisk ограничивает только фантазия пользователя. Ни один конструктор шаблонов не сравнится с Asterisk по гибкости настройки. Это позволяет решать с помощью Asterisk любые бизнес задачи, даже те, в которых выбор в его пользу не кажется изначально очевидным.

Имеет огромный функционал.

Во многом именно Asterisk показал какой должна быть современная телефонная станция. За многие годы развития функциональность Asterisk расширилась, а все основные возможности по-прежнему доступны бесплатно сразу после установки.

Интегрируется с любыми системами.

То, что Asterisk не умеет сам, он позволяет реализовать за счет интеграции. Это могут быть интеграции с коммерческими телефонными станциями, CRM, ERP системами, биллингом, сервисами колл-трекинга, колл-бэка и модулями статистики и аналитики.

Позволяет телефонизировать офис за считанные часы.

В нашей практике были проекты, реализованные за один рабочий день. Это значит, что утром к нам обращался клиент, а уже через несколько часов он пользовался новой IP-АТС. Безусловно, такая скорость редкость, ведь АТС – инструмент зарабатывания денег для многих компаний и спешка во внедрении не уместна. Но в случае острой необходимости Asterisk готов к быстрому старту.

Отличная масштабируемость.

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

Повышает управляемость бизнеса.

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

Снижает расходы на связь.

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