"Детектор" черного экрана (Системный администратор)/en: различия между версиями

Материал из SmartPlayer
← Предыдущая правка
Новая страница: «== '''Solution Concept''' == To address the issue, it was decided to create an automatic "Black Screen Detector". It notifies of problems with content on the device and alerts about the occurred situation in the personal account.<br> {{Note|This functionality is not available to the user in the personal account and needs to be activated separately.|warn}} === '''Operating Principle''' === Every client/company has its own ID associated with the server. This I...»
Обновление для соответствия новой версии исходной страницы.
 
(не показана 1 промежуточная версия 1 участника)
Строка 1: Строка 1:
<languages/>
<div class="mw-translate-fuzzy">
== '''Situation Description''' ==
== '''Situation Description''' ==
Users are experiencing issues with broadcasts on their devices. When playing content on some devices, a "black" screen appears. This problem can be observed in the user's personal account or at the device's location.
Users are experiencing issues with broadcasts on their devices. When playing content on some devices, a "black" screen appears. This problem can be observed in the user's personal account or at the device's location.
</div>
<div class="mw-translate-fuzzy">
== '''Cause''' ==
== '''Cause''' ==
On devices operating on-site, a "black screen" appears during content playback. Meanwhile, the broadcast in the personal account continues to run but only displays a "black" screen.<br>
On devices operating on-site, a "black screen" appears during content playback. Meanwhile, the broadcast in the personal account continues to run but only displays a "black" screen.<br>
Строка 12: Строка 16:
The challenge with this situation is that it doesn't have a consistent frequency; it can occur once a month, or once every few days or even hours.<br>
The challenge with this situation is that it doesn't have a consistent frequency; it can occur once a month, or once every few days or even hours.<br>
The period when the black screen appears is determined empirically and is confirmed on-site. The responsibility of finding the cause of the problem falls on technical specialists.
The period when the black screen appears is determined empirically and is confirmed on-site. The responsibility of finding the cause of the problem falls on technical specialists.
== '''Solution Concept''' ==
</div>
To address the issue, it was decided to create an automatic "Black Screen Detector". It notifies of problems with content on the device and alerts about the occurred situation in the personal account.<br>
 
{{Note|This functionality is not available to the user in the personal account and needs to be activated separately.|warn}}
<div lang="ru" dir="ltr" class="mw-content-ltr">
=== '''Operating Principle''' ===
== '''Концепт решения''' ==
Every client/company has its own ID associated with the server. This ID is indicated in the personal account, and all the company's devices are linked to it.<br>  
Для решения проблемы было решено создать автоматический «Детектор» черного экрана. Он уведомляет о проблемах с контентом на устройстве и оповещает о случившейся ситуации в личном кабинете.<br>
After activating the functionality, the server sends an "event" to the devices at specific time intervals.<br>
{{Note|Данный функционал не доступен пользователю в личном кабинете. Его необходимо включать отдельно.|warn}}  
When initiating the "event", the device checks for the presence of a "black" screen using the detector, taking a screenshot during the launch.<br>
=== '''Принцип действия''' ===
After launching the detector, two specific results can be obtained:
У каждого клиента/компании есть свой ID связанный с сервером. ID указан в личном кабинете и к нему привязываются все устройства компании.<br>  
* After initiating the "event", no black screen is detected - the system continues to operate in normal mode.
После запуска функционала сервер с определенным промежутком по времени отправляет на устройства «ивент».<br>
* After initiating the "event", a black screen is detected - the server sends a secondary, verification "event".<br>
Запуская «ивент» устройство с помощью детектора проверяет наличие "черного" экрана, делая скриншот во время запуска.<br>
'''The interval for resending the "event" is 10 seconds.'''<br>
После запуска детектора возможно получить два определенных результата:
If a black screen is detected again during the second check, the server sends an email alerting about the issue.
* После запуска «ивента» черного экрана нет - система продолжает работу в штатном режиме.
{{Note|The specified email should be linked to the server.|warn}}
* После запуска «ивента» чёрный экран обнаружен - сервер отправляет повторный, проверочный "ивент".<br>
=== '''Preparation ''' ===
'''Промежуток для повторной отправки "ивента" по умолчанию составляет 10 секунд.'''<br>
The system administrator must configure the server application based on two parameters:
Если же и во второй раз отправляется скриншот "чёрного" экрана то со стороны сервера отправляется письмо на почту, о наличии проблемы.
* Launch and operation of the "black screen" detector
{{Note|Указанная почта должна быть привязана к серверу.|warn}}
* Setting up email alerts for detected errors
</div>
=== '''Operating Principle ''' ===
 
