Платформа «Большой брат v2»

Введение

Настоящий документ описывает функциональные характеристики, состав модулей, правила, методы и принципы работы программного обеспечения «Большой брат v2» (далее — Платформа, ПО).

Платформа представляет собой программный комплекс для мониторинга транспортных средств в режиме реального времени, сбора и хранения телематических данных, формирования тревожных оповещений и аналитической отчётности.

Программное обеспечение предназначено для поставки в формате on-premise (на инфраструктуру заказчика) и может использоваться как готовое решение либо в качестве прототипа для создания на его основе специализированных SaaS-продуктов.

Используемые термины, аббревиатуры, сокращения

В тексте использованы следующие сокращения и аббревиатуры:

3. Функциональные характеристики

3.1. Цели и назначение

Платформа «Большой брат v2» предназначена для обеспечения эффективного автоматизированного мониторинга и контроля работы транспортного парка в режиме реального времени.

Целевые задачи Платформы:

• Непрерывный приём, обработка и хранение телематических данных от бортовых блоков ТС;
• Визуализация текущего положения и состояния ТС на карте;
• Автоматическое формирование тревожных оповещений при наступлении критических событий;
• Построение маршрутов (треков) и анализ истории перемещений ТС;
• Контроль показаний бортовых датчиков (топливо, температура, напряжение, моточасы и др.);
• Формирование аналитических и операционных отчётов;
• Управление справочниками организаций, транспортных средств, аккаунтов и конфигураций.

3.2. Ключевые функции

Основными возможностями Платформы являются:

• Приём телематических данных от бортовых блоков по протоколу Wialon Combine через TCP-соединение;
• Потоковая обработка данных через Apache Kafka с гарантией доставки и масштабирования;
• Хранение временных рядов телеметрии в TimescaleDB с автоматическим партиционированием, сжатием и политиками удержания;
• Отображение текущего положения ТС на интерактивной карте в режиме реального времени (обновление каждые 20 секунд);
• Визуализация состояния ТС: движение, стоянка, отключение связи, наличие активных тревог;
• Построение треков с событиями (остановки, превышения скорости, входы/выходы из геозон);
• Мониторинг показаний датчиков: уровень топлива, температура, напряжение бортовой сети, зажигание, моточасы, одометр, пожарные датчики;
• Развитая система тревог с поддержкой 26 типов событий — от отключения питания до контроля температурного режима;
• Оповещение заинтересованных лиц о тревогах через веб-интерфейс, электронную почту и Telegram;
• Настраиваемые геозоны для контроля нахождения ТС в разрешённых/запрещённых зонах;
• Формирование отчётов: движение и стоянки, заправки и сливы топлива, моточасы, нарушения скоростного режима, посещения геозон;
• Управление справочниками: организации, аккаунты, ТС, датчики, маршруты, конфигурации;
• Ролевая модель доступа с гранулярным управлением правами на уровне операций (создание, чтение, изменение, удаление) и ресурсов;
• REST API с JWT-авторизацией для интеграции со сторонними системами;
• Агрегация телематических показателей с детализацией до каждого ТС и произвольного временного диапазона.

3.3. Функциональные модули

Функционал Платформы состоит из следующих модулей:

3.4. Система тревог и оповещений

Платформа поддерживает автоматическую генерацию тревог по следующим типам событий:

3.5. Отчётность

Платформа предоставляет следующие виды отчётов:

Отчёты по запросу (формат XLSX)

• Сводный отчёт по движению и стоянкам — анализ режимов работы ТС: время в движении, время стоянок, пробег, средняя и максимальная скорость;
• Топливный отчёт — расход топлива, заправки, сливы с детализацией по каждому ТС за выбранный период.

Регулярные отчёты (формируются автоматически по расписанию)

