Мониторинг работы приложения в период внедрения и эксплуатации

Задачи со стороны бизнеса

— Внедрить и начать эксплуатировать приложение

«Бонусные карты PassWallet и программа лояльности для Битрикс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 — глобально-уникальный идентификатор события;

Системный журнал за последние сутки доступен в приложении. Если требуется получить данные за больший период, то можно забрать их их из API или специального инструмента — «B24io.Loyalty — B24 partner dashboard», ссылка на актуальную версию приведена на странице инструменты для работы с приложением «Бонусные карты и программа лояльности для Битрикс24»

ПОРЯДОК РАБОТЫ С ШАБЛОНОМ «B24IO.LOYALTY — B24 PARTNER DASHBOARD»

1. Скачать актуальную версию шаблона.

2. Открыть приложение и скопировать из вкладки «Интеграции» : — API-endpoint адрес куда слать запросы к API; — Клиентский API-ключ — идентификатор клиента; — API-ключ для роли администратор — ключ с уровнем доступа «Администратор»

3. Скопировать их в шаблон B24io.Loyalty — B24 partner dashboard на вкладку «Настройки»

4. Обновить страницу

ВОЗМОЖНОСТИ ШАБЛОНА «B24IO.LOYALTY — B24 PARTNER DASHBOARD»

СВОДКА ПО РАБОТЕ ПРИЛОЖЕНИЯ – ОБЩЕЕ КОЛИЧЕСТВО ЗАПИСЕЙ С ГРУППИРОВКОЙ ПО ТИПУ В РАЗБИВКЕ ПО ДНЯМ

Если начинаются проблемы, то это становится заметно и человек отвечающий за внедрение и эксплуатацию может начать «копать» в нужном направлении.

ВОЗМОЖНОСТИ ШАБЛОНА «B24IO.LOYALTY — B24 PARTNER DASHBOARD»

ПОЛУЧЕНИЕ ЗАПИСЕЙ ИЗ СИСТЕМНОГО ЖУРНАЛА

Можно получить записи из системного журнала за указанный интервал времени для разбора или поиска по нужным идентификаторам. Пример ошибок в конфигурации: созданы сделки без привязки к контактам

ВОЗМОЖНОСТИ ШАБЛОНА «B24IO.LOYALTY — B24 PARTNER DASHBOARD»

НАСТРОЙКИ ШАБЛОНА

Данные в настройки шаблона копируются из вкладки «интеграции» внутри самого приложения

REST-API ПРИЛОЖЕНИЯ «БОНУСНЫЕ КАРТЫ И ПРОГРАММА ЛОЯЛЬНОСТИ ДЛЯ БИТРИКС24»

Получение всех этих данных возможно через REST-API, для PHP написана библиотека упрощающая интеграцию — loyalty-php-sdk