Spark Web API

Это компактный плагин, создающий веб-интерфейс для взаимодействия со Spark через API.

Плагин разработан специально для серверов Paper. Исходный код доступен на GitHub, где его можно адаптировать для других загрузчиков модификаций.

Установка

Для начала работы необходимо установить Spark на ваш Paper-сервер. Важно отметить, что даже в случае с версиями Minecraft 1.21 и новее, где функционал Spark встроен по умолчанию, всё равно потребуется отдельная версия плагина.

После этого можно приступать к установке Spark Web API. Рекомендуется скачивать версию JAR-файла с пометкой "-all" в названии.

При запуске сервера нужно активировать специальный системный параметр:

java -Dpaper.preferSparkPlugin=true -jar paper-1.21-129.jar

Настройка конфигурации

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

• номер порта для веб-сервера
• включение различных API-эндпоинтов
• дополнительные заголовки для ответов

Пример конфигурации:

port: 3000
routes:
  tps: true
  mspt: true
  sys_cpu: false
  proc_cpu: false
  gc: false
headers:
  enabled: false

Доступные API-маршруты

Эндпоинт /api/tps

Предоставляет информацию о значениях TPS за последние 10 секунд, 1 минуту, 5 минут и 15 минут.

Пример ответа:

{
  "tenSeconds": 19.999926688268733,
  "oneMinute": 20.000035730063832,
  "fiveMinutes": 20.00000458740105,
  "fifteenMinutes": 19.94021043987079
}

В случае ошибки получения данных возвращается код 500.

Эндпоинт /api/mspt

Возвращает показатели MSPT за 10 секунд и 1 минуту с подробной статистикой.

Пример ответа:

{
  "tenSeconds": {
    "min": 6.523605,
    "max": 2692.747083,
    "mean": 66.92731750515465,
    "median": 23.108289
  },
  "oneMinute": {
    "min": 6.523605,
    "max": 2692.747083,
    "mean": 66.92731750515465,
    "median": 23.108289
  }
}

Эндпоинт /api/gc

Отображает информацию о работе сборщика мусора с подробной статистикой по различным поколениям.

Пример ответа:

{
  "G1 Young Generation": {
    "name": "G1 Young Generation",
    "frequency": 22328,
    "avgTime": 81,
    "totalCollections": 3,
    "totalTime": 243
  },
  "G1 Old Generation": {
    "name": "G1 Old Generation",
    "frequency": 0,
    "avgTime": 0,
    "totalCollections": 0,
    "totalTime": 0
  }
}

Эндпоинт /api/cpu/sys

Предоставляет данные об общей загрузке процессора системы в процентном соотношении.

Пример ответа:

{
  "tenSeconds": 0.20461582280862525,
  "oneMinute": 0.31800215079510524,
  "fifteenMinutes": 0.39118254849183964
}

Эндпоинт /api/cpu/proc

Показывает нагрузку на процессор конкретно от процесса Minecraft.

Пример ответа:

{
  "tenSeconds": 0.025064927938294894,
  "oneMinute": 0.030417615615548597,
  "fifteenMinutes": 0.06684861042724896
}