Перейти к содержимому

Документация

Запуск за пять минут.

Всё, что нужно для установки Server Intelligence и начала понимания своего сервера.

Быстрый старт

Server Intelligence распространяется одним JAR-плагином, собранным под Paper API 1.21. Требуется Java 21. Spigot и Folia не проверялись.

  1. Положите плагин в папку plugins/ вашего сервера.
  2. Перезапустите сервер. Плагин зарегистрируется и начнёт запись.
  3. Создайте аккаунт и привяжите сервер токеном, который плагин выведет в консоль.
# консоль сервера после первого запуска
[ServerIntelligence] Recording started (async, sampling: default)
[ServerIntelligence] Claim token: SI-XXXX-XXXX-XXXX

Конфигурация

Каждый тип событий можно ограничить или отключить в config.yml. Значения по умолчанию разумны для серверов до нескольких сотен игроков онлайн.

# config.yml
sampling:
  block-break: normal     # low | normal | high | off
  movement: low
  chat: off               # никогда не записывается по умолчанию
retention:
  raw-events-days: 30
  aggregates-days: 730

Концепции

Сессии группируют непрерывную игру; AFK-время учитывается отдельно, чтобы бездействующие клиенты не раздували цифры. Когорты группируют игроков по неделе входа — так удобно сравнивать возвраты D1/D7/D30 во времени. Базлайны вычисляются для каждого сервера — оповещения о производительности срабатывают на отклонения от вашей нормы, а не от среднего по миру.

Данные и приватность

Содержание чата не записывается по умолчанию. Игрок может полностью исключить себя командой /si privacy opt-out. Сырые события удаляются по вашему расписанию; надолго остаются только агрегаты.

API (пока недоступен)

REST API только для чтения на тарифе Network запланирован, но не написан. Пример ниже показывает, какую форму он примет, чтобы вы могли оценить, подойдёт ли он вашей интеграции. Сегодня он не отвечает.

curl https://app.server-intelligence.xyz/api/v1/servers/{id}/retention \
  -H "Authorization: Bearer $SI_API_KEY"

Пока его нет, список игроков выгружается из панели в CSV. Плагин уже авторизуется ключом Bearer, когда пишет события, и чтение будет устроено так же.