Логирование

Owned by Анастасия Денискина (Unlicensed)
Last updated: Apr 11, 2024 by Радик Шарафиев
8 min read

На этой странице мы расскажем вам о работе с логированием на портале и разберем следующие вопросы:

Что такое логи и зачем они нужны

Логирование – это процесс фиксации изменений, которые происходят в системе при взаимодействии с ней.

Логи помогают контролировать изменения и видеть ответственных за их появление. Логирование ошибок помогает в диагностике проблем.

Как найти логи

Логи расположены в Административной части портала в разделе Логи

image-20240319-010257.png

Как понять какие логи мне нужны

Что ищем

Где смотреть

Что ищем

Где смотреть

Изменения конфигурации кармы: кто изменил настройки и какие параметры были изменены

Лог баллов

Изменения в контенте: кто и что изменил в новости, мероприятии, уроке, учебном плане, тестировании

Лог действий

Изменения связанные с импортом паролей: кто и когда производил импорт, кому был изменен пароль и статус загрузки

Лог импорта паролей

Действия пользователей, осуществлённые во время маскировки под другими пользователями

Лог маскировки

Данные об ошибках: время возникновения, страница, код ошибки

Лог ошибок

Изменения в личных карточках пользователей, удаление и восстановление пользователей на портале. Кто кого удалил, деактивировал, восстановил.

Лог пользователей

Детально функционал описан ниже, в соответствующих разделах документации.

Лог баллов

Пример отображения страницы Лог баллов.
(1) Столбец ID; (2) Столбец Дата события; (3) Столбец Инициатор; (4) Столбец Действие; (5) Столбец Цель; (6) Столбец Изменение

На портале предусмотрено логирование всех действий администраторов по изменению конфигурации баллов:

Инструмент располагается в разделе Логи – Лог баллов. 

Фильтрация и сортировка не предусмотрены.

Поля в таблице:

  • ID – уникальный номер записи

  • Дата события – дата и время внесения изменений

  • Инициатор – имя пользователя, который внес изменения. Активная ссылка в ЛК пользователя в Публичной части портала

  • Действие:

    • Обновил

  • Цель – название параметра, в котором внесены изменения.

  • Изменения – обновление, которое совершил администратор в формате “Название поля: Было → Стало”
    Пример: Изменено значение параметра "Валюта для покупки призов": Старое - Из кармы, Новое - Из обучения

Таблица логов не выгружается в .xlsx-файле.

Лог действий

Располагается в разделе Логи – Лог действий и фиксирует изменения в контенте.

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

Блок поиска и фильтрации состоит из:

  • Выпадающие списки фильтрации по доступным параметрам:

    • Фильтрация записей в заданный диапазон логирования, по дате и времени – формат: с “ДД.ММ.ГГГГ ЧЧ:ММ” по “ДД.ММ.ГГГГ ЧЧ:ММ”.

    • Инициатор события – доступен множественный выбор из списка пользователей

    • Действие – доступен множественный выбор из списка возможных действий

  • Поле ввода Поиск. Поиск осуществляется по следующим параметрам:

    • id записи лога

    • id сущности

  • Кнопка Применить – по нажатию применяются параметры и осуществляется поиск и фильтрация

  • Кнопка Сбросить – появляется после выполненного поиска/фильтрации, по нажатию поиск и фильтрация сбрасываются и кнопка вновь скрывается

  • Кнопка Сохранить xlsx – по нажатию выгружается таблица логов в файле формата .xlsx

Поля в таблице:

  • ID – уникальный номер записи

  • Дата события – дата и время внесения изменений

  • Инициатор – имя и фамилия пользователя, который внес изменения, где “имя и фамилия” – это активная ссылка в ЛК пользователя в Публичной части портала, а кнопка “карандашик“ – ссылка на редактирование пользователя в Панели администрирования

  • Действие – действие, которое совершил пользователь:

    • Обновил

    • Создал

    • Удалил

    • Восстановил

    • Отменил

    • Деактивировал

    • Активировал

    • Обновил пароль

    • Обновил назначения

    • Обновил доступы

  • Цель – название материала, в котором внесены изменения, где “название материала” – это активная ссылка на страницу материала в Публичной части портала, а кнопка “карандашик“ – ссылка на редактирование материала в Панели администрирования

    • Механика работы активной ссылки “Название материала“:

      • Если материал удален – ссылка не отображается

      • Если материал удален и неактивен – ссылка ведет на страницу материала в Публичной части портала, но раз материал неактивен, отображается 404 ошибка

      • Если материал удален и активирован – ссылка ведет на страницу материала в Публичной части портала

    • Важно! Для объектов, у которых нет своих страниц в публичной части (неактивен, удален) или в панели администрирования (удален и его нельзя восстановить), ссылка или кнопка “карандашик“ не выводятся.

  • Изменение – список данных, которые были изменены в формате “Название поля: Было → Название поля: Стало”, при этом значение “Было” выводится на сером фоне, а “Стало” – на зеленом

