Выгрузка логов при нестабильном интернете: различия между версиями

Материал из SmartPlayer
Новая страница: «== '''Описание ситуации''' == Развитие платформы SmartPlayer добавляет новый полезный функционал. Ранее при потери соединения во время загрузки логов задача создаваемая в личном кабинете SmartPlayer становилась бесконечной и не пропадала из журнала, тем самым посте...»
 
Нет описания правки
 
(не показано 13 промежуточных версий этого же участника)
Строка 1: Строка 1:
<languages/>
<translate>
<!--T:1-->
== '''Описание ситуации''' ==
== '''Описание ситуации''' ==
Развитие платформы SmartPlayer добавляет новый полезный функционал. Ранее при потери соединения во время загрузки логов задача создаваемая в личном кабинете SmartPlayer становилась бесконечной и не пропадала из журнала, тем самым постепенно нагружала серверное приложение. Теперь же реализация изменилась и пользователь в журнале событий может отменить, удалить и успешно завершить задачу после появления соединения. Ниже будет подробнее описано как работает новая реализация.
Ранее при потере соединения во время загрузки логов задача, создаваемая в личном кабинете SmartPlayer становилась бесконечной и не пропадала из журнала, тем самым создавала дополнительную нагрузку на серверное приложение. Теперь же выгрузка логов работает даже пре нестабильном интернете. Текущая страница описывает сценарий выгрузки устройства через раздел «Выгрузка логов», но выгрузка при нестабильной сети работает и в случае прямой выгрузки логов с устройства.{{:DebugSmartPlayer}}
== '''Алгоритм действия''' ==
== '''Алгоритм действия''' ==
Первоначально пользователю необходимо зарегистрироваться/авторизоваться в личном кабинете SmartPlayer.<br>
Первоначально пользователю необходимо зарегистрироваться/авторизоваться в личном кабинете SmartPlayer.<br>
Следующим шагом пользователю необходимо перейти в раздел «Устройства» личного кабинета и выбрать нужное устройство.
Следующим шагом пользователю необходимо перейти в раздел «Устройства» личного кабинета и выбрать нужное устройство.
[[File:Уведомление2.jpg|thumb|center| Пример отображения раздела «Устройства» и выбранного устройства в личном кабинете SmartPlayer|800px]]
[[File:Уведомление2.jpg|thumb|center| Пример отображения раздела «Устройства» и выбранного устройства в личном кабинете SmartPlayer|800px]]
Cледующим шагом справа от устройства откроется панель управления им. В этой панели пользователю необходимо нажать на строку «Выгрузить логи».
Cледующим шагом справа от устройства откроется панель управления устройством. В этой панели пользователю необходимо нажать на строку «Выгрузить логи».
[[File:Пункт_выгрузки_логов.jpg|thumb|center| Пример отображения строки «Выгрузить логи» в личном кабинете SmartPlayer|800px]]
[[File:Пункт_выгрузки_логов.jpg|thumb|center| Пример отображения строки «Выгрузить логи» в личном кабинете SmartPlayer|800px]]
[https://wiki.smartplayer.org/index.php/DebugSmartPlayer#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D0%B6%D1%83%D1%80%D0%BD%D0%B0%D0%BB%D0%B0_%D1%81_%D1%83%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0_(%D0%BB%D0%BE%D0%B3%D0%B8) здесь].
[[File:Выгрузка_логов_альтернатива.png|thumb|center| Пример отображения альтернативного варианта выгрузки логов|800px]]|warn}}
Кликнув на строку пользователю откроется модальное окно с выгрузкой логов. В этом окне необходимо выбрать тип выгружаемых логов:
Кликнув на строку пользователю откроется модальное окно с выгрузкой логов. В этом окне необходимо выбрать тип выгружаемых логов:
* актуальные — только за текущую рабочую сессию устройства (логи которые фиксировались после последнего перезапуска устройства);
* актуальные — только за текущую рабочую сессию устройства (логи, которые фиксировались после последнего перезапуска устройства);
* полные — логи за всё время работы устройства.
* полные — логи за всё время работы устройства.
[[File:Окно_выгрузки.jpg|thumb|center| Пример отображения модального окна с выбором типа логов для выгрузки |800px]]
[[File:Окно_выгрузки.jpg|thumb|center| Пример отображения модального окна с выбором типа логов для выгрузки |800px]]
Строка 16: Строка 21:
В этом уведомлении присутствует кнопка «Перейти» по которой можно кликнуть и перейти в раздел «Устройства» и категорию «Журнал устройств».
В этом уведомлении присутствует кнопка «Перейти» по которой можно кликнуть и перейти в раздел «Устройства» и категорию «Журнал устройств».
[[File:Уведомление_кроп.jpg|thumb|center| Пример отображения кнопки «Перейти» в уведомлении о выгрузке логов|800px]]
[[File:Уведомление_кроп.jpg|thumb|center| Пример отображения кнопки «Перейти» в уведомлении о выгрузке логов|800px]]
{{Note| Все выгруженные логи также можно просмотреть в разделе «Устройства» в категории «Журнал устройств».
[[File:Раздел_в_боковом_меню.jpg|thumb|center| Пример отображения расположение категории «Журнал устройств» в личном кабинете|800px]]|warn}}
== '''Просмотр журнала устройств''' ==
== '''Просмотр журнала устройств''' ==
После перехода в категорию «Журнал устройств» пользователь может ознакомиться со всеми выгруженными логами с устройств.
После перехода в категорию «Журнал устройств» пользователь может ознакомиться со всеми выгруженными логами с устройств.
Строка 23: Строка 26:
В категории «Журнал устройств» пользователь увидит список задач по логам.
В категории «Журнал устройств» пользователь увидит список задач по логам.
[[File:Статусы_задач.jpg|thumb|center| Пример отображения категории «Журнал устройств» со списком задач|800px]]
[[File:Статусы_задач.jpg|thumb|center| Пример отображения категории «Журнал устройств» со списком задач|800px]]
{{Note|Если в категории «Журнал устройств» нет задач (выгруженных логов), то страница выглядит так:
{{Note|Если в категории «Журнал устройств» нет задач (выгруженных логов), страница выглядит так:
[[File:Раздел_без_задач.jpg|thumb|center| Пример отображения пустой главной страницы категории «Журнал устройств»|800px]]|warn}}
[[File:Раздел_без_задач.jpg|thumb|center| Пример отображения пустой главной страницы категории «Журнал устройств»|800px]]|warn}}
== '''Статусы выгруженных задач (логов)''' ==
== '''Статусы выгруженных задач (логов)''' ==
Все выгруженные задачи можно разделить на следующие группы:
Все выгруженные задачи можно разделить на следующие группы:
# В процессе — задача (лог), который находится в процессе формирования. Обозначается прозрачным кругом и имеет в столбце «Прогресс» указание в процентах.
# В процессе — задача (лог), который находится в процессе формирования. Обозначается пустым кругом и в столбце «Прогресс» указано соответствующее значение.
# Отменен — задача (лог), который был отменен в процессе загрузки. Обозначается жёлтым кругом и имеет в столбце «Прогресс» одноименный статус.
# Отменен — задача (лог), который был отменен в процессе загрузки. Обозначается жёлтым кругом и имеет в столбце «Прогресс» одноименный статус.
# Загружен — задача (лог), который был полностью сформирован на серверном приложении и загружен в личный кабинет. Обозначается зелёным кругом и имеет в столбце «Прогресс» одноименный статус.
# Загружен — задача (лог), который был полностью сформирован на серверном приложении и загружен в личный кабинет. Обозначается зелёным кругом и имеет в столбце «Прогресс» одноименный статус.
Строка 34: Строка 37:
[[File:Отмена_задачи_в_прогрессе.jpg|thumb|center| Пример отображения строки «Отменить выгрузку»|800px]]|warn}}
[[File:Отмена_задачи_в_прогрессе.jpg|thumb|center| Пример отображения строки «Отменить выгрузку»|800px]]|warn}}
== '''Выполненные задачи''' ==
== '''Выполненные задачи''' ==
После формирования задачи (логов) пользователь может проделать с ними следующие действия:
После формирования задачи (логов) пользователь может проделать следующие действия:
# Скачать.
# Скачать.
# Удалить.
# Удалить.
[[File:Скачивание_готовых_логов.jpg|thumb|center| Пример отображения кнопок «Скачать» и «Удалить» для выгруженных задач (логов)|800px]]
[[File:Скачивание_готовых_логов.jpg|thumb|center| Пример отображения кнопок «Скачать» и «Удалить» для выгруженных задач (логов)|800px]]
{{Note|Архивы задачи с логами хранится сутки. После этого он автоматически удаляется.|warn}}
== '''Массовый выбор задач''' ==
== '''Массовый выбор задач''' ==
Пользователь может выбрать сразу несколько задач (логов) выделив их с помощью чекбоксов (галочек). Все выделенные устройства отобразятся в правой верхней части экрана и откроется панель управления для выделенных задач.
Пользователь может выбрать сразу несколько задач (логов) выделив их с помощью чекбоксов (галочек). Все выделенные устройства отобразятся в правой верхней части экрана и откроется панель управления для выделенных задач.
[[File:Массовый_выбор_задач.jpg|thumb|center| Пример отображения выделенных задач (логов)|800px]]
[[File:Массовый_выбор_задач.jpg|thumb|center| Пример отображения выделенных задач (логов)|800px]]
Выделив нужные задачи (логи) пользователь может проделать следующие действия:
Выделив нужные задачи (логи), пользователь может проделать следующие действия:
# Выгрузить — нажать на кнопку загрузить с соответствующей иконкой (стрелка направленная вниз).
# Выгрузить — нажать на кнопку загрузить с соответствующей иконкой (стрелка, направленная вниз).
# Удалить — нажать на кнопку, которая удалит выделенные задачи (иконка в виде мусорной корзины).
# Удалить — нажать на кнопку, которая удалит выделенные задачи (иконка в виде мусорной корзины).
# Отменить выбор — кнопка, которая позволяет снять выделение со всех логов (задач).
# Отменить выбор — кнопка, которая позволяет снять выделение со всех логов (задач).
[[File:Удаление_выбранных_задач.jpg|thumb|center| Пример отображения кнопок для взаимодействия с выделенными устрйоствами|800px]]
[[File:Удаление_выбранных_задач.jpg|thumb|center| Пример отображения кнопок для взаимодействия с выделенными устройствами|800px]]
== '''Дополнительная информация''' ==
== '''Дополнительная информация''' ==
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы. Данные вопросы можно озвучить в разделе "Обсуждения" вверху страницы.
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.
[[File:Обсуждение_статусов.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
[[File:Обсуждение_выгрузки.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
</translate>

Текущая версия от 11:01, 8 октября 2025

Описание ситуации

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

Получение журнала с устройства (логи)

Каждое клиентское приложение пишет журнал событий в свою внутреннею память устройства, при необходимости его можно получить и отправить для анализа в техническую поддержку SmartPLayer, чтобы получить максимально полезные логи сделайте следующие действия:

  1. В настройках устройства (Выбрать устройство -> В правом тулбаре Настройки), когда оно в онлайн статусе (зеленое) включите режим логирования Debug или Trace. Этим вы настроите устройство, чтобы оно писала более детальные сообщения по своей работе
  2. Постарайтесь воспроизвести нештатную ситуацию на устройстве
  3. Перейдите в карточку устройства (Выбрать устройство -> В правом тулбаре Информация) и выгрузите архив с журналом.


Существует два параметра:

  • актуальные - выгрузится архив с журналом событий за текущий день, как следствие меньшего размера. Если сеть нестабильная, лучший выбор.
  • полные - выгрузится архив с журналом событий за несколько дней. Может передавать большой объём данных, сеть должна быть стабильнее.

Алгоритм действия

Первоначально пользователю необходимо зарегистрироваться/авторизоваться в личном кабинете SmartPlayer.
Следующим шагом пользователю необходимо перейти в раздел «Устройства» личного кабинета и выбрать нужное устройство.

Пример отображения раздела «Устройства» и выбранного устройства в личном кабинете SmartPlayer

Cледующим шагом справа от устройства откроется панель управления устройством. В этой панели пользователю необходимо нажать на строку «Выгрузить логи».

Пример отображения строки «Выгрузить логи» в личном кабинете SmartPlayer

здесь.

Пример отображения альтернативного варианта выгрузки логов

|warn}}

Кликнув на строку пользователю откроется модальное окно с выгрузкой логов. В этом окне необходимо выбрать тип выгружаемых логов:

  • актуальные — только за текущую рабочую сессию устройства (логи, которые фиксировались после последнего перезапуска устройства);
  • полные — логи за всё время работы устройства.
Пример отображения модального окна с выбором типа логов для выгрузки

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

Пример отображения уведомления о выгрузке логов

В этом уведомлении присутствует кнопка «Перейти» по которой можно кликнуть и перейти в раздел «Устройства» и категорию «Журнал устройств».

Пример отображения кнопки «Перейти» в уведомлении о выгрузке логов

Просмотр журнала устройств

После перехода в категорию «Журнал устройств» пользователь может ознакомиться со всеми выгруженными логами с устройств.

Пример отображения расположение категории «Журнал устройств» в личном кабинете

В категории «Журнал устройств» пользователь увидит список задач по логам.

Пример отображения категории «Журнал устройств» со списком задач
Если в категории «Журнал устройств» нет задач (выгруженных логов), страница выглядит так:
Пример отображения пустой главной страницы категории «Журнал устройств»

Статусы выгруженных задач (логов)

Все выгруженные задачи можно разделить на следующие группы:

  1. В процессе — задача (лог), который находится в процессе формирования. Обозначается пустым кругом и в столбце «Прогресс» указано соответствующее значение.
  2. Отменен — задача (лог), который был отменен в процессе загрузки. Обозначается жёлтым кругом и имеет в столбце «Прогресс» одноименный статус.
  3. Загружен — задача (лог), который был полностью сформирован на серверном приложении и загружен в личный кабинет. Обозначается зелёным кругом и имеет в столбце «Прогресс» одноименный статус.
Пример отображения статуса задач (логов)
В процессе формирования задачи (лога) пользователь может отменить его нажав на строку «Отменить выгрузку».
Пример отображения строки «Отменить выгрузку»

Выполненные задачи

После формирования задачи (логов) пользователь может проделать следующие действия:

  1. Скачать.
  2. Удалить.
Пример отображения кнопок «Скачать» и «Удалить» для выгруженных задач (логов)
Архивы задачи с логами хранится сутки. После этого он автоматически удаляется.

Массовый выбор задач

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

Пример отображения выделенных задач (логов)

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

  1. Выгрузить — нажать на кнопку загрузить с соответствующей иконкой (стрелка, направленная вниз).
  2. Удалить — нажать на кнопку, которая удалит выделенные задачи (иконка в виде мусорной корзины).
  3. Отменить выбор — кнопка, которая позволяет снять выделение со всех логов (задач).
Пример отображения кнопок для взаимодействия с выделенными устройствами

Дополнительная информация

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

Пример отображения вкладки "Обсуждения" на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"