LeavePulse
Documentation Owners

Référence de Configuration

Description technique complète des paramètres de l'Agent LeavePulse : identifiants, intervalles de télémétrie, paramètres de passerelle et intégrations.

Sur cette page
  1. Paramètres de Base
  2. Section ingest (HTTP)
  3. Section gateway (WebSocket)
  4. Télémétrie (telemetry)
  5. Relais Proxy (backend_relay)
  6. Authentification en jeu (game_auth)
  7. Mise à jour automatique (auto_update)
  8. Notifications de liaison (linking.join_notify)

L'Agent LeavePulse utilise un fichier leavepulse-verified.yaml (ou .toml / .json) pour stocker l'état et les paramètres. La plupart des champs sont remplis automatiquement après l'exécution de la commande /leavepulse connect.

Paramètres de Base

CléTypePar défautDescription
enabledbooleantrueActiver/désactiver l'Agent et le rapport de métriques.
server_idlong0ID unique du serveur dans le catalogue LeavePulse.
project_idlong0ID du projet auquel appartient le serveur.
environment_idlong0ID de l'environnement enregistré (défini après enroll).

Section ingest (HTTP)

Utilisée pour le rapport initial des métriques et les événements de connexion via l'API REST.

  • base_url : https://api.leavepulse.com — Adresse de l'API.
  • interval_seconds : 0 — Intervalle d'envoi périodique (0 для вимкнення, la passerelle est prioritaire).
  • send_on_player_events : true — Envoi instantané lors de la connexion/déconnexion d'un joueur.
  • event_min_interval_seconds : 8 — Protection contre les envois trop fréquents (debounce).
  • buffer_max_mb : 10 — Taille du tampon sur disque pour le stockage hors ligne.

Section gateway (WebSocket)

Canal principal pour les fonctionnalités en direct (whitelist, commandes, synchronisation).

  • ws_url : wss://agents.leavepulse.com — Adresse de la passerelle.
  • reconnect_max_seconds : 30 — Délai maximum de reconnexion.
  • bootstrap_stable_seconds : 12 — Temps de connexion stable requis avant le démarrage de la synchronisation (ex: LuckPerms).

Télémétrie (telemetry)

Définit la fréquence à laquelle l'Agent collecte et envoie différents types de données.

  • warm_interval_seconds : 30 — Données à changement rapide (TPS, RAM, joueurs).
  • cold_interval_seconds : 300 — Données stables (version Minecraft, plugins).
  • static_interval_seconds : 1800 — Données statiques (JVM, OS).

Relais Proxy (backend_relay)

Paramètres pour Velocity або BungeeCord afin de relayer les données des serveurs backend.

  • enabled : true — Activer le mode relais.
  • auto_match : true — Mise en correspondance automatique des noms de serveurs.
  • mapping : Mappage manuel si les noms diffèrent.
    yaml
    mapping:
  lobby_01: 12345
  survival_pro: 67890

Authentification en jeu (game_auth)

Utile pour les serveurs en mode hors ligne (offline-mode) comme couche de sécurité supplémentaire (code PIN).

  • enabled : false — Activer la demande de PIN à la connexion.
  • trust_minutes : 30 — Durée de confiance de l'IP après connexion réussie.
  • kick_on_timeout_seconds : 60 — Temps pour entrer le PIN avant l'expulsion.

Mise à jour automatique (auto_update)

  • channel : stable — Canal de mise à jour.
  • auto_download : true — Téléchargement automatique.
  • apply_on_restart : true — Installation au prochain redémarrage.
  • allow_major : false — Autoriser le passage automatique aux versions majeures.

Notifications de liaison (linking.join_notify)

  • enabled : false — Rappeler aux joueurs non liés de lier leur compte.
  • mode : always або whitelist_only.
  • delay_seconds : 3 — Délai avant l'affichage du message.