metrics.md

Metrics

Назначение

Metrics отвечает за внутренний admin-only endpoint с базовыми счетчиками сервиса.

Модуль нужен для быстрой технической сводки: сколько в системе пользователей, ролевых профилей, проектов, вакансий и сколько пользователей сейчас считаются online через websocket-чаты.

Статус модуля

Модуль рабочий и подключен в корень API через GET /.

Endpoint доступен только staff-пользователям. Для anonymous и обычных authenticated пользователей доступ закрыт.

Основные возможности

• подсчет общего количества пользователей;
• подсчет количества ролевых профилей пользователей;
• подсчет количества проектов;
• подсчет количества вакансий;
• подсчет текущих online-пользователей по cache-ключу websocket-чата.

Архитектура

• metrics/views.py - HTTP endpoint метрик.
• metrics/services.py - сбор response payload.
• metrics/urls.py - route модуля.
• metrics/tests/ - regression-тесты и helpers модуля.

API

• GET / - получить внутренние метрики сервиса.

Response содержит поля:

• total_CustomUser_count - количество пользователей;
• total_Expert_count - количество экспертных профилей;
• total_Investor_count - количество профилей инвесторов;
• total_Member_count - количество профилей участников;
• total_Mentor_count - количество профилей менторов;
• total_Project_count - количество проектов;
• total_Vacancy_count - количество вакансий;
• current_online_users - количество пользователей online по данным cache.

Основные сценарии

Staff открывает внутреннюю сводку

Staff-пользователь отправляет GET / и получает текущие счетчики.

Счетчики total_*_count считаются через objects.count() соответствующих моделей.

Подсчет online-пользователей

current_online_users считается по cache-ключу online_users.

Этот ключ наполняется модулем chats: при подключении пользователя к websocket-чату пользователь добавляется в set online-пользователей, при отключении удаляется.

Связи с другими модулями

• users - счетчики пользователей и ролевых профилей.
• projects - счетчик проектов.
• vacancy - счетчик вакансий.
• chats - источник данных для current_online_users.
• core - cache helpers для online-ключей.

Ограничения и риски

• Endpoint подключен к корню API: GET /. Это текущий контракт, но он неочевиден для отдельного модуля метрик.
• current_online_users показывает только пользователей, которые считаются online через websocket-чаты. Пользователь, который делает только HTTP-запросы, в этот счетчик не попадет.
• Online-счетчик зависит от cache. После очистки cache значение будет 0, пока пользователи снова не подключатся к websocket.
• Поля response имеют технические имена моделей и сохранены для совместимости.

Тесты

Текущие тесты лежат в metrics/tests/.

Проверяется:

• anonymous пользователь не получает доступ к метрикам;
• обычный authenticated пользователь не получает доступ к метрикам;
• staff-пользователь получает payload метрик;
• service считает пользователей, ролевые профили, проекты, вакансии и online-пользователей;
• пустой online-cache возвращает current_online_users = 0;
• helper подсчета модели сохраняет уже собранный payload.