Лог действий Опросы

В логе действий, где Целью являются Опросы, в поле Изменения логируются следующие значения:

Действие

Изменения

Особенности

Действие

Изменения

Особенности

Создание/обновление/удаление опроса в модуле Опросы

  • Заголовок опроса

  • Кратко

  • Приветственный текст

  • Опрос активен

  • Превью-изображение

  • Дата начала

  • Дата окончания

  • Кол-во баллов в карму за прохождение опроса

  • Анонимный опрос

  • Удалил

  • Назначения:

    • Роли

    • Пользователи

    • Почта

    • Пользовательские группы

  • Вопросы:

    • ID:

      • Тип вопроса

      • Содержание вопроса

      • Комментарий к ответу

      • Категория ответов

      • Несколько вариантов ответа

      • Удалил

      • Обязательный вопрос

      • Порядок

      • Ответы:

        • ID:

          • Ответ

          • Изображение:

            • ID

            • Ссылка

  • При создании опроса логируются все значения

  • При обновлении опроса логируются только изменённые значения

  • При удалении опроса логируется только изменение Удалил

Создание/обновление опросов на вкладке Опрос в модулях где он представлен

  • Заголовок опроса: Опрос для {название модуля} - {заголовок материала}

  • Вопросы:

    • ID:

      • Тип вопроса

      • Содержание вопроса

      • Комментарий к ответу

      • Категория ответов

      • Несколько вариантов ответа

      • Удалил

      • Обязательный вопрос

      • Порядок

      • Ответы:

        • ID:

          • Ответ

          • Изображение:

            • ID

            • Ссылка

  • При создании опроса логируются все значения. Созданием опроса в модуле где он представлен считается сохранение материала этого модуля с активным чек-боксом Активность опроса на вкладке Опросы

  • При обновлении опроса, а именно при редактировании вопросов в нем (другие изменения не логируются), выводятся изменения не только тех вопросов, в которых произошли изменения, а выводится полный список всех предыдущих Вопросов и полный список всех текущих Вопросов со всеми их значениями

В логе действий, где Целью являются вопросы из базы вопросов в модуле Опросы, в поле Изменения логируются следующие значения:

Действие

Изменения

Особенности

Действие

Изменения

Особенности

Создание/обновление/удаление вопросов из базы вопросов

  • ID

  • Тип вопроса

  • Содержание вопроса

  • Комментарий к ответу

  • Категория ответов

  • Несколько вариантов ответа

  • Удалил

  • Ответы:

    • ID:

      • Ответ

      • Изображение:

        • ID

        • Ссылка

  • При создании вопроса логируются все значения

  • При обновлении вопроса логируются только изменённые значения

  • При удалении вопроса логируется только изменение Удалил

Создание/обновление вопросов на вкладке Опрос в модулях где он представлен

  • ID

  • Тип вопроса

  • Содержание вопроса

  • Комментарий к ответу

  • Категория ответов

  • Несколько вариантов ответа

  • Удалил

  • Ответы:

    • ID:

      • Ответ

      • Изображение:

        • ID

        • Ссылка

  • При создании вопроса логируются все значения

  • При обновлении вопросов в модуле, выводятся изменения не только тех вопросов, в которых произошли изменения, а выводится полный список всех предыдущих Вопросов и полный список всех текущих Вопросов со всеми их значениями

Лог действий Тестирования

В логе действий, где Целью являются Тестирования, в поле Изменения логируются следующие значения:

Действие

Изменения

Особенности

Действие

Изменения

Особенности