• Отчёт по моточасам — учёт наработки двигателя по каждому ТС;
• Групповой топливный отчёт — сводка по расходу топлива по группе ТС;
• Детальный топливный отчёт — детализированный анализ расхода топлива;
• Отчёт по геозонам — статистика посещения геозон: время входа/выхода, длительность пребывания;
• Отчёт по нарушениям скоростного режима — фиксация превышений установленных скоростных ограничений;
• Отчёт по активности заправок — анализ заправочных операций;
• Отчёт по посещению объектов — контроль выполнения маршрутных заданий и графика посещений.

3.6. Программный интерфейс (API)

Платформа предоставляет REST API для интеграции со сторонними информационными системами:

4. Архитектура и технологический стек

Платформа построена на микросервисной архитектуре и включает 18 специализированных сервисов, объединённых посредством Apache Kafka (потоковая обработка) и HTTP REST (синхронные запросы).

Основные технологии

Состав микросервисов

5. Информация, необходимая для установки и начала эксплуатации

Модель поставки

Программное обеспечение «Большой брат v2» поставляется исключительно в формате on-premise — путём передачи (отчуждения) экземпляра ПО для развёртывания на инфраструктуре заказчика. Предоставление доступа к ПО по модели SaaS (software as a service) через Интернет не предусмотрено.

Допускается использование Платформы в качестве прототипа или программной основы для создания заказчиком собственных SaaS-решений на базе переданного экземпляра.

Форма поставки

ПО поставляется в виде:

• Исходного кода (Git-репозиторий с субмодулями);
• Docker-образов, собираемых из исходного кода;
• Конфигурационных файлов и скриптов развёртывания (docker-compose.yml, .env.example);
• SQL-скриптов автоматической инициализации базы данных (database/postgres/init/);
• Комплекта документации (руководство по развёртыванию, описание архитектуры, руководство пользователя).

Развёртывание

Развёртывание Платформы выполняется администратором на сервере заказчика с использованием Docker и Docker Compose. Процесс включает:

1. Клонирование Git-репозитория с субмодулями;
2. Настройку конфигурационного файла .env (пароль БД, порты);
3. Сборку Docker-образов командой docker compose build;
4. Запуск системы командой docker compose up -d.

При первом запуске автоматически выполняются:

• Сборка кастомного образа PostgreSQL с необходимыми расширениями;
• Инициализация баз данных: создание схем, таблиц, функций и справочных данных (11 SQL-скриптов);
• Запуск Apache Kafka в KRaft-режиме;
• Последовательный запуск всех 18 микросервисов с учётом зависимостей и проверок здоровья.

Доступ к системе после развёртывания

После завершения развёртывания и запуска системы пользователям доступен веб-интерфейс по адресу:

http://<адрес_сервера> (порт 80)

Самостоятельная регистрация пользователей в системе не предусмотрена. Создание и управление учётными записями выполняется администратором системы через интерфейс управления справочниками.

При первоначальном развёртывании в системе автоматически создаётся учётная запись суперпользователя.

Требования к рабочему месту пользователя

На клиентском компьютере для работы с веб-интерфейсом Платформы необходим веб-браузер, поддерживающий современные веб-стандарты:

• Google Chrome версии 99 и выше (рекомендуется);
• Mozilla Firefox версии 100 и выше;
• Microsoft Edge версии 99 и выше;
• Яндекс.Браузер версии 22 и выше.

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

6. Системные требования

Сервер приложений

Сетевые требования

7. Техническая поддержка

Техническая поддержка ПО «Большой брат v2» оказывается в рамках договора на поставку и сопровождение программного обеспечения.

В состав поставки входит комплект документации:

• Руководство по развёртыванию — пошаговая инструкция установки и настройки;
• Описание архитектуры — схемы, компоненты, взаимодействия;
• Руководство пользователя — работа с интерфейсом по ролям;
• Описание функциональных характеристик (настоящий документ);
• Документация по каждому микросервису — описание API, конфигурации, зависимостей.

Вопросы, возникающие в ходе эксплуатации ПО, следует направлять в службу технической поддержки: