spark-web-api для Minecraft: локальний веб-інспектор продуктивності сервера

При аналізі продуктивності серверів Minecraft за допомогою популярного профілювальника spark, за замовчуванням згенеровані звіти вивантажуються на публічний веб-сервіс spark.lucko.me. Проте для комерційних проектів, приватних мереж та великих серверних комплексів передача дампів пам'яті, списків плагінів та внутрішніх шляхiв файлової системи на сторонні ресурси є небажаною з міркувань безпеки та конфіденційності.

Розширення spark-web-api від розробника lucko дозволяє розгорнути власний автономний (Self-Hosted) веб-сервер для перегляду профілів spark безпосередньо у вашій локальній мережі або на власному домені. У цьому розширеному посібнику аналізуються можливості spark-web-api, детальний розбір конфігурації, налаштування безпеки та покрокова інструкція із запуску.

1. Навіщо потрібен spark-web-api та як він працює

Головний плагін spark вимірює навантаження на процесор (CPU), використання оперативної пам'яті (RAM), серверні такти (TPS) та виклики потоків Java.

Переваги використання spark-web-api:

1. Повна конфіденційність даних (Data Privacy):

   • Звіти профілювання містять назви файлів, версії плагінів, дампи потоків та UUID гравців. spark-web-api гарантує, що жоден байт цієї інформації не залишить ваш сервер.

2. Автономна робота без інтернет-з'єднання (Offline / Private Network):

   • Ідеально підходить для локальних тестових серверів або приватних корпоративних мереж без доступу до зовнішньої мережі Інтернет.

3. Власний брендований домен (Custom Domain & Base URL):

   • Адміністратор може налаштувати видачу посилань на власний веб-сайт (наприклад, https://spark.myserver.net/profile?id=xyz).

4. Контроль доступу та ключів API:

   • Обмеження перегляду звітів лише для авторизованого персоналу за допомогою ключів доступу чи авторизації.

2. Порівняння публічного переглядача та self-hosted spark-web-api

3. Детальний розбір конфігураційного файлу

Після встановлення розширення у папці plugins/spark/ або config/spark/ з'являються налаштування інтеграції з веб-сервером.

Ключові параметри конфігу spark-web-api:

{

"enabled": true,

"bind-address": "0.0.0.0",

"port": 8080,

"base-url": "http://spark.myserver.com:8080/",

"api-key": "secret-admin-token-12345",

"max-profiles-stored": 100

}

Розшифровка кожного параметра:

• enabled (true / false): Вмикає або вимикає локальний веб-сервер HTTP.

• bind-address: Мережевий інтерфейс для зв'язування (значення 0.0.0.0 дозволяє підключення з будь-якої IP-адреси, а 127.0.0.1 обмежує доступ лише локальним ПК).

• port: Порт HTTP-сервера за замовчуванням (наприклад, 8080 або 4567). Переконайтеся, що порт відкритий у фаєрволі.

• base-url: Шаблон посилання, яке відображатиметься у чаті гри при виконанні команди /spark profiler open. Вкажіть тут ваш домен або публічну IP-адресу з портом.

• api-key: Секретний токен для захисту REST API від несанкціонованого перегляду чужими користувачами.

• max-profiles-stored: Ліміт збережених файлів звітів .sparkprofile на диску перед їх автоматичною очисткою.

4. Покрокова інструкція зі встановлення та запуску

spark-web-api є розширенням для основного профілювальника spark, тому перед його запуском переконайтеся, що сам spark упевнено працює на вашому сервері.

Кроки зі встановлення:

1. Завантажте основний плагін/мод spark з Modrinth та помістіть його у папку plugins (для Paper) або mods (для Fabric/Forge).

2. Завантажте розширення spark-web-api з Modrinth.

3. Перемістіть завантажений файл у папку plugins або mods.

4. Перезапустіть сервер для генерації файлів конфігурації.

5. Відкрийте конфігураційний файл, вкажіть потрібний port та base-url.

6. Збережіть файл та виконайте команду перезавантаження /spark reload.

Перевірка роботи:

1. Виконай команду запису профілю: /spark profiler start.

2. Зачекайте 30–60 секунд та зупиніть запис: /spark profiler stop.

3. У чаті з'явиться посилання, що вказує на ваш власний веб-сервер. Натисніть на нього для відкриття інспектора у браузері.