If the server application detects a black screen, it sends an email. The result of this check will be an email notification about the issue.<br>
<div lang="ru" dir="ltr" class="mw-content-ltr">
To confirm the functionality check via the personal account, the system administrator can set a black picture. The server continues to send notifications until the problem is resolved or the functionality is turned off. <br>
=== '''Подготовка ''' ===
Subsequently, the system administrator must take measures to resolve the issue.
Системный администратор должен настроить серверное приложение по двум параметрам:
=== '''Nuances and Subtleties in Functional Operation''' ===
* Запуск и функционирование детектора "чёрного" экрана
1. For correct operation, it is necessary for the placeholder with a white dot to be perceived as a black screen. Therefore, an absolute check is not used.<br>
* Настройка отправки письма с ошибкой на почту
2. '''It's relevant only during video playback. ''' If there are root rights on the device, the detector works fine. However, if there are no root rights on the device, the detector won't be able to take a screenshot.<br>
=== '''Принцип действия ''' ===
'''Exceptions:'''<br>
Если серверное приложение обнаружило черный экран, оно отправляет на почту письмо.
Screenshot is available:
Итогом этой проверки станет сообщение на почту с оповещение о проблеме. <br>
* If the application is signed with the "developer's signature" (rights level – Signage).
Для подтверждения проверки работоспособности функционала через личный кабинет системный администратор может поставить черную картинку. Сервер продолжает отправляет оповещения пока проблема не будет исправлена или же пока не будет выключен функционал.<br>
* Some devices (Vestel, Hikvision, Phillips) can take a screenshot without root rights due to firmware features.
Впоследствии системный администратор должен принять меры для устранения проблемы.
3. If a user tries to take a screenshot without root rights, an "empty screenshot" is created with the inscription "Video is playing. No rights to take a screenshot".<br>
=== '''Тонкости и нюансы при работе функционала''' ===
4. Information from the server to the developers is sent through an "event". Inside the sent "event", the server awaits a callback from the developers.<br>
1. Для правильного работы необходимо чтобы placeholder с белой точкой воспринимался как черный экран. Поэтому используется не абсолютная проверка.<br>
5. The default "Callback" timeout on the server is 30 seconds.
2. При наличии root прав на устройстве – детектор работает нормально. Но, если, на устройстве нет root прав, детектор не сможет сделать скриншот.<br>
'''Исключения:'''<br>
Скриншот доступен:
* Если приложение подписано «подписью разработчика» (уровень прав – Signage).
* Некоторые устройства (Vestel, Hikvision, Phillips) могут сделать скриншот без root прав из-за особенностей прошивки.
3. Если пользователь попробует сделать скриншот без root прав, то создается «пустой скриншот» с надписью «Идёт воспроизведение видео. Отсутствуют права для снятия скриншота».<br>
4. Информация от сервера к разработчикам отправляется через "ивент". Внутри отправленного «ивента» сервер ждет callback от разработчиков.<br>
5. Тайм – аут “Callback” по умолчанию на сервере составляет – 30 секунд.
</div>
 
