Documentation

Interface terminale

Comprenez le modèle de focus de la TUI Vectron, les raccourcis clavier, le scope actif, la lecture live vs historique des logs, et les métriques.

Quand la TUI se lance

vectron start lance la TUI quand stdout est attaché à un terminal supporté. Sinon, Vectron revient au mode de sortie texte classique.

Les Deux Zones De Focus

La TUI comporte deux zones interactives:

  • Logs
  • Scope

Utilisez Tab pour basculer entre elles.

Scope est le panneau qui affiche:

  • Groups quand des groupes existent
  • Services quand il n’y a pas de groupes, ou après être entré dans un groupe

Seul le champ group d’un processus agit sur cette vue. Les labels de démarrage ne sont pas affichés comme groupes dans la TUI.

Le modèle clavier repose sur cette règle: les touches de navigation agissent sur la zone qui a le focus, et stop / play / restart agissent sur le scope actif actuellement affiché dans la TUI.

Comment Le Scope Actif Est Choisi

Les actions lifecycle utilisent le scope actif affiché dans la TUI:

  • quand le focus est sur Logs, le scope actif vient du filtre logs courant
  • quand le focus est sur Scope, le scope actif vient de la ligne sélectionnée
  • quand aucun filtre logs n’est actif, le scope côté logs est tout le workspace
  • en focus Scope, les actions lifecycle exigent une ligne sélectionnée et ne retombent pas sur le filtre logs

Exemples typiques:

  • Focus: Logs | Scope: all
  • Focus: Logs | Scope: proc:web
  • Focus: Scope | Scope: group:edge
  • Focus: Scope | Scope: inst:api#2

Vue Live Et Vue Historique

Le panneau Logs a deux modes visibles côté utilisateur:

  • live tail: le viewport suit l’arrivée des nouveaux logs
  • vue historique: le viewport est figé autour d’un log sélectionné

Vous entrez en vue historique quand vous sélectionnez un log, ouvrez les détails d’un log, sautez vers un résultat de recherche, ou sautez vers un log “error-ish”. Dans cet état, de nouveaux logs peuvent continuer à arriver, mais le viewport courant reste stable.

Ce viewport historique est ancré sur le log sélectionné. Si le wrapping change à cause d’un resize du terminal, Vectron re-ancre la vue autour de cette même sélection au lieu de revenir au tail.

Utilisez End ou G pour revenir à la live tail. Esc réinitialise aussi l’état courant des logs et revient au live.

Raccourcis Clavier

Global

  • q ou Ctrl+C: quitter ; si des processus tournent encore, Vectron les arrête d’abord
  • ?: ouvrir ou fermer l’aide
  • Tab: basculer entre Logs et Scope
  • Esc: fermer les overlays, annuler l’édition de recherche, effacer le filtre ou l’état actif, puis revenir sur Logs
  • m: activer ou désactiver les métriques CPU et RSS
  • Left: revenir de la vue Services d’un groupe vers Groups, quel que soit le focus

Logs

  • Up / k: sélectionner le log visible précédent
  • Down / j: sélectionner le log visible suivant
  • PageUp / Ctrl+B: remonter le viewport logs
  • PageDown / Ctrl+F: descendre le viewport logs
  • Home / g: aller au début du buffer de logs courant
  • End / G: revenir à la live tail et effacer l’état historique courant des logs
  • Space: mettre en pause ou reprendre les mises à jour live
  • [ / ]: aller au log “error-ish” précédent ou suivant
  • Enter: ouvrir ou fermer les détails du log sélectionné
  • Esc: effacer l’état courant des logs et revenir à la live tail Cela inclut le filtre actif, la sélection historique, la pause et le scrollback manuel.

Recherche

  • /: ouvrir la recherche
  • Enter: appliquer la requête courante
  • Esc: annuler l’édition de la recherche
  • n / N: résultat suivant ou précédent
  • Ctrl+L: effacer la recherche active

La navigation de recherche fait aussi entrer en vue historique: le viewport saute vers le log correspondant puis reste stable jusqu’à un retour explicite au live.

Scope

  • Up / k: monter dans la sélection
  • Down / j: descendre dans la sélection
  • PageUp / Ctrl+B: remonter d’une page
  • PageDown / Ctrl+F: descendre d’une page
  • Home / g: aller à la première ligne
  • End / G: aller à la dernière ligne
  • Enter: ouvrir le groupe sélectionné, ou filtrer les logs par processus depuis une ligne service
  • Shift+Enter / Ctrl+Enter: filtrer les logs par instance depuis une ligne service
  • Esc: effacer le filtre actif ou le contexte de scope ; si rien n’est actif, rendre le focus à Logs
  • s: arrêter le scope sélectionné
  • p: démarrer le scope sélectionné
  • r: redémarrer le scope sélectionné

Détails De Logs

  • cliquer sur une ligne de log, ou appuyer sur Enter sur le log sélectionné, ouvre les détails
  • Esc ou Enter: fermer la modale
  • Up / k: passer au log précédent en gardant la modale ouverte
  • Down / j: passer au log suivant en gardant la modale ouverte
  • PageUp / Ctrl+B: remonter dans le contenu courant des détails
  • PageDown / Ctrl+F: descendre dans le contenu courant des détails
  • Home / g: aller en haut de la vue détails
  • End / G: aller en bas de la vue détails
  • c: copier le message brut du log

c est réservé à la copie dans la modale de détails de logs. Il n’efface pas les filtres ni les sélections en mode normal.

Actions Lifecycle

Les touches lifecycle principales sont:

  • s: stop
  • p: play
  • r: restart

Ces touches agissent toujours sur le scope actif actuellement affiché dans la TUI. C’est pour cela que le rappel Focus / Scope est important: il indique explicitement ce qui sera affecté avant la frappe.

Métriques

La TUI peut afficher le CPU et le RSS agrégés par arbre de processus. Les seuils viennent de vectron.toml.

Utilisez m pour activer ou désactiver ces métriques pendant l’exécution de la TUI.

Utilisez vectron doctor ou vectron doctor tui pour inspecter le support terminal et les métriques.