Мониторинг работы приложения «Бонусные карты и программа лояльности для Битрикс24» в период внедрения и эксплуатации
Задачи со стороны бизнеса
— Внедрить и начать эксплуатировать приложение «Бонусные карты и программа лояльности для Битрикс24»;
— Выстроить процессы мониторинга его работы и помощи менеджерам со стороны заказчика, за если это необходимо;
Для кого статья
— Партнёры Битрикс24, осуществляющие внедрение приложения у клиентов;
— Сотрудники IT-отделов со стороны клиента, которые отвечают за работу Битрикс24;
Метрики работы приложения «Бонусные карты и программа лояльности для Битрикс24»
Метрика - числовой показатель, который привязан к конкретной дате.
У любой метрики есть свойства:
- Наименование — человеческое описание метрики;
- Описание — подробное описание назначения метрики;
- Символьный код метрики — уникальный и человекочитаемый код метрики, по которому её можно однозначно идентифицировать;
- Тип метрики:
— INTEGER — целочисленные значения;
— FLOAT — значения с плавающей запятой;
— MONEY — тип деньги;
— PERCENTAGE — тип проценты; - Дата — дата и время создания метрики;
- Uuid — глобально уникальный идентификатор метрики.
Данные для принятия решений
Актуальный список метрик есть в статье метрики приложения Бонусные карты и программа лояльности для Битрикс24.
Метрики считаются автоматически, раз в сутки за прошедший день.
Операционные показатели программы лояльности выводятся в отдельном дашборде, ссылку на актуальную версию можно получить в разделе инструменты для работы с приложением «Бонусные карты и программа лояльности для Битрикс24»
Системный журнал приложения
Все значимые события в приложении фиксируются и сохраняются в системный журнал приложения.
У каждого события есть свойства:
- Timestamp — дата и время наступления события, часовой пояс +3, МСК;
- Level (уровень), логический уровень значимости события:
— emergency - зарезервировано, не используется;
— alert - зарезервировано, не используется;
— critical - зарезервировано, не используется;
— error - ошибка;
— warning - требует внимания;
— notice - предупреждение;
— info - информация не требующая реакции;
— debug - отладочная информация - Message — само тело сообщения;
- Source — символьный код источника события
- EventUuid — глобально-уникальный идентификатор события;
Порядок работы с шаблоном «B24io.Loyalty — B24 partner dashboard»
- Скачать актуальную версию шаблона.
- Открыть приложение и скопировать из вкладки «Интеграции» :
— API-endpoint адрес куда слать запросы к API;
— Клиентский API-ключ - идентификатор клиента;
— API-ключ для роли администратор - ключ с уровнем доступа «Администратор» - Скопировать их в шаблон B24io.Loyalty — B24 partner dashboard на вкладку «Настройки»
- Обновить страницу
Возможности шаблона «B24io.Loyalty — B24 partner dashboard»
Сводка по работе приложения – общее количество записей с группировкой по типу в разбивке по дням
Если начинаются проблемы, то это становится заметно и человек отвечающий за внедрение и эксплуатацию может начать «копать» в нужном направлении.
Возможности шаблона «B24io.Loyalty — B24 partner dashboard»
Получение записей из системного журнала
Можно получить записи из системного журнала за указанный интервал времени для разбора или поиска по нужным идентификаторам.
Пример ошибок в конфигурации: созданы сделки без привязки к контактам
Настройки шаблона
Данные в настройки шаблона копируются из вкладки «интеграции» внутри самого приложения
Our projects
REST-API приложения «Бонусные карты и программа лояльности для Битрикс24»
Получение всех этих данных возможно через REST-API, для PHP написана библиотека упрощающая интеграцию — loyalty-php-sdk
.