<div lang="ru" dir="ltr" class="mw-content-ltr">
<div lang="ru" dir="ltr" class="mw-content-ltr">
== '''Реализация''' ==
== '''Реализация''' ==
Строка 64: Строка 77:
</div>
</div>
Далее нужно перейти в серверное приложение и выполнить команду:
Далее нужно перейти в серверное приложение и выполнить команду:
<code>docker exec -it smartplayer_backend_i bash</code>
<code>docker exec -it smartplayer_backend_1 bash</code>
[[File:Команда docker.png|thumb|Команда"docker exec -it smartplayer_backend_i bash" |300px]]
[[File:Команда docker.png|thumb|Команда"docker exec -it smartplayer_backend_1 bash" |300px]]
На этом этапе попадаем в нашем контейнере с серверным приложением.<br>
На этом этапе попадаем в нашем контейнере с серверным приложением.<br>
Следующей выполняем команду:
Следующей выполняем команду:
<code>Enable screen - screen monitor </code>[[File:Enable screen monitor.png|thumb|Команда"docker exec -it smartplayer_backend_i bash" |300px]]
<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]]
Системное сообщение: <code>Input company ID and press Enter</code>[[File:Системное сообщение.png|thumb|Системное сообщение "Input company ID and press Enter:" |300px]]
Строка 77: Строка 90:
Это делается в строке:<br>
Это делается в строке:<br>
<code>Input_email and press enter</code>
<code>Input_email and press enter</code>
[[File:Строка почты.png|thumb|Здесь нужно запустить мониторинг платформ нажав "ДА/Y" |300px]]
[[File:Строка почты.png|thumb|Команда"Input_email_and_press_Enter:" |300px]]
{{Note|Указанная почта должна быть привязана к серверу.|warn}}
{{Note|Указанная почта должна быть привязана к серверу.|warn}}
Также можно указать интервал с которым будут приходить скриншоты (например 1 минута). Строка выглядит так:<br>
Также можно указать интервал с которым будут приходить скриншоты (например 1 минута). Строка выглядит так:<br>
<code>Input check interval in minutes (m) or seconds (s) and press "Enter"</code><br>
<code>Input check interval in `seconds` or `minutes` or `hours` or `days` and press Enter: (30 minutes)</code><br>
[[File:Интервал отправки сообщения.png|thumb|Здесь нужно указать время в минутах с префиксом (m) или в секундах с префиксом (S) |300px]]
[[File:Интервал отправки сообщения.png|thumb|Пример отображения кода |300px]]
Далее указываем время либо в секундах с префиксом (s) после числового значения, либо в минутах с префиксом (m) и применяем эту настройку через "Enter". Итогом всех манипуляций будет статус:<br>
Здесь нужно указать время с соответствующим префиксом(поддерживается ввод только одного префикса):
* секунды - seconds;
* минуты - minutes;
* часы - hours;
* дни - days.
Далее применяем эту настройку через "Enter". Итогом всех манипуляций будет статус:<br>
<code>Company screen monitoring enabled</code> - выделена зеленым цветом. Это значит что детектор черного экрана запущен.
<code>Company screen monitoring enabled</code> - выделена зеленым цветом. Это значит что детектор черного экрана запущен.
[[File:Запуск детектора.png|thumb|Оповещение о запуске Детектора выделено зелёным цветом |300px]]
[[File:Запуск детектора.png|thumb|Оповещение о запуске Детектора выделено зелёным цветом |300px]]
Проверить настроенные уведомления можно с помощью команды <code>./cli.js company show-screen-monitor</code>
'''Отключить детектор черных экранов:''' <code>./cli.js company disable-screen-monitor</code>
</div>
<div lang="ru" dir="ltr" class="mw-content-ltr">
=== '''Уведомления на почту''' ===
=== '''Уведомления на почту''' ===
Второй этап настройка уведомления, которые приходят на почту. Настройка уведомления подробно прописана в отдельной инструкции [[Настройка отправки писем через серверное приложение SmartPlayer]].<br>
Второй этап настройка уведомления, которые приходят на почту. Настройка уведомления подробно прописана в отдельной инструкции [[Настройка отправки писем через серверное приложение SmartPlayer]].<br>
Строка 95: Строка 118:
{{Note|'''Детектор черного экрана на данный момент работает только на Android версии 1.63.1'''|warn}}
{{Note|'''Детектор черного экрана на данный момент работает только на Android версии 1.63.1'''|warn}}
</div>
</div>
<div lang="ru" dir="ltr" class="mw-content-ltr">
<div class="mw-translate-fuzzy">
== '''Итоговый результат''' ==
== '''Final Outcome:''' ==
Системный администратор со стороны клиента сможет запустить и настроить функционал детектора и начать решать проблему.
The client's system administrator will be able to launch and set up the black screen detector functionality and start resolving the problem. Having
Наличие детектора позволяет контролировать проблемную ситуацию с "Чёрным" экраном и оперативно работать с её исправлением. Это актуально как для нас, так и для сотрудников клиента.
Having the detector allows monitoring the problematic situation with the "Black" screen and promptly work on its correction. This is relevant both for us and for the client's employees. The SmartPlayer team and the client-side employee team will be able to interact quickly to solve the problem.<br>
Команда SmartPlayer и команда сотрудников со стороны клиента смогут оперативно взаимодействовать для решения проблемы. <br>
Ordinary users will minimize the negative experience of interacting with our product.
Рядовой пользователь минимизирует негативный опыт взаимодействия с нашим продуктом.
</div>
</div>

