Документація Власники

Довідник конфігурації

Повний технічний опис параметрів Агента LeavePulse: ідентифікатори, інтервали телеметрії, налаштування шлюзу та інтеграції.

На цій сторінці
  1. Основні параметри
  2. Секція ingest (HTTP)
  3. Секція gateway (WebSocket)
  4. Телеметрія (telemetry)
  5. Передача через проксі (backend_relay)
  6. Авторизація у грі (game_auth)
  7. Автоматичне оновлення (auto_update)
  8. Сповіщення про прив'язку (linking.join_notify)

Агент LeavePulse використовує файл leavepulse-verified.yaml (або .toml / .json) для збереження стану та налаштувань. Більшість полів заповнюються автоматично після виконання команди /leavepulse connect.

Основні параметри

КлючТипЗа замовчуваннямОпис
enabledbooleantrueУвімкнути/вимкнути роботу Агента та відправку метрик.
server_idlong0Унікальний ID сервера в каталозі LeavePulse.
project_idlong0ID проєкту, до якого належить сервер.
environment_idlong0ID зареєстрованого середовища (встановлюється після enroll).

Секція ingest (HTTP)

Використовується для початкової відправки метрик та подій входу/виходу гравців через REST API.

  • base_url: https://api.leavepulse.com — адреса API.
  • interval_seconds: 0 — інтервал періодичної відправки (0 — вимкнено, пріоритет у шлюзу).
  • send_on_player_events: true — миттєва відправка при вході/виході гравця.
  • event_min_interval_seconds: 8 — захист від частих запитів (debounce).
  • buffer_max_mb: 10 — розмір буфера на диску для збереження метрик при відсутності інтернету.

Секція gateway (WebSocket)

Основний канал зв'язку для живих функцій (вайтлист, команди, синхронізація).

  • ws_url: wss://agents.leavepulse.com — адреса шлюзу.
  • reconnect_max_seconds: 30 — максимальна затримка перед повторним підключенням.
  • bootstrap_stable_seconds: 12 — час стабільного з'єднання перед початком синхронізації ролей (наприклад, з LuckPerms).

Телеметрія (telemetry)

Визначає, як часто Агент збирає та надсилає різні типи даних.

  • warm_interval_seconds: 30 — для даних, що часто змінюються (TPS, RAM, кількість гравців).
  • cold_interval_seconds: 300 — для стабільніших даних (версія Minecraft, плагіни).
  • static_interval_seconds: 1800 — для статичних даних (інформація про JVM, ОС).

Передача через проксі (backend_relay)

Налаштування для Velocity або BungeeCord, що дозволяють бачити сервери за проксі без встановлення на них окремих Агентів.

  • enabled: true — увімкнути режим реле.
  • auto_match: true — автоматично зіставляти назви серверів у конфігу проксі з назвами в LeavePulse.
  • mapping: Ручне зіставлення, якщо назви відрізняються.
    yaml
    mapping:
      lobby_01: 12345
      survival_pro: 67890
    

Авторизація у грі (game_auth)

Корисно для офлайн-серверів як додатковий рівень захисту (PIN-код).

  • enabled: false — увімкнути запит PIN-коду при вході.
  • trust_minutes: 30 — час довіри до IP після успішного входу.
  • kick_on_timeout_seconds: 60 — час на введення PIN-коду до відключення гравця.

Автоматичне оновлення (auto_update)

  • channel: stable — канал оновлень.
  • auto_download: true — автоматичне завантаження.
  • apply_on_restart: true — встановлення при перезавантаженні.
  • allow_major: false — чи дозволяти автоматичний перехід на нову мажорну версію (наприклад, з 1.x на 2.x).

Сповіщення про прив'язку (linking.join_notify)

  • enabled: false — нагадувати гравцям про необхідність прив'язки акаунта при вході.
  • mode: always або whitelist_only (тільки якщо гравець має подати заявку).
  • delay_seconds: 3 — затримка перед показом повідомлення.