Введение

Настоящий документ содержит руководство по эксплуатации программного продукта vPCRF (Virtual Policy and Charging Rules Function), реализующего функции политик и тарификации для сетей мобильной связи. Документ предназначен для администраторов и операторов, осуществляющих повседневное управление, мониторинг и обслуживание программного обеспечения.

Эксплуатация включает совокупность процессов и процедур, направленных на обеспечение непрерывного и корректного функционирования vPCRF. В документе рассматриваются вопросы запуска и останова программы, мониторинга состояния, управления конфигурацией, сбора диагностической информации, а также типовые операции.

Целевая аудитория

Администраторы, осуществляющие управление экземплярами vPCRF

Операторы, выполняющие мониторинг и контроль работоспособности

Инженеры, участвующие в настройке и оптимизации параметров работы

Специалисты технической поддержки

Необходимая квалификация

Уверенное владение командной строкой (Windows PowerShell, Linux bash)

Понимание основ сетевых технологий и протоколов (Diameter, HTTP, TCP/UDP/SCTP)

Знание архитектуры сетей мобильной связи (базовый уровень)

Навыки анализа текстовых файлов журналов

1. Запуск и остановка программного обеспечения

1.1 Запуск программы

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

Под Windows (MinGW):

powershell
.\vpcrf.exe

Под Linux / macOS:

bash
./vpcrf

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

Загружает конфигурационный файл config.json

Инициализирует выбранный бэкенд базы данных (SQLite/PostgreSQL)

Загружает сохранённые сессии из базы данных

Выполняет проверку доступности внешних систем (HSS, OCS)

Запускает встроенный HTTP-сервер для метрик и управления

При наличии конфигурации freeDiameter запускает Diameter-стек

Выводит сообщение о готовности с информацией о режиме работы

1.2 Останов программы

Штатная остановка:

Нажмите Ctrl+C (SIGINT) в окне терминала. Программа выполняет:

Установку флага остановки для всех рабочих потоков

Остановку потока очистки сессий

Остановку Diameter runtime (при активном freeDiameter)

Закрытие соединений с внешними системами

Закрытие соединения с базой данных

Завершение процесса

Принудительная остановка (только в крайнем случае):

bash
kill -TERM <PID> # Linux
taskkill /PID <PID> # Windows

1.3 Перезапуск программы

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

Для перезагрузки конфигурации без остановки используйте динамический reload через REST API или сигнал SIGHUP (Linux):

bash
kill -HUP <PID>

2. Консоль управления и REST API

Управление осуществляется через встроенный REST API.

2.1 Доступ к REST API

Базовый URL: http://127.0.0.1:9100/api/v1

Для работы рекомендуется использовать утилиту curl или любой HTTP-клиент.

Быстрая проверка доступности:

bash
curl http://127.0.0.1:9100/health

2.2 Команды мониторинга состояния

GET /health — состояние узла

bash
curl http://127.0.0.1:9100/health

Ответ содержит статусы live/ready/degraded, состояние БД, флаги HSS/OCS/freeDiameter.

GET /ready — готовность принимать трафик

bash
curl http://127.0.0.1:9100/ready

GET /metrics — метрики в формате Prometheus

bash
curl http://127.0.0.1:9100/metrics

2.3 Команды управления (требуют admin_api_token)

GET /admin/session/stats — статистика сессий

bash
curl -H "Authorization: Bearer <token>" http://127.0.0.1:9100/admin/session/stats

POST /admin/session/cleanup — принудительная очистка просроченных сессий

bash
curl -X POST -H "Authorization: Bearer <token>" http://127.0.0.1:9100/admin/session/cleanup

POST /admin/session/remove — удаление конкретной сессии

bash
curl -X POST -H "Authorization: Bearer <token>" -H "Content-Type: application/json"
-d '{"session_id": "session123"}' http://127.0.0.1:9100/admin/session/remove

PATCH /admin/runtime/config/update — динамическое обновление параметров

bash
curl -X PATCH -H "Authorization: Bearer <token>" -H "Content-Type: application/json"
-d '{"session_timeout": 3600}' http://127.0.0.1:9100/admin/runtime/config/update

POST /admin/runtime/config/reload — перезагрузка конфигурации из файла

bash
curl -X POST -H "Authorization: Bearer <token>" http://127.0.0.1:9100/admin/runtime/config/reload

3. Конфигурирование программы

3.1 Файл конфигурации

Программа использует JSON-файл config.json, расположенный в рабочей директории.

3.2 Параметры конфигурации

Секция базы данных:

Секция Diameter:

Секция внешних систем:

Секция HTTP и управления:

Секция сессий:

3.3 Пример конфигурационного файла

json

3.4 Изменение конфигурации в процессе эксплуатации

Временное изменение (без перезапуска):

