Files
XC_VM/docs/ru/guides/diagnostics-api.md
T
Divarion-D f4555e7943 docs: reorganize structure, sync with current code, add missing framework reference
Structure:
- Split development/ (20 files) into development/ (framework reference) and guides/ (how-to)
- Moved 13 how-to files into new guides/ category (auth, cli, error-handling, etc.)
- Moved navbar-rendering.md from system/ into development/
- Deleted empty system/README.md files
- Deleted documentation_gaps.md (all gaps resolved) and redundant info/update.md

Sidebar / navbar:
- Removed all emojis from _sidebar.md (EN + RU) — fixes tree hierarchy rendering
- Removed flag emojis from _navbar.md language switcher
- Removed duplicate entries from the old "System Documentation" section
- Renamed section headers: "Development" -> "Framework Reference" + "Developer Guides"

Content fixes (modules.md EN + RU):
- Updated "Class naming" section: now documents XcVm\Module\{Pascal} namespaces
  (was "global PHP namespace — Until PHP namespaces are introduced")
- Updated main module class example to use namespace declaration + use statements
- Updated class naming in ModuleLoader description to FQN
- Replaced installCrontab() manual crontab instruction with getCronEntries() API
- Updated enable/disable section: added ModuleState enum table, updated config examples
- Fixed FAQ answer for disabling a module

Content fixes (bootstrap-contexts.md EN + RU):
- Replaced CONTEXT_* string constants with BootContext enum cases throughout
- Updated boot() signature: string $context -> BootContext $context
- Updated getContext() return type: ?string -> ?BootContext

New framework reference docs (EN + RU):
- docs/{en,ru}/development/event-system.md: EventDispatcher singleton bridge,
  #[ListensTo] attribute, getEventSubscribers() array API, stoppable events,
  built-in event catalog, custom event authoring, ListensTo attribute reference
- docs/{en,ru}/development/exception-hierarchy.md: full XcVmException tree,
  container vs module subtrees, PSR-11 compliance notes, catch-by-subsystem examples
2026-06-15 18:27:23 +03:00

5.6 KiB
Raw Blame History

Сервис диагностики

DiagnosticsService предоставляет утилиты для диагностики состояния системы: анализ SSL-сертификатов, проверка совместимости кодеков, работа с журналами панели и определение внешнего IP.


Методы

getCertificateInfo(?string $certificate = null): ?array

Возвращает информацию об SSL-сертификате.

Параметры:

  • $certificate — путь к файлу сертификата. Если null — путь считывается автоматически из BIN_PATH/nginx/conf/ssl.conf

Возвращает:

[
    'serial'     => string,   // серийный номер
    'expiration' => int,      // UNIX timestamp истечения
    'subject'    => string,   // CN/subject сертификата
    'path'       => string,   // директория сертификата
]

Возвращает null если:

  • Файл сертификата не найден
  • openssl x509 завершился с ошибкой

Пример:

$info = DiagnosticsService::getCertificateInfo();
if ($info) {
    $days = ($info['expiration'] - time()) / 86400;
    echo "Сертификат истекает через {$days} дней";
    echo "Subject: " . $info['subject'];
}

checkCompatibility(array|string $data, bool $allowHEVC = false): bool

Проверяет совместимость кодеков стрима с плеером.

Параметры:

  • $data — вывод FFProbe в виде массива или JSON-строки. Ожидает ключ codecs с подключами audio.codec_name и video.codec_name
  • $allowHEVC — разрешить HEVC/H.265 и AC3 (по умолчанию отключено)

Поддерживаемые кодеки:

Тип Поддерживаемые кодеки (по умолчанию) Дополнительно (с $allowHEVC)
Видео h264, vp8, vp9, ogg, av1 hevc, h265
Аудио aac, libfdk_aac, opus, vorbis, pcm_s16le, mp2, mp3, flac ac3

Пример:

$ffprobeData = [
    'codecs' => [
        'video' => ['codec_name' => 'h264'],
        'audio' => ['codec_name' => 'aac'],
    ]
];

if (DiagnosticsService::checkCompatibility($ffprobeData)) {
    echo 'Кодеки совместимы с плеером';
}

downloadPanelLogs(object $db): array

Извлекает до 1000 последних записей из таблицы panel_logs (исключая тип epg), форматирует их и очищает таблицу.

Параметры:

  • $db — экземпляр Database (должен иметь методы ->query() и ->get_rows())

Возвращает:

[
    'errors'  => [
        [
            'type'       => string,  // тип записи
            'message'    => string,  // текст ошибки (экранирован)
            'file'       => string,  // дополнительный контекст (экранирован)
            'line'       => int,     // номер строки
            'date'       => int,     // UNIX timestamp
            'human_date' => string,  // читаемая дата в UTC
        ],
        // ...
    ],
    'version' => string,  // текущая версия XC_VM
]

Исключения: выбрасывает Exception при ошибке запроса к БД.

⚠️ Метод очищает таблицу panel_logs после чтения. Вызывайте только при намерении скачать и сбросить логи.


submitPanelLogs(object $db): array

Отправляет логи на удалённый сервер диагностики и очищает таблицу. Аналогичен downloadPanelLogs(), но данные передаются через HTTP.

Используется для автоматической отправки отчётов об ошибках в команду поддержки.


Структура panel_logs

Столбец Тип Описание
type string Тип события (error, warning, и т.д.)
log_message string Основное сообщение
log_extra string Дополнительный контекст (файл, трейс)
line int Номер строки кода
date int UNIX timestamp

Тип epg исключается из downloadPanelLogs() — EPG-логи имеют высокую частоту и отдельный инструмент просмотра.


Связанные файлы

Файл Назначение
src/core/Diagnostics/DiagnosticsService.php Основной класс диагностики
src/core/Logging/Logger.php Запись в panel_logs
src/core/Config/AppConfig.php Константа XC_VM_VERSION