"Детектор" черного экрана (Системный администратор): различия между версиями
Нет описания правки |
T.Tagiev (обсуждение | вклад) |
||
| (не показана 31 промежуточная версия 2 участников) | |||
| Строка 1: | Строка 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
== '''Описание ситуации''' == | == '''Описание ситуации''' == | ||
У пользователей | У пользователей появляются проблемы с трансляциями на устройствах. При воспроизведении контента на некоторых устройствах выводится «чёрный» экран. Эту проблему можно наблюдать в личном кабинете пользователя или на месте нахождения устройства. | ||
</translate> | |||
<translate> | |||
<!--T:2--> | |||
== '''Причина''' == | == '''Причина''' == | ||
В устройствах, работающих на местах во время проигрывания контента, появляется «чёрный экран». При этом трансляция в личном кабинете продолжает работать.<br> | В устройствах, работающих на местах во время проигрывания контента, появляется «чёрный экран». При этом трансляция в личном кабинете продолжает работать, но отображает только "Чёрный" экран.<br> | ||
Эта ситуация | Эта ситуация возникает из-за различных ошибок при запуске трансляции. Причины таких проблем могут быть разными, и их очень сложно обнаружить.<br> | ||
Причины таких проблем могут быть разными, и их очень сложно обнаружить | |||
В качестве причины может выступать любое действие: | В качестве причины может выступать любое действие: | ||
* Пользователь загружает видео, но это видео использует неподдерживаемый системой кодек. Тогда видео просто не может запуститься и показывает черный экран. | * Пользователь загружает видео, но это видео использует неподдерживаемый системой кодек. Тогда видео просто не может запуститься и показывает черный экран. Бывает проблемы, связанные с клиентским приложением (баг), и из-за этого начинаются проблемы с трансляцией. | ||
Бывает проблемы, связанные с клиентским приложением (баг), и из-за этого начинаются проблемы с трансляцией. | |||
* Пока есть наличие постоянной, стабильной сети – все работает отлично. Как только устройство теряет доступ к сети (по любой причине) – трансляция прерывается и появляется чёрный экран. | * Пока есть наличие постоянной, стабильной сети – все работает отлично. Как только устройство теряет доступ к сети (по любой причине) – трансляция прерывается и появляется чёрный экран. | ||
[[File:.png|thumb| | [[File:Пример черного экрана в ЛК.png|thumb|Пример отображения "Чёрного" экрана в личном кабинете пользователя|500px]] | ||
=== '''Систематичность проблемы''' === | === '''Систематичность проблемы''' === | ||
"Чёрный" экран очень | "Чёрный" экран очень несложно отследить и подтвердить визуально. В этом случае хорошо помогает личный кабинет.<br> | ||
Период черного экрана определяется и подтверждает по факту у точки. | Проблема ситуации в том, что проблема не несет в себе систематичности по времени и может появляться как раз в месяц, так и раз в несколько дней или часов.<br> | ||
Период появления черного экрана определяется опытным путём и подтверждает по факту у точки. Поиск причины проблемы перекладывается на плечи технических специалистов. | |||
</translate> | |||
<translate> | |||
== '''Концепт решения''' == | == '''Концепт решения''' == | ||
Для решения проблемы было решено создать автоматический «Детектор» черного экрана. Он уведомляет о проблемах с контентом на устройстве и оповещает о случившейся ситуации в личном кабинете.<br> | |||
{{Note|Данный функционал не доступен пользователю в личном кабинете. Его необходимо включать отдельно.|warn}} | {{Note|Данный функционал не доступен пользователю в личном кабинете. Его необходимо включать отдельно.|warn}} | ||
=== '''Принцип действия''' === | |||
У каждого клиента/компании есть свой ID связанный с сервером. | У каждого клиента/компании есть свой ID связанный с сервером. ID указан в личном кабинете и к нему привязываются все устройства компании.<br> | ||
Запуская «ивент» устройство с помощью детектора проверяет наличие | После запуска функционала сервер с определенным промежутком по времени отправляет на устройства «ивент».<br> | ||
После запуска детектора возможно получить два | Запуская «ивент» устройство с помощью детектора проверяет наличие "черного" экрана, делая скриншот во время запуска.<br> | ||
После запуска детектора возможно получить два определенных результата: | |||
* После запуска «ивента» черного экрана нет - система продолжает работу в штатном режиме. | * После запуска «ивента» черного экрана нет - система продолжает работу в штатном режиме. | ||
* После запуска «ивента» чёрный экран обнаружен - сервер отправляет повторный, проверочный "ивент".<br> | * После запуска «ивента» чёрный экран обнаружен - сервер отправляет повторный, проверочный "ивент".<br> | ||
'''Промежуток для повторной отправки "ивента" по умолчанию составляет 10 секунд.'''<br> | |||
Если же и во второй раз отправляется | Если же и во второй раз отправляется скриншот "чёрного" экрана то со стороны сервера отправляется письмо на почту, о наличии проблемы. | ||
{{Note|Указанная почта должна быть привязана к серверу.|warn}} | {{Note|Указанная почта должна быть привязана к серверу.|warn}} | ||
=== '''Подготовка ''' === | |||
Системный администратор должен настроить серверное приложение по двум параметрам: | |||
* Запуск и функционирование детектора "чёрного" экрана | |||
* Настройка отправки письма с ошибкой на почту | |||
=== '''Принцип действия ''' === | |||
Если серверное приложение обнаружило черный экран, оно отправляет на почту письмо. | |||
Итогом этой проверки станет сообщение на почту с оповещение о проблеме. <br> | |||
Для подтверждения проверки работоспособности функционала через личный кабинет системный администратор может поставить черную картинку. Сервер продолжает отправляет оповещения пока проблема не будет исправлена или же пока не будет выключен функционал.<br> | |||
Впоследствии системный администратор должен принять меры для устранения проблемы. | |||
=== '''Тонкости и нюансы при работе функционала''' === | === '''Тонкости и нюансы при работе функционала''' === | ||
1. Для правильного работы необходимо чтобы placeholder с белой точкой воспринимался как черный экран. Поэтому используется не абсолютная проверка. | 1. Для правильного работы необходимо чтобы placeholder с белой точкой воспринимался как черный экран. Поэтому используется не абсолютная проверка.<br> | ||
2. | 2. При наличии root прав на устройстве – детектор работает нормально. Но, если, на устройстве нет root прав, детектор не сможет сделать скриншот.<br> | ||
'''Исключения:''' | '''Исключения:'''<br> | ||
Скриншот доступен: | Скриншот доступен: | ||
* Если приложение подписано «подписью разработчика» (уровень прав – Signage) | * Если приложение подписано «подписью разработчика» (уровень прав – Signage). | ||
* Некоторые устройства (Vestel, Hikvision, Phillips) могут сделать скриншот без root прав из-за особенностей прошивки. | * Некоторые устройства (Vestel, Hikvision, Phillips) могут сделать скриншот без root прав из-за особенностей прошивки. | ||
3. Если пользователь попробует сделать скриншот без root прав, то создается «пустой скриншот» с надписью «Идёт воспроизведение видео. Отсутствуют права для снятия скриншота».<br> | 3. Если пользователь попробует сделать скриншот без root прав, то создается «пустой скриншот» с надписью «Идёт воспроизведение видео. Отсутствуют права для снятия скриншота».<br> | ||
4. Информация от сервера к разработчикам отправляется через ивент. Внутри отправленного «ивента» сервер ждет callback от разработчиков.<br> | 4. Информация от сервера к разработчикам отправляется через "ивент". Внутри отправленного «ивента» сервер ждет callback от разработчиков.<br> | ||
5. Тайм – аут “Callback” на сервере составляет – 30 секунд. | 5. Тайм – аут “Callback” по умолчанию на сервере составляет – 30 секунд. | ||
</translate> | |||
<translate> | |||
== '''Реализация''' == | |||
=== '''Активация''' === | |||
По умолчанию детектор для всех компаний отключен на сервере, так как создает на него слишком большую нагрузку. | |||
{{Note|Включается детектор только по запросу со стороны компании, у которой появилась проблема с чёрным экраном.|warn}} | |||
=== '''Алгоритм действия''' === | |||
Вся работа будет вестись в два этапа.<br> | |||
'''Первый этап - это запуск самого детектора'''.<br> | |||
При запуске детектора нужно использовать id компании, который указан в личном кабинете. [[File:ID компании.png|thumb|Расположение ID компании в личном кабинете |300px]] | |||
Для этого нужно зайти в профиль и развернуть подробную информацию о пользователе. | |||
Системному администратору нужно подключиться на сервер, через '''Command Line Interface (CLI)'''.<br> | |||
<div style="border: 1px solid #888; padding: 10px; margin: 10px 0; background-color: #f9f9f9;"> | |||
При включении CLI сервер получает определенные данные для настройки:<br> | |||
Это: | |||
* ID компании, для которой включаем детектор | |||
* Можно передать платформу (или несколько платформ), для которой необходимо запустить мониторинг. | |||
Например: передаем параметр "ANDROID" и мониторинг включается только для устройств "ANDROID". | |||
* E-mail адрес или несколько адресов на которые должно отправляться уведомление о нештатной ситуации | |||
* Указанное время хранения скриншотов (по умолчанию 3 дня) | |||
</div> | |||
Далее нужно перейти в серверное приложение и выполнить команду: | |||
<code>docker exec -it smartplayer_backend_1 bash</code> | |||
[[File:Команда docker.png|thumb|Команда"docker exec -it smartplayer_backend_1 bash" |300px]] | |||
На этом этапе попадаем в нашем контейнере с серверным приложением.<br> | |||
Следующей выполняем команду: | |||
<code>./cli.js company enable-screen-monitor </code>[[File:Enable screen monitor.png|thumb|Команда"./cli.js company enable-screen-monitor" |300px]] | |||
После очередного этапа система выдает вот такую строку: | |||
Системное сообщение: <code>Input company ID and press Enter</code>[[File:Системное сообщение.png|thumb|Системное сообщение "Input company ID and press Enter:" |300px]] | |||
Выполненная команда отобразит строку в которой просят ввести Id компании.<br> | |||
После ввода ID появляется запрос на мониторинг всех платформ компании. В данном случае выбираем «ДА/Y» | |||
[[File:Мониторинг всех платформ.png|thumb|Здесь нужно запустить мониторинг платформ нажав "ДА/Y" |300px]] | |||
В последствии консоль потребует указать e-mail на который будут приходить оповещения о проблемах. | |||
Это делается в строке:<br> | |||
<code>Input_email and press enter</code> | |||
[[File:Строка почты.png|thumb|Команда"Input_email_and_press_Enter:" |300px]] | |||
{{Note|Указанная почта должна быть привязана к серверу.|warn}} | |||
Также можно указать интервал с которым будут приходить скриншоты (например 1 минута). Строка выглядит так:<br> | |||
<code>Input check interval in minutes (m) or seconds (s) and press "Enter"</code><br> | |||
[[File:Интервал отправки сообщения.png|thumb|Здесь нужно указать время в минутах с префиксом (m) или в секундах с префиксом (S) |300px]] | |||
Далее указываем время либо в секундах с префиксом (s) после числового значения, либо в минутах с префиксом (m) и применяем эту настройку через "Enter". Итогом всех манипуляций будет статус:<br> | |||
<code>Company screen monitoring enabled</code> - выделена зеленым цветом. Это значит что детектор черного экрана запущен. | |||
[[File:Запуск детектора.png|thumb|Оповещение о запуске Детектора выделено зелёным цветом |300px]] | |||
Проверить настроенные уведомления можно с помощью команды <code>./cli.js company show-screen-monitor</code> | |||
'''Отключить детектор черных экранов:''' <code>./cli.js company disable-screen-monitor</code> | |||
=== '''Уведомления на почту''' === | |||
Второй этап настройка уведомления, которые приходят на почту. Настройка уведомления подробно прописана в отдельной инструкции [[Настройка отправки писем через серверное приложение SmartPlayer]].<br> | |||
{{Note|При получении сообщения о проблеме на почту, невозможно напрямую из этого уведомления сделать какие либо действия. К примеру «Перезагрузка экрана» или "Остановка трансляции" недоступна.|warn}} | |||
=== '''Предфинальные действия''' === | |||
В зависимости от результата, системный администратор сможет корректно определить причину и предпринять конкретные действия для устранения ситуации. Если у него не получается решить проблему внутри своей среды или же проблема на нашей стороне, он должен обратиться к команде SmartPlayer.<br> | |||
Это вариант удобен для всех. Так как поможет решить проблемы если они и с нашей стороны (например баг приложения), так и со стороны пользователя (например пользователь неправильно создал трансляцию). | |||
=== '''Важная информация о которой не стоит забывать ''' === | |||
{{Note|'''Для перезапуска трансляции надо зайти в личный кабинет и перезапустить все вручную'''|warn}} | |||
{{Note|'''Детектор черного экрана на данный момент работает только на Android версии 1.63.1'''|warn}} | |||
</translate> | |||
<translate> | |||
<!--T:5--> | |||
== '''Итоговый результат''' == | |||
Системный администратор со стороны клиента начнёт решать проблему запустив и настроив функционал детектора. | |||
Наличие детектора позволяет контролировать проблемную ситуацию с "Чёрным" экраном и оперативно работать с её исправлением. Это актуально как для нас, так и для системных администраторов со стороны пользователя. | |||
Команда SmartPlayer и команда сотрудников со стороны клиента смогут оперативно взаимодействовать для решения проблемы. <br> | |||
Рядовой пользователь минимизирует негативный опыт взаимодействия с нашим продуктом. | |||
</translate> | |||
Текущая версия от 15:08, 26 сентября 2023
Описание ситуации
У пользователей появляются проблемы с трансляциями на устройствах. При воспроизведении контента на некоторых устройствах выводится «чёрный» экран. Эту проблему можно наблюдать в личном кабинете пользователя или на месте нахождения устройства.
Причина
В устройствах, работающих на местах во время проигрывания контента, появляется «чёрный экран». При этом трансляция в личном кабинете продолжает работать, но отображает только "Чёрный" экран.
Эта ситуация возникает из-за различных ошибок при запуске трансляции. Причины таких проблем могут быть разными, и их очень сложно обнаружить.
В качестве причины может выступать любое действие:
- Пользователь загружает видео, но это видео использует неподдерживаемый системой кодек. Тогда видео просто не может запуститься и показывает черный экран. Бывает проблемы, связанные с клиентским приложением (баг), и из-за этого начинаются проблемы с трансляцией.
- Пока есть наличие постоянной, стабильной сети – все работает отлично. Как только устройство теряет доступ к сети (по любой причине) – трансляция прерывается и появляется чёрный экран.
Систематичность проблемы
"Чёрный" экран очень несложно отследить и подтвердить визуально. В этом случае хорошо помогает личный кабинет.
Проблема ситуации в том, что проблема не несет в себе систематичности по времени и может появляться как раз в месяц, так и раз в несколько дней или часов.
Период появления черного экрана определяется опытным путём и подтверждает по факту у точки. Поиск причины проблемы перекладывается на плечи технических специалистов.
Концепт решения
Для решения проблемы было решено создать автоматический «Детектор» черного экрана. Он уведомляет о проблемах с контентом на устройстве и оповещает о случившейся ситуации в личном кабинете.
Принцип действия
У каждого клиента/компании есть свой ID связанный с сервером. ID указан в личном кабинете и к нему привязываются все устройства компании.
После запуска функционала сервер с определенным промежутком по времени отправляет на устройства «ивент».
Запуская «ивент» устройство с помощью детектора проверяет наличие "черного" экрана, делая скриншот во время запуска.
После запуска детектора возможно получить два определенных результата:
- После запуска «ивента» черного экрана нет - система продолжает работу в штатном режиме.
- После запуска «ивента» чёрный экран обнаружен - сервер отправляет повторный, проверочный "ивент".
Промежуток для повторной отправки "ивента" по умолчанию составляет 10 секунд.
Если же и во второй раз отправляется скриншот "чёрного" экрана то со стороны сервера отправляется письмо на почту, о наличии проблемы.
Подготовка
Системный администратор должен настроить серверное приложение по двум параметрам:
- Запуск и функционирование детектора "чёрного" экрана
- Настройка отправки письма с ошибкой на почту
Принцип действия
Если серверное приложение обнаружило черный экран, оно отправляет на почту письмо.
Итогом этой проверки станет сообщение на почту с оповещение о проблеме.
Для подтверждения проверки работоспособности функционала через личный кабинет системный администратор может поставить черную картинку. Сервер продолжает отправляет оповещения пока проблема не будет исправлена или же пока не будет выключен функционал.
Впоследствии системный администратор должен принять меры для устранения проблемы.
Тонкости и нюансы при работе функционала
1. Для правильного работы необходимо чтобы placeholder с белой точкой воспринимался как черный экран. Поэтому используется не абсолютная проверка.
2. При наличии root прав на устройстве – детектор работает нормально. Но, если, на устройстве нет root прав, детектор не сможет сделать скриншот.
Исключения:
Скриншот доступен:
- Если приложение подписано «подписью разработчика» (уровень прав – Signage).
- Некоторые устройства (Vestel, Hikvision, Phillips) могут сделать скриншот без root прав из-за особенностей прошивки.
3. Если пользователь попробует сделать скриншот без root прав, то создается «пустой скриншот» с надписью «Идёт воспроизведение видео. Отсутствуют права для снятия скриншота».
4. Информация от сервера к разработчикам отправляется через "ивент". Внутри отправленного «ивента» сервер ждет callback от разработчиков.
5. Тайм – аут “Callback” по умолчанию на сервере составляет – 30 секунд.
Реализация
Активация
По умолчанию детектор для всех компаний отключен на сервере, так как создает на него слишком большую нагрузку.
Алгоритм действия
Вся работа будет вестись в два этапа.
Первый этап - это запуск самого детектора.
При запуске детектора нужно использовать id компании, который указан в личном кабинете.
Для этого нужно зайти в профиль и развернуть подробную информацию о пользователе.
Системному администратору нужно подключиться на сервер, через Command Line Interface (CLI).
При включении CLI сервер получает определенные данные для настройки:
Это:
- ID компании, для которой включаем детектор
- Можно передать платформу (или несколько платформ), для которой необходимо запустить мониторинг.
Например: передаем параметр "ANDROID" и мониторинг включается только для устройств "ANDROID".
- E-mail адрес или несколько адресов на которые должно отправляться уведомление о нештатной ситуации
- Указанное время хранения скриншотов (по умолчанию 3 дня)
Далее нужно перейти в серверное приложение и выполнить команду:
docker exec -it smartplayer_backend_1 bash
На этом этапе попадаем в нашем контейнере с серверным приложением.
Следующей выполняем команду:
./cli.js company enable-screen-monitor
После очередного этапа система выдает вот такую строку:
Системное сообщение: Input company ID and press Enter
Выполненная команда отобразит строку в которой просят ввести Id компании.
После ввода ID появляется запрос на мониторинг всех платформ компании. В данном случае выбираем «ДА/Y»
В последствии консоль потребует указать e-mail на который будут приходить оповещения о проблемах.
Это делается в строке:
Input_email and press enter
Также можно указать интервал с которым будут приходить скриншоты (например 1 минута). Строка выглядит так:
Input check interval in minutes (m) or seconds (s) and press "Enter"
Далее указываем время либо в секундах с префиксом (s) после числового значения, либо в минутах с префиксом (m) и применяем эту настройку через "Enter". Итогом всех манипуляций будет статус:
Company screen monitoring enabled - выделена зеленым цветом. Это значит что детектор черного экрана запущен.
Проверить настроенные уведомления можно с помощью команды ./cli.js company show-screen-monitor
Отключить детектор черных экранов: ./cli.js company disable-screen-monitor
Уведомления на почту
Второй этап настройка уведомления, которые приходят на почту. Настройка уведомления подробно прописана в отдельной инструкции Настройка отправки писем через серверное приложение SmartPlayer.
Предфинальные действия
В зависимости от результата, системный администратор сможет корректно определить причину и предпринять конкретные действия для устранения ситуации. Если у него не получается решить проблему внутри своей среды или же проблема на нашей стороне, он должен обратиться к команде SmartPlayer.
Это вариант удобен для всех. Так как поможет решить проблемы если они и с нашей стороны (например баг приложения), так и со стороны пользователя (например пользователь неправильно создал трансляцию).
Важная информация о которой не стоит забывать
Итоговый результат
Системный администратор со стороны клиента начнёт решать проблему запустив и настроив функционал детектора.
Наличие детектора позволяет контролировать проблемную ситуацию с "Чёрным" экраном и оперативно работать с её исправлением. Это актуально как для нас, так и для системных администраторов со стороны пользователя.
Команда SmartPlayer и команда сотрудников со стороны клиента смогут оперативно взаимодействовать для решения проблемы.
Рядовой пользователь минимизирует негативный опыт взаимодействия с нашим продуктом.