Используйте REST API PATCH /admin/runtime/config/update или сигнал SIGHUP.

Постоянное изменение:

Остановите программу (Ctrl+C)

Отредактируйте файл config.json

Запустите программу заново

4. Мониторинг и сбор диагностической информации

4.1 Журнал событий

Программа ведёт журнал с выводом на консоль. Формат строки журнала:

text
YYYY-MM-DD HH:MM:SS.mmm [LEVEL] [ИСТОЧНИК] Сообщение

Пример строки журнала:

text
2026-04-07 16:40:05.691 [INFO ] [SessionManager] Session added session_id=sess123

4.2 Метрики производительности

Программа предоставляет метрики в формате Prometheus на эндпоинте /metrics (порт 9100).

Пример метрик:

text
vpcrf_requests_total{interface="Gx"} 100
vpcrf_permits_total{interface="Gx"} 90
vpcrf_rejects_total{interface="Gx"} 10
vpcrf_session_limit_percent 75
vpcrf_critical_errors_total 0

Получение метрик:

bash
curl http://127.0.0.1:9100/metrics

4.3 Мониторинг использования ресурсов

Процессор и память (Linux):

bash
top -p $(pgrep vpcrf)

Сетевые порты:

bash
netstat -tulpn | grep vpcrf

Ожидаемые порты:

4.4 Сбор диагностического пакета

При возникновении инцидента соберите следующие данные:

Версия программы (из лога при запуске)

Файл конфигурации config.json (удалив секреты)

Вывод REST API:

/health

/ready

/metrics

/admin/session/stats (если доступен)

Информация об окружении (Linux):

bash
uname -a
cat /etc/os-release

5. Типовые эксплуатационные процедуры

5.1 Ежедневные операции

Проверка работоспособности:

bash

Проверка состояния узла

curl http://127.0.0.1:9100/health

Проверка готовности

curl http://127.0.0.1:9100/ready

Просмотр метрик

curl http://127.0.0.1:9100/metrics | head -20

Проверка количества сессий:

bash
curl -H "Authorization: Bearer <token>" http://127.0.0.1:9100/admin/session/stats

5.2 Еженедельные операции

Анализ ключевых метрик (количество запросов, отказов, ошибок):

bash
curl http://127.0.0.1:9100/metrics | grep -E "requests_total|rejects_total|errors_total"

Проверка состояния внешних интеграций:

Анализ логов на наличие сообщений о недоступности HSS, OCS или биллинга.

5.3 Ежемесячные операции

Анализ производительности (среднее количество сессий, пиковые нагрузки):

Экспорт метрик за период через внешнюю систему мониторинга (Prometheus).

Резервное копирование конфигурации:

bash
cp config.json config.json.$(date +%Y%m%d)

Проверка актуальности версии: сравните текущую версию с последним релизом.

5.4 Действия в нештатных ситуациях

Программа не отвечает на HTTP запросы:

Проверьте, запущен ли процесс:

bash
ps aux | grep vpcrf # Linux
Get-Process vpcrf # Windows

Проверьте, слушается ли порт 9100:

bash
netstat -an | grep 9100

Принудительно остановите и запустите заново.

Потеря связи с HSS или OCS:

Проверьте состояние через /health:

bash
curl http://127.0.0.1:9100/health

Проверьте сетевую доступность:

bash
ping hss.example.com

Программа работает в деградированном режиме — восстановите связь.

Некорректное применение политик:

Проверьте журнал на наличие ошибок:

bash
grep -i "error|fail" /var/log/vpcrf.log

Проверьте соединение с базой данных.

Включите отладочное логирование (при необходимости).

6. Взаимодействие со смежными системами

6.1 Проверка доступности

Проверка HTTP порта (9100):

bash
curl -I http://127.0.0.1:9100/health

Проверка Diameter порта (3868 SCTP):

Для Linux используйте sctp_test или специализированные утилиты.

6.2 Мониторинг с внешних систем

Prometheus экспорт:

vPCRF предоставляет метрики в формате Prometheus на эндпоинте /metrics (порт 9100).

Интеграция через анализ журнала (syslog):

bash
tail -f /var/log/vpcrf.log | while read line; do
if echo "$line" | grep -q "ERROR|CRITICAL"; then

Отправка alert во внешнюю систему

fi
done

Приложение А. Быстрый справочник команд (REST API)

Быстрый скрипт для bash:

bash
BASE="http://127.0.0.1:9100"
TOKEN="your-admin-token"

Статус

curl -s "$BASE/health" | jq .

Метрики

curl -s "$BASE/metrics" | head -20

Статистика сессий

curl -s -H "Authorization: Bearer TOKEN""TOKEN""BASE/admin/session/stats" | jq .

Приложение Б. Расположение файлов