Documentation / Vue d’ensemble
Index de la documentation
Documentation utilisateur de Perf Sentinel. Pour la documentation de conception approfondie destinée aux contributeurs, voir la documentation de conception.
Prise en main
| Document | Description |
|---|
| Architecture | Vue d'ensemble du pipeline, responsabilités des modules, types clés |
| Instrumentation | Configuration OTLP par langage : Java, Quarkus, .NET, Go, Python, Node.js, Rust, Ruby, PHP |
| CI | Mode CI, recettes GitHub Actions / GitLab CI / Jenkins, détection de régression sur PR |
Déploiement
| Document | Description |
|---|
| Intégration | Quatre topologies de déploiement (batch, sidecar, gateway, autonome) et démarrages rapides |
| Déploiement Helm | Déploiement Kubernetes via le chart Helm, référence des values, TLS, RBAC |
Référence
| Document | Description |
|---|
| Configuration | Référence complète .perf-sentinel.toml (seuils, détection, GreenOps, énergie broker, daemon) |
| Référence CLI | Référence des sous-commandes (analyze, watch, report, diff, query, ack, inspect, disclose, verify-hash) |
| Métriques | Métriques Prometheus exposées par le daemon sur /metrics |
| API de query | API HTTP du daemon (/api/findings, /api/correlations, /api/explain/{trace}, /api/status) |
| SARIF | Format de sortie SARIF v2.1.0 pour l'intégration IDE et GitHub Code Scanning |
| Schéma | Schéma JSON du rapport de divulgation périodique (perf-sentinel-report v1.5) |
Fonctionnalités
| Document | Description |
|---|
| Rapport HTML | Dashboard HTML autonome, mode live via --daemon-url, ack/revoke depuis le navigateur |
| Inspect (TUI) | TUI interactif : drill-down Analyze/Inspect/Explain (analyze --tui, inspect, explain --tui), flèches ou touches vim, ack/revoke |
| Acquittements | Format .perf-sentinel-acknowledgments.toml, signatures SHA-256, règles de filtrage |
| Flux d’acquittement | Workflow d'acquittement de bout en bout : API daemon, CLI, TUI et rapport HTML |
| Divulgation | Divulgation publique périodique via perf-sentinel disclose, versionnement du schéma, vérification de hash |
Exploitation
| Document | Description |
|---|
| Runbook | Runbook d'incident : dépannage orienté symptôme pour les déploiements en production |
| Énergie & carbone | Synthèse vulgarisée : comment les comptages deviennent des kWh et des gCO2, par option configurée, avec les sources |
| Méthodologie | Chaîne de calcul des traces vers efficiency_score, energy_kwh, carbon_kgco2eq |
| Types d'instance | Tous les instance_type portant un profil de puissance embarqué, avec leurs watts repos et max |
| Limites | Compromis connus, contraintes amont, limites de la détection |
Sécurité, chaîne d'approvisionnement et release
| Document | Description |
|---|
| Vue d’ensemble sécurité | Vue d'ensemble pour une revue de sécurité : flux réseau, contrôle d'accès, données stockées, durcissement, intégrité des releases |
| Chaîne d’appro. | Épinglage des entrées de build, signature Sigstore, provenance SLSA, chaîne verify-hash |
| Procédure de release | Procédure de release de bout en bout depuis la 0.7.0, gate lab de simulation, lockstep Helm |