Создание/обновление тестирования в модуле Тестирования

  • Заголовок

  • Тестирование активно

  • Скрыть в общем списке материалов

  • Обязательный материал

  • Категория:

    • ID

    • Название

  • Кратко

  • Текст

  • Изображение (превью):

    • ID

    • Ссылка

  • Изображение (шапка):

    • ID

    • Ссылка

  • Случайный порядок вопросов

  • Кол-во вопросов

  • Порог прохождения

  • Баллы за прохождение

  • Баллы за 100% прохождение

  • Общее количество попыток

  • Бесконечное количество попыток

  • Попытки для получения баллов

  • Предыдущие попытки и история ответов

  • Показывать правильные ответы

  • Показывать неправильные ответы

  • Интервал между попытками (Дни)

  • Интервал между попытками (Часы)

  • Интервал между попытками (Минуты)

  • Время на одну попытку

  • Включить прокторинг

  • Дата начала видимости тестирования

  • Дата окончания видимости тестирования

  • Периодичность автопереназначения

  • Дата отсчёта автопереназначения

  • Время начала доступности тестирования

  • Время окончания доступности тестирования

  • Дедлайн

  • Удалил

  • Доступ:

    • Роли

    • Пользователи

    • Почта

    • Пользовательские группы

  • Вопросы:

    • ID

    • Тип вопроса

    • Текст вопроса

    • Пояснение ко всем ответам

    • Удалил

    • Категория:

      • ID

      • Название

    • Ответы:

      • ID:

        • Ответ

        • Верный

        • Порядок

        • Изображение:

          • ID

          • link

        • Соответствия:

          • Тип:

            • Значение

  • При создании тестирования логируются все значения

  • При обновлении тестирования логируются только изменённые значения

Удаление тестирования в модуле Тестирования

–

В логе удаления тестирования запись в поле Изменение не происходит. Логируется только факт удаления.

Восстановление тестирования в модуле Тестирования

  • Тестирование активно

  • Удалил

При восстановлении тестирования логируется изменение Удалил и Тестирование активно, т.к. при восстановлении тестирование деактивируется

В логе действий, где Целью являются вопросы из базы вопросов в модуле Тестирования, в поле Изменения логируются следующие значения:

Действие

Изменения

Особенности

Действие

Изменения

Особенности

Создание/обновление вопросов из базы вопросов

  • ID

  • Тип вопроса

  • Текст вопроса

  • Пояснение ко всем ответам

  • Удалил

  • Категория:

    • ID

    • Название

  • Ответы:

    • ID:

      • Ответ

      • Верный

      • Порядок

      • Изображение:

        • ID

        • link

      • Соответствия:

        • Тип:

          • Значение

  • При создании вопроса логируются все значения

  • При обновлении вопроса логируются только изменённые значения

Лог импорта паролей

Располагается в разделе Логи → Лог импорта паролей и фиксирует изменения всех запросов связанных с импортом паролей:

  • Кто производил импорт — ФИО пользователя

  • Когда происходил импорт — дата и время импорта

  • Кому загрузили пароль (на каждого пользователя отдельная строка) — ФИО пользователя и его УИ

  • Статус загрузки — Успешно / Неуспешно

Сами пароли, которые были загружены в систему, не отслеживаются в логировании

Раздел импорта паролей доступен пользователям с включенным разрешением роли Личный кабинет — Управление пользователями.

Страница логов импорта паролей состоит из:

  • # — ID лога

  • — дата и время импорта в формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС

  • — ФИО пользователя, который производил импорт. По клику переход на страницу пользователя в админпанели

  • — статус обновления пароля: Успешно / Неуспешно

  • — ФИО пользователя, которому загружали пароль

Фильтрация и сортировка не предусмотрены.

Лог маскировки

Инструмент располагается в разделе Логи – Лог маскировки

В логе фиксируется, когда одни пользователи осуществляют маскировку под другими пользователями и выполняют под ними какие-то действия.

Записи вносятся в таблицу в хронологическом порядке по убыванию даты изменений.

Фильтрация не предусмотрена.

Поля в таблице:

  • ID – уникальный номер записи

  • Дата начала – дата и время совершение действия под маскировкой

  • Замаскированный пользователь – ФИО пользователя, который совершил маскировку. Активная ссылка в ЛК пользователя, в Публичной части портала.

  • Оригинальный пользователь – ФИО пользователя под которым замаскировались. Активная ссылка в ЛК пользователя, в Публичной части портала.

  • URL – Адрес куда ушёл запрос;

  • Тип запроса

  • Данные – список данных, которые отправил Замаскированный пользователь (предположительно в формате json)