Текущая версия от 15:38, 15 января 2026

Другие языки:

Situation Description

Users are experiencing issues with broadcasts on their devices. When playing content on some devices, a "black" screen appears. This problem can be observed in the user's personal account or at the device's location.

Cause

On devices operating on-site, a "black screen" appears during content playback. Meanwhile, the broadcast in the personal account continues to run but only displays a "black" screen.
This situation arises due to various errors when starting the broadcast. The reasons for such problems can vary and are very difficult to detect.
Any of the following actions can be a cause:

  • A user uploads a video, but this video uses a codec unsupported by the system. As a result, the video simply cannot start and displays a black screen. There are issues related to the client application (a bug), leading to broadcast problems
  • As long as there is a consistent, stable network, everything works fine. However, as soon as the device loses network access (for any reason), the broadcast is interrupted, and a black screen appears.
An example of displaying a "Black" screen in the user's personal account

Frequency of the Problem

It's very easy to detect and visually confirm the "black" screen. In such cases, the personal account is very helpful.
The challenge with this situation is that it doesn't have a consistent frequency; it can occur once a month, or once every few days or even hours.
The period when the black screen appears is determined empirically and is confirmed on-site. The responsibility of finding the cause of the problem falls on technical specialists.

Концепт решения

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

Данный функционал не доступен пользователю в личном кабинете. Его необходимо включать отдельно.

Принцип действия

У каждого клиента/компании есть свой ID связанный с сервером. ID указан в личном кабинете и к нему привязываются все устройства компании.
После запуска функционала сервер с определенным промежутком по времени отправляет на устройства «ивент».
Запуская «ивент» устройство с помощью детектора проверяет наличие "черного" экрана, делая скриншот во время запуска.
После запуска детектора возможно получить два определенных результата:

  • После запуска «ивента» черного экрана нет - система продолжает работу в штатном режиме.
  • После запуска «ивента» чёрный экран обнаружен - сервер отправляет повторный, проверочный "ивент".

Промежуток для повторной отправки "ивента" по умолчанию составляет 10 секунд.
Если же и во второй раз отправляется скриншот "чёрного" экрана то со стороны сервера отправляется письмо на почту, о наличии проблемы.

Указанная почта должна быть привязана к серверу.

Подготовка

Системный администратор должен настроить серверное приложение по двум параметрам:

  • Запуск и функционирование детектора "чёрного" экрана
  • Настройка отправки письма с ошибкой на почту

Принцип действия

Если серверное приложение обнаружило черный экран, оно отправляет на почту письмо. Итогом этой проверки станет сообщение на почту с оповещение о проблеме.
Для подтверждения проверки работоспособности функционала через личный кабинет системный администратор может поставить черную картинку. Сервер продолжает отправляет оповещения пока проблема не будет исправлена или же пока не будет выключен функционал.
Впоследствии системный администратор должен принять меры для устранения проблемы.

Тонкости и нюансы при работе функционала

1. Для правильного работы необходимо чтобы placeholder с белой точкой воспринимался как черный экран. Поэтому используется не абсолютная проверка.
2. При наличии root прав на устройстве – детектор работает нормально. Но, если, на устройстве нет root прав, детектор не сможет сделать скриншот.
Исключения:
Скриншот доступен:

  • Если приложение подписано «подписью разработчика» (уровень прав – Signage).
  • Некоторые устройства (Vestel, Hikvision, Phillips) могут сделать скриншот без root прав из-за особенностей прошивки.

3. Если пользователь попробует сделать скриншот без root прав, то создается «пустой скриншот» с надписью «Идёт воспроизведение видео. Отсутствуют права для снятия скриншота».
4. Информация от сервера к разработчикам отправляется через "ивент". Внутри отправленного «ивента» сервер ждет callback от разработчиков.
5. Тайм – аут “Callback” по умолчанию на сервере составляет – 30 секунд.

Реализация

Активация

По умолчанию детектор для всех компаний отключен на сервере, так как создает на него слишком большую нагрузку.

Включается детектор только по запросу со стороны компании, у которой появилась проблема с чёрным экраном.

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

Вся работа будет вестись в два этапа.
Первый этап - это запуск самого детектора.

При запуске детектора нужно использовать id компании, который указан в личном кабинете.
Расположение ID компании в личном кабинете

Для этого нужно зайти в профиль и развернуть подробную информацию о пользователе. Системному администратору нужно подключиться на сервер, через Command Line Interface (CLI).

При включении CLI сервер получает определенные данные для настройки:
Это:

  • ID компании, для которой включаем детектор
  • Можно передать платформу (или несколько платформ), для которой необходимо запустить мониторинг.

Например: передаем параметр "ANDROID" и мониторинг включается только для устройств "ANDROID".

  • E-mail адрес или несколько адресов на которые должно отправляться уведомление о нештатной ситуации
  • Указанное время хранения скриншотов (по умолчанию 3 дня)

Далее нужно перейти в серверное приложение и выполнить команду: docker exec -it smartplayer_backend_1 bash

Команда"docker exec -it smartplayer_backend_1 bash"

На этом этапе попадаем в нашем контейнере с серверным приложением.
Следующей выполняем команду:

./cli.js company enable-screen-monitor
Команда"./cli.js company enable-screen-monitor"

После очередного этапа система выдает вот такую строку:

Системное сообщение: Input company ID and press Enter
Системное сообщение "Input company ID and press Enter:"

Выполненная команда отобразит строку в которой просят ввести Id компании.
После ввода ID появляется запрос на мониторинг всех платформ компании. В данном случае выбираем «ДА/Y»

Здесь нужно запустить мониторинг платформ нажав "ДА/Y"

В последствии консоль потребует указать e-mail на который будут приходить оповещения о проблемах. Это делается в строке:
Input_email and press enter

Команда"Input_email_and_press_Enter:"
Указанная почта должна быть привязана к серверу.

Также можно указать интервал с которым будут приходить скриншоты (например 1 минута). Строка выглядит так:
Input check interval in `seconds` or `minutes` or `hours` or `days` and press Enter: (30 minutes)

Пример отображения кода

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

  • секунды - seconds;
  • минуты - minutes;
  • часы - hours;
  • дни - days.

Далее применяем эту настройку через "Enter". Итогом всех манипуляций будет статус:
Company screen monitoring enabled - выделена зеленым цветом. Это значит что детектор черного экрана запущен.

Оповещение о запуске Детектора выделено зелёным цветом

Проверить настроенные уведомления можно с помощью команды ./cli.js company show-screen-monitor Отключить детектор черных экранов: ./cli.js company disable-screen-monitor

Уведомления на почту

Второй этап настройка уведомления, которые приходят на почту. Настройка уведомления подробно прописана в отдельной инструкции Настройка отправки писем через серверное приложение SmartPlayer.

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

Предфинальные действия

В зависимости от результата, системный администратор сможет корректно определить причину и предпринять конкретные действия для устранения ситуации. Если у него не получается решить проблему внутри своей среды или же проблема на нашей стороне, он должен обратиться к команде SmartPlayer.
Это вариант удобен для всех. Так как поможет решить проблемы если они и с нашей стороны (например баг приложения), так и со стороны пользователя (например пользователь неправильно создал трансляцию).

Важная информация о которой не стоит забывать

Для перезапуска трансляции надо зайти в личный кабинет и перезапустить все вручную
Детектор черного экрана на данный момент работает только на Android версии 1.63.1

Final Outcome:

The client's system administrator will be able to launch and set up the black screen detector functionality and start resolving the problem. Having Having the detector allows monitoring the problematic situation with the "Black" screen and promptly work on its correction. This is relevant both for us and for the client's employees. The SmartPlayer team and the client-side employee team will be able to interact quickly to solve the problem.
Ordinary users will minimize the negative experience of interacting with our product.

Источник — https://wiki.smartplayer.org/index.php?title=%22Детектор%22_черного_экрана_(Системный_администратор)/en&oldid=18561