Логи системы: различия между версиями
(→Параметры фильтрации) |
|||
(не показаны 44 промежуточные версии 4 участников) | |||
Строка 2: | Строка 2: | ||
[[Категория:Функции]] | [[Категория:Функции]] | ||
<!-- --> | <!-- --> | ||
− | '''Логи системы''' — модуль | + | '''Логи системы''' — модуль {{NameSystem|link}} для учета действий и событий, происходящих в системе. |
==Назначение== | ==Назначение== | ||
− | + | nemo.travel поддерживает гибкий инструмент логирования всех важных операций, происходящих в ней. Это помогает в кратчайшие сроки узнать детальную информацию практически по любому действию внутри системы. Интерфейс предоставляет широчайший выбор фильтров для выбора необходимых данных. Кроме того, имеется ряд предустановленных фильтров, которые выделены в отдельный блок и доступны по ссылкам. | |
==Принцип работы== | ==Принцип работы== | ||
Логи в зависимости от типа бывают: | Логи в зависимости от типа бывают: | ||
− | * индексируемые | + | * индексируемые — ошибки, предупреждения и пр. Эти логи можно искать через фильтры логов. |
− | * | + | * не индексируемые — сообщение и пр., доступны в теле одного лога-действия при открытии. |
− | Если после отработанного скрипта не было собрано ни одного лога с индексацией | + | Если после отработанного скрипта не было собрано ни одного лога с индексацией, логи не сохраняются. |
'''Принципы:''' | '''Принципы:''' | ||
Строка 27: | Строка 27: | ||
* Таблица логов. | * Таблица логов. | ||
− | Записи логов разбиты постранично, чтобы перейти к следующей странице, нажмите ссылку '''След | + | Записи логов разбиты постранично, чтобы перейти к следующей странице, нажмите ссылку '''След.''' внизу таблицы. |
{| class="wikitable" | {| class="wikitable" | ||
Строка 35: | Строка 35: | ||
|Страница логов | |Страница логов | ||
|} | |} | ||
+ | |||
+ | '''Успешность действия''' — это признак одного {{NameProject1}} запроса, например, для поиска — это получение хотя бы одного результата, для бронирования — успешная бронь и т.п. | ||
== Таблица логов == | == Таблица логов == | ||
− | * '''Столбцы таблицы''' | + | * '''Столбцы таблицы''' — параметры логов, |
− | * '''Строки таблицы''' | + | * '''Строки таблицы''' — записи действий. |
Одна запись лога называется '''действием''' (по сути эквивалент одного php-скрипта). Действие содержит множество '''операций'''. | Одна запись лога называется '''действием''' (по сути эквивалент одного php-скрипта). Действие содержит множество '''операций'''. | ||
− | Каждая запись в таблице | + | Каждая запись в таблице — действие. Чтобы открыть его операции, разверните запись, нажав на нее. <br /> Некоторые операции сопровождаются ссылкой '''Данные''', открывающей дополнительную информацию о событии (операции): тело XML-запроса, набор параметров или полное сообщение (если краткое обрезалось по длине) и т.п. |
На каждое действие (лог) присутствует ссылка. Дополнительно могут быть ссылки ''Выгрузить архивом xml логи'', ''Просмотр заказа'', ''Просмотр результатов поиска'', ''Форма поиска'' и др. | На каждое действие (лог) присутствует ссылка. Дополнительно могут быть ссылки ''Выгрузить архивом xml логи'', ''Просмотр заказа'', ''Просмотр результатов поиска'', ''Форма поиска'' и др. | ||
− | |||
− | |||
Зеленым цветом выделены логи, в которых происходило взаимодействие с ГРС. | Зеленым цветом выделены логи, в которых происходило взаимодействие с ГРС. | ||
Строка 55: | Строка 55: | ||
* '''Запуск''' — время запуска действия. | * '''Запуск''' — время запуска действия. | ||
* '''Пользователь''' — пользователь, запустивший действие. | * '''Пользователь''' — пользователь, запустивший действие. | ||
− | * '''Компонент''' — компонент, | + | * '''Компонент''' — компонент системы, к которому относится данное действие. |
* '''Действие''' — наименование действия. | * '''Действие''' — наименование действия. | ||
* '''Сообщение''' — короткое идентификационное сообщение, используется для поиска логов. | * '''Сообщение''' — короткое идентификационное сообщение, используется для поиска логов. | ||
* '''Заказ''' — номер заказа. | * '''Заказ''' — номер заказа. | ||
* '''Поиск''' — номер поиска. | * '''Поиск''' — номер поиска. | ||
− | * '''Биллинг''' | + | * '''Биллинг''' — номер транзакции по оплате. |
* '''Поставщик''' — наименование задействованного поставщика услуг. | * '''Поставщик''' — наименование задействованного поставщика услуг. | ||
* '''Время выполнения''' — численное значение (в секундах). | * '''Время выполнения''' — численное значение (в секундах). | ||
Строка 69: | Строка 69: | ||
** режим работы системы, в котором было выполнено действие). | ** режим работы системы, в котором было выполнено действие). | ||
− | + | ==Фильтры логов == | |
− | |||
− | |||
− | |||
− | |||
− | |||
Для поиска логов используют фильтры. По умолчанию форма фильтров отображается на странице в свернутом виде, в котором доступны наиболее используемые параметры фильтрации: | Для поиска логов используют фильтры. По умолчанию форма фильтров отображается на странице в свернутом виде, в котором доступны наиболее используемые параметры фильтрации: | ||
− | *'''Пользователь''' | + | *'''Пользователь''' — идентификатор пользователя, |
− | *'''Заказ''' | + | *'''Заказ''' — идентификатор заказа, |
− | *'''Сообщение''' | + | *'''Сообщение''' — короткое идентификационное сообщение для поиска логов, |
− | *'''Событие''' | + | *'''Событие''' — перечень регистрируемых системой событий. |
Чтобы получить доступ ко всем параметрам фильтра, нажмите кнопку ''Дополнительные фильтры'' (см. раздел [[Логи системы#Дополнительные фильтры|Дополнительные фильтры]]). | Чтобы получить доступ ко всем параметрам фильтра, нажмите кнопку ''Дополнительные фильтры'' (см. раздел [[Логи системы#Дополнительные фильтры|Дополнительные фильтры]]). | ||
− | |||
− | |||
− | |||
==== Дополнительные фильтры ==== | ==== Дополнительные фильтры ==== | ||
Полная форма фильтров включает в себя следующие поля: | Полная форма фильтров включает в себя следующие поля: | ||
− | |||
− | |||
{| class="wikitable mw-collapsible mw-uncollapsed" | {| class="wikitable mw-collapsible mw-uncollapsed" | ||
|- | |- | ||
Строка 117: | Строка 107: | ||
* ''[Нотификация] Email'' — e-mail нотификация. | * ''[Нотификация] Email'' — e-mail нотификация. | ||
* ''[Нотификация] Ошибка'' — ошибка при нотификации. | * ''[Нотификация] Ошибка'' — ошибка при нотификации. | ||
− | * ''[Ошибка] Валидация'' — ошибка при бэкенд валидации (формы например). | + | * ''[Ошибка] Валидация'' — ошибка при бэкенд-валидации (формы, например). |
* ''[Ошибка] Ограничение доступа'' — ошибка с запретом доступа кому-нибудь куда-нибудь. | * ''[Ошибка] Ограничение доступа'' — ошибка с запретом доступа кому-нибудь куда-нибудь. | ||
* ''[Ошибка] Блокировка'' — для неопределенных ошибок вызванных функцией контроллера ->lock(). | * ''[Ошибка] Блокировка'' — для неопределенных ошибок вызванных функцией контроллера ->lock(). | ||
− | * ''[Ввод/вывод] Запрос'' — получили входящий запрос | + | * ''[Ввод/вывод] Запрос'' — получили входящий запрос. |
* ''[Ввод/вывод] Ответ'' — ответ на входящий запрос. | * ''[Ввод/вывод] Ответ'' — ответ на входящий запрос. | ||
− | * ''[Ввод/вывод] Загрузка файла'' — кто-то | + | * ''[Ввод/вывод] Загрузка файла'' — кто-то загружает файл. |
− | * ''[Ввод/вывод] Локальный автозапрос'' — запуск http запроса к своему серверу. | + | * ''[Ввод/вывод] Локальный автозапрос'' — запуск http-запроса к своему серверу. |
− | * ''[Интеграция] Экспорт'' — экспорт | + | * ''[Интеграция] Экспорт'' — экспорт из системы. |
− | * ''[Интеграция] Импорт'' — импорт | + | * ''[Интеграция] Импорт'' — импорт в систему. |
* ''[Интеграция] Ошибка'' — ошибка импорта/экспорта. | * ''[Интеграция] Ошибка'' — ошибка импорта/экспорта. | ||
* ''[Авторизация] Через сайт'' — авторизация через сайт. | * ''[Авторизация] Через сайт'' — авторизация через сайт. | ||
Строка 159: | Строка 149: | ||
* ''[Оплата] Переход на страницу шлюза'' | * ''[Оплата] Переход на страницу шлюза'' | ||
* ''[Оплата] Смена способа оплаты'' | * ''[Оплата] Смена способа оплаты'' | ||
− | * ''[ | + | * ''[Баланс] Изменение баланса'' |
− | * ''[ | + | * ''[Баланс] Изменение доступного овердрафта'' |
− | * ''[ | + | * ''[Баланс] Доступные средства'' |
* ''Предупреждение'' | * ''Предупреждение'' | ||
|- | |- | ||
Строка 241: | Строка 231: | ||
* Не успешные | * Не успешные | ||
|- | |- | ||
− | |||
|} | |} | ||
+ | === Предустановленные фильтры === | ||
+ | Для быстроты поиска создан блок ссылок с предустановленными фильтрами: | ||
+ | * Мои логи (текущего пользователя). | ||
+ | * Мои логи (по IP). | ||
+ | * Проблемные выписки. | ||
+ | * Частичные выписки. | ||
+ | * Проблемные бронирования. | ||
+ | * Проблемные аннуляции. | ||
+ | ==Поиск записей логов== | ||
+ | ===Поиск логов=== | ||
+ | Чтобы применить фильтрацию к логам: | ||
+ | # Выставите значения фильтров. | ||
+ | # Нажмите на кнопку ''Поиск''.<br />Чтобы отменить фильтр, нажмите на кнопку ''Сброс''. | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | |[[Файл:Поиск логов.png|500px]] | ||
+ | |- | ||
+ | |Поиск логов по e-mail нотификациям указанного пользователя. | ||
+ | |} | ||
− | + | ===Поиск логов поисковых запросов=== | |
+ | Логи поисковых запросов записываются в отдельную таблицу. | ||
− | + | Чтобы искать поисковые логи: | |
− | + | # Нажмите на кнопку ''Таблица логов поисковых запросов''. | |
+ | # Выставите значения фильтров. | ||
+ | # Нажмите на кнопку ''Поиск''.<br />Чтобы отменить фильтр, нажмите на кнопку ''Сброс''. | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | |[[Файл:Кнопка_Таблица_логов_поисковых_запросов.png|500px]] | ||
+ | |- | ||
+ | |Ссылка на таблицу логов поисковых запросов | ||
+ | |} | ||
− | === | + | {| class="wikitable" |
− | + | |- | |
− | * | + | |[[Файл:Поиск_логов_поиска.png|500px]] |
− | * | + | |- |
− | * | + | |Пример поиска логов поисковых запросов |
− | * | + | |} |
− | * | + | |
− | + | ===Поиск восстановленных логов=== | |
+ | |||
+ | После перехода по ссылке '''Поиск восстановленных логов''', поиск будет вестись в специальном хранилище логов, которые по какой-либо причине были утрачены, а затем восстановлены. | ||
+ | |||
+ | === Примеры поиска логов === | ||
+ | |||
+ | * '''По номеру заказа''': | ||
+ | *# введите номер заказа в поле ''Заказ'', | ||
+ | *# нажмите кнопку ''Поиск''. | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | |[[Файл:Поиск_логов_по_номеру_заказа.png|500px]] | ||
+ | |- | ||
+ | |Поиск логов по номеру заказа | ||
+ | |} | ||
+ | * '''По ошибке''' — если искомые заказы содержат известную ошибку: | ||
+ | *# введите текст ошибки в поле ''Сообщение''. | ||
+ | *# нажмите кнопку ''Поиск''. | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | |[[Файл:Поиск заказов пользователя по ошибке.png|500px]] | ||
+ | |- | ||
+ | |Поиск логов с ошибкой среди заказов указанного пользователя.png | ||
+ | |} | ||
== Логирование XML-данных == | == Логирование XML-данных == | ||
Строка 271: | Строка 312: | ||
Если в содержимом события находится не только XML, то из всего содержимого вычленяется и выводится только XML (например, выгрузка Немо/Софи). | Если в содержимом события находится не только XML, то из всего содержимого вычленяется и выводится только XML (например, выгрузка Немо/Софи). | ||
− | Для того чтобы браузер не подвисал из-за большого объема лога события (более 64000 символов) на главной странице логов (settings/logs) вместо содержимого выводится соответствующее сообщение. XML можно просмотреть в отдельном окне через специальный плагин. | + | Для того, чтобы браузер не подвисал из-за большого объема лога события (более 64000 символов), на главной странице логов (settings/logs) вместо содержимого выводится соответствующее сообщение. XML можно просмотреть в отдельном окне через специальный плагин. |
== Примеры логирования == | == Примеры логирования == | ||
− | + | В {{NameSystem}} логируются следующие действия: | |
− | * | + | * изменение настроек в панели администрирования, |
− | * | + | * действие с заказом (в т.ч. нотификации, выгрузки, оплаты, фиксации статусов и т.д.), |
+ | * поиск, | ||
+ | * авторизация / регистрация на сайте, | ||
+ | * действие в ЛК (экспорт заказов, отправка сообщений/заявок и т.д.). | ||
− | === | + | ===Особенности логирования действий в {{NameSystem}}=== |
− | + | * Реквизиты подключения к ГРС: | |
− | * | + | ** При изменении реквизитов подключения к ГРС эти изменения и состояние настроек до них логируются. |
− | * | + | ** При удалении реквизитов логируется id самих удаляемых реквизитов и какие данные содержались в этом id. |
− | * | ||
− | |||
− | |||
+ | * Логирование изменения значения настройки — изменение настроек также логируется: | ||
+ | ** дата и время изменения значения настройки; | ||
+ | ** полное название настройки; | ||
+ | ** пользователь, изменивший значение настройки; | ||
+ | ** предыдущее значение настройки; | ||
+ | ** текущее значение настройки.<br /> | ||
Пример: | Пример: | ||
<pre> | <pre> | ||
Строка 295: | Строка 342: | ||
) | ) | ||
</pre> | </pre> | ||
− | + | <!-- | |
− | |||
− | |||
− | |||
− | |||
== Возможные ошибки == | == Возможные ошибки == | ||
=== SOAP ERROR ошибки === | === SOAP ERROR ошибки === | ||
В случае если тело SOAP запроса не соответствует схеме запроса, то в сообщении лога можно будет увидеть <pre>Ошибка "SoapFault exception: [WSDL] SOAP-ERROR: Parsing WSDL: Couldn't load from '%адрес_схемы%' : faile"</pre> | В случае если тело SOAP запроса не соответствует схеме запроса, то в сообщении лога можно будет увидеть <pre>Ошибка "SoapFault exception: [WSDL] SOAP-ERROR: Parsing WSDL: Couldn't load from '%адрес_схемы%' : faile"</pre> | ||
+ | |||
+ | --> | ||
+ | |||
+ | == Ошибки возникающие при оплате == | ||
+ | * '''Блокировка "Оплата запрещена для данного заказа"''' - эту ошибку можно встретить в Админ-панели Nemo в логах когда заказ еще не забронирован и пользователь попытался оплатить; либо когда заказ забронирован, но нет в доступных действиях по заказу операции выписки; либо когда заказ выписан и нет доп.услуг для довыписки. При попытке оплаты система осуществляет эти проверки и блокирует оплату в указанных случаях. | ||
== См. также == | == См. также == |
Текущая версия на 14:18, 29 июля 2020
Логи системы — модуль Nemo.Travel для учета действий и событий, происходящих в системе.
Содержание
Назначение
nemo.travel поддерживает гибкий инструмент логирования всех важных операций, происходящих в ней. Это помогает в кратчайшие сроки узнать детальную информацию практически по любому действию внутри системы. Интерфейс предоставляет широчайший выбор фильтров для выбора необходимых данных. Кроме того, имеется ряд предустановленных фильтров, которые выделены в отдельный блок и доступны по ссылкам.
Принцип работы
Логи в зависимости от типа бывают:
- индексируемые — ошибки, предупреждения и пр. Эти логи можно искать через фильтры логов.
- не индексируемые — сообщение и пр., доступны в теле одного лога-действия при открытии.
Если после отработанного скрипта не было собрано ни одного лога с индексацией, логи не сохраняются.
Принципы:
- индексировать только действительно полезные логи (выбирать тип события правильно).
- минимизировать объем данных, помещаемый в логи (например, не сохранять объект брони целиком).
Для поиска и просмотра логов зайдите в раздел Для техподдержки → Логи.
Раздел логов состоит из 3 основных частей:
- Форма фильтров.
- Блок предустановленных фильтров.
- Таблица логов.
Записи логов разбиты постранично, чтобы перейти к следующей странице, нажмите ссылку След. внизу таблицы.
Страница логов |
Успешность действия — это признак одного Немо Тревел 1.0 запроса, например, для поиска — это получение хотя бы одного результата, для бронирования — успешная бронь и т.п.
Таблица логов
- Столбцы таблицы — параметры логов,
- Строки таблицы — записи действий.
Одна запись лога называется действием (по сути эквивалент одного php-скрипта). Действие содержит множество операций.
Каждая запись в таблице — действие. Чтобы открыть его операции, разверните запись, нажав на нее.
Некоторые операции сопровождаются ссылкой Данные, открывающей дополнительную информацию о событии (операции): тело XML-запроса, набор параметров или полное сообщение (если краткое обрезалось по длине) и т.п.
На каждое действие (лог) присутствует ссылка. Дополнительно могут быть ссылки Выгрузить архивом xml логи, Просмотр заказа, Просмотр результатов поиска, Форма поиска и др.
Зеленым цветом выделены логи, в которых происходило взаимодействие с ГРС.
Внимание! Логи поисковых запросов записываются в отдельную таблицу.
Параметры таблицы логов
- Запуск — время запуска действия.
- Пользователь — пользователь, запустивший действие.
- Компонент — компонент системы, к которому относится данное действие.
- Действие — наименование действия.
- Сообщение — короткое идентификационное сообщение, используется для поиска логов.
- Заказ — номер заказа.
- Поиск — номер поиска.
- Биллинг — номер транзакции по оплате.
- Поставщик — наименование задействованного поставщика услуг.
- Время выполнения — численное значение (в секундах).
- IP — адрес хоста, инициировавшего действие.
- доп. — дополнительная информация, например:
- статус действия (Успешно/Неуспешно);
- количество ошибок, если они произошли;
- режим работы системы, в котором было выполнено действие).
Фильтры логов
Для поиска логов используют фильтры. По умолчанию форма фильтров отображается на странице в свернутом виде, в котором доступны наиболее используемые параметры фильтрации:
- Пользователь — идентификатор пользователя,
- Заказ — идентификатор заказа,
- Сообщение — короткое идентификационное сообщение для поиска логов,
- Событие — перечень регистрируемых системой событий.
Чтобы получить доступ ко всем параметрам фильтра, нажмите кнопку Дополнительные фильтры (см. раздел Дополнительные фильтры).
Дополнительные фильтры
Полная форма фильтров включает в себя следующие поля:
Название | Описание |
---|---|
Пользователь | Идентификатор пользователя. |
Заказ | Идентификатор заказа |
Сообщение | Короткое идентификационное сообщение для поиска логов. |
Событие |
Перечень регистрируемых системой событий:
|
Действие | Выберите тип действия:
|
Поиск | |
Биллинг | |
Поставщик | |
Платежный шлюз | |
Объект-пользователь | |
Объект | |
ID действия | |
IP | |
Дата | |
За последние X секунд | |
С запросами к GDS | |
Тестовый режим | |
Успешность |
|
Предустановленные фильтры
Для быстроты поиска создан блок ссылок с предустановленными фильтрами:
- Мои логи (текущего пользователя).
- Мои логи (по IP).
- Проблемные выписки.
- Частичные выписки.
- Проблемные бронирования.
- Проблемные аннуляции.
Поиск записей логов
Поиск логов
Чтобы применить фильтрацию к логам:
- Выставите значения фильтров.
- Нажмите на кнопку Поиск.
Чтобы отменить фильтр, нажмите на кнопку Сброс.
Поиск логов по e-mail нотификациям указанного пользователя. |
Поиск логов поисковых запросов
Логи поисковых запросов записываются в отдельную таблицу.
Чтобы искать поисковые логи:
- Нажмите на кнопку Таблица логов поисковых запросов.
- Выставите значения фильтров.
- Нажмите на кнопку Поиск.
Чтобы отменить фильтр, нажмите на кнопку Сброс.
Ссылка на таблицу логов поисковых запросов |
Пример поиска логов поисковых запросов |
Поиск восстановленных логов
После перехода по ссылке Поиск восстановленных логов, поиск будет вестись в специальном хранилище логов, которые по какой-либо причине были утрачены, а затем восстановлены.
Примеры поиска логов
- По номеру заказа:
- введите номер заказа в поле Заказ,
- нажмите кнопку Поиск.
Поиск логов по номеру заказа |
- По ошибке — если искомые заказы содержат известную ошибку:
- введите текст ошибки в поле Сообщение.
- нажмите кнопку Поиск.
Поиск логов с ошибкой среди заказов указанного пользователя.png |
Логирование XML-данных
Модуль осуществляет логирование:
- пакетной выгрузки заказов из ЛК в форматах Nemo/SOFI,
- выгрузки статистики метапоиска,
- экспорта пользователей.
Для первых двух выгрузок, одиночных выгрузок заказов и обращений к GDS доступно скачивание каждого лога отдельно.
Если в содержимом события находится не только XML, то из всего содержимого вычленяется и выводится только XML (например, выгрузка Немо/Софи).
Для того, чтобы браузер не подвисал из-за большого объема лога события (более 64000 символов), на главной странице логов (settings/logs) вместо содержимого выводится соответствующее сообщение. XML можно просмотреть в отдельном окне через специальный плагин.
Примеры логирования
В Nemo.Travel логируются следующие действия:
- изменение настроек в панели администрирования,
- действие с заказом (в т.ч. нотификации, выгрузки, оплаты, фиксации статусов и т.д.),
- поиск,
- авторизация / регистрация на сайте,
- действие в ЛК (экспорт заказов, отправка сообщений/заявок и т.д.).
Особенности логирования действий в Nemo.Travel
- Реквизиты подключения к ГРС:
- При изменении реквизитов подключения к ГРС эти изменения и состояние настроек до них логируются.
- При удалении реквизитов логируется id самих удаляемых реквизитов и какие данные содержались в этом id.
- Логирование изменения значения настройки — изменение настроек также логируется:
- дата и время изменения значения настройки;
- полное название настройки;
- пользователь, изменивший значение настройки;
- предыдущее значение настройки;
- текущее значение настройки.
Пример:
2014-10-06 15:33:41.915 [Пользователи] Изменение "user.param.time_zone" (Данные) Array ( [oldValue] => Pacific/Fakaofo [newValue] => Indian/Antananarivo )
Ошибки возникающие при оплате
- Блокировка "Оплата запрещена для данного заказа" - эту ошибку можно встретить в Админ-панели Nemo в логах когда заказ еще не забронирован и пользователь попытался оплатить; либо когда заказ забронирован, но нет в доступных действиях по заказу операции выписки; либо когда заказ выписан и нет доп.услуг для довыписки. При попытке оплаты система осуществляет эти проверки и блокирует оплату в указанных случаях.