Система логирования#

Инструкция по сбору логов#

Сбор логов необходим для:

Предоставления информации технической поддержки VisionLabs для составления тикета на поиск проблемы;
Самостоятельного поиска ошибок.

Для получения полной информации о нештатной ситуации при работе Access необходимо подготовить и передать информацию представителю VisionLabs о:

Файле настроек;
Логах контейнеров;
Файле .env;
Информацию о рабочем окружении;
Скриншоты UI (только в случаях ошибок UI).

Файл настроек#

Файл настроек – JSON файл, который содержит информацию об используемых компонентах в Access.

Файл настроек становится доступен для экспорта после создания в Access компонента.

1․ После создания любого из 4-х типов компонентов необходимо нажать на справа от аватара пользователя и нажать кнопку "Экспортировать настройки" (Рисунок 8).

Экспорт настроек

При этом произойдет загрузка JSON файла с именем vl-access_setting.json.

2․ Найдите JSON на локальной машине.

Для Linux-систем по умолчанию /home/\<username>/Downloads.

3․ Переименуйте файл настроек в зависимости от основных используемых сервисов и устройств, например, bolid+gate+fast.json.

Логи контейнеров#

Файлы логов контейнеров содержат всю информацию о работе Access от момента запуска (docker compose up) до создания логов, при условии активности контейнеров.

1․ Откройте в консоли директорию Access.

Для самопроверки удостоверьтесь, что в этой директории есть /db и docker-compose.yml (Рисунок 9).

Корректная директория

2․ Активируйте дебаг режим: в файле .env установите значение переменной DEBUG=1.

3․ Перезапустите Access:

docker-compose down
docker-compose up

4․ Выполните команды для записи логов контейнеров worker и fastapi:

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

docker-compose logs worker &> worker_<components_names, bolid+gate+fast>.log
docker-compose logs fastapi &> fastapi_<components_names, bolid+gate+fast>.log

5․ Проверьте наличие созданных файлов .log в той же директории.

Файл .env#

Файл .env находится в корневой папке дистрибутива (там же где docker-compose.yml), но может не отображаться в UI по умолчанию.

1․ Найдите файл .env для передачи представителю VisionLabs.

Информация о рабочем окружении#

Сверьте аппаратные и программные свойства рабочей машины с минимальными (см. Требования).

Для проверки требований выполните команды просмотра:

1․ Версия ОС локальной машины:

hostnamectl

2․ Версия docker/docker-compose:

docker --version
docker-compose --version

3․ Информация о аппаратных характеристиках:

cat /proc/cpuinfo | grep "model name"

4․ Объем свободной оперативной памяти:

free -h

5․ Объем свободного дискового пространства:

df -h

Скриншоты UI#

Скриншоты необходимы только для поиска проблемы с UI:

неадекватно отображается статус is_alive компонента,
отображается компонент, которого не должно быть (удалили, но он "вернулся"),
появилась нечитаемая ошибка,
в списке в LUNA Clementine дубли - на скриншот должны попасть даты создания лиц в списке,
есть расхождения с событиями в LUNA Clementine, неверный тег события,
прочее проблемы с UI.