Таблицу логов можно выгрузить в .xlsx-файл.

Как расшифровать лог маскировки

Поля и их описание

Пример

Объяснение

Поля и их описание

Пример

Объяснение

Url – адрес куда ушёл запрос, в котором можно отследить в каком разделе портала произошло действие и что было выполнено

Тип запроса – возможны следующие значения:

  • POST – создание или регистрация записей. Подразумевает отправку данных, но могут быть запросы в которых данных может не быть, например, простое нажатие кнопки подтверждения

Данные – список данных, которые отправил Замаскированный пользователь в формате json, который может состоять из:

  • JSON-объект – неупорядоченное множество пар «ключ:значение», заключённое в фигурные скобки «{ }».

  • Массив – упорядоченный набор значений, разделенных запятыми. Находится внутри квадратных скобок [].

  • Число (целое или вещественное).

  • Литералы true (логическое значение «истина»), false (логическое значение «ложь») и null.

  • Строка

Url https://motivity.test.motivationportal.ru/pulse/pulse/create/edit/submit

Тип запроса POST

Данные

{ "text" : "Это моя первая запись в пульсе" }

 

 

 

  • Создана новая запись (/create/edit/submit) в модуле Пульс (/pulse/pulse)

  • Использован метод создания/редактирования записи в модуле Пульс

  • При создании записи был применен текст “Это моя первая запись в пульсе“

Url https://motivity.test.motivationportal.ru/pulse/pulse/item/63/edit/submit

Тип запроса POST

Данные

{ "id" : "63" "text" : "Это моя самая первая запись в пульсе в этом году" }

  • Отредактирована (/edit/submit) запись (/item/63) в модуле Пульс (/pulse/pulse)

  • Использован метод создания/редактирования записи в модуле Пульс

  • При редактировании существующей записи (уникальный идентификатор записи – 63) в Пульсе, был применен текст “Это моя самая первая запись в пульсе в этом году“

Лог ошибок

Располагается в разделе Логи – Лог ошибок.

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

Раздел доступен только для пользователей с ролью Верховный администратор

Срок хранения ошибок – 6 месяцев, которые удаляются кроном command → log.delete (запускается раз в месяц).

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

В этом разделе реализована фильтрация по типу ошибок и по периоду.
Список значений фильтра по типу ошибки:

  • Любой тип

  • 4096

  • Compile Error

  • error

  • error_500

  • Notice

  • Warning

Фильтрация записей также возможна в заданный период логирования, по дате и времени.
Формат: с ДД.ММ.ГГГГ ЧЧ:ММ по ДД.ММ.ГГГГ ЧЧ:ММ.

Поля в таблице:

  • ID – уникальный номер записи

  • Дата – дата и время появления ошибки в системе

  • Тип ошибки

  • Ссылка на страницу с ошибкой

  • Код ошибки

Таблицу логов можно выгрузить в .xlsx-файле.

Важно: предусмотрена фильтрация по типу и дате ошибки. Если фильтр был настроен, то в отчёт попадут только отфильтрованные данные.

Лог пользователей

Располагается в разделе Логи – Лог пользователей.

Фиксирует изменения в личных карточках пользователей, удаление и восстановление пользователей на портале.

Поля в таблице:

  • ID – уникальный номер записи в системе

  • Дата события – дата и время внесения изменений

  • Инициатор – имя пользователя, который совершил действие. Активная ссылка в ЛК пользователя, в Публичной части портала.

  • Действие:

    • Удалил – лог формируется при удалении пользователя администратором

    • Восстановил – лог формируется при восстановлении пользователя администратором

    • Сброс пароля – лог формируется при сбросе пароля в Административной части портала

    • Создал – лог формируется при создании пользователя администратором

    • Обновил – лог формируется при обновлении Пользователя в Административной части портала

  • Цель – ФИО пользователя, для которого внесены изменения. Активная ссылка в ЛК пользователя, в Публичной части портала.

    • Важно! Для объектов, у которых нет своих страниц в панели администрирования, не выводится ссылка.

  • Изменение – список данных, которые были изменены в формате “Название поля: Было → Стало”

    • Важно! В логе пользователей не отображается информация о начисленных баллах кармы за ежедневный вход пользователя, если вход был осуществлен другим пользователем под маскировкой.

Таблицу логов можно выгрузить в .xlsx-файле.