Documentation / Index design
Index de la documentation de conception
Documentation de conception approfondie de perf-sentinel. Ces documents expliquent pourquoi chaque décision a été prise, pas seulement ce que le code fait. Ils sont destinés aux contributeurs et mainteneurs qui ont besoin de comprendre les raisons derrière l'implémentation.
Pour la documentation orientée utilisateur, voir l'index de la documentation.
Table des matières
| Document | Sujets |
|---|---|
| 01 : Pipeline et types | Pipeline vs architecture hexagonale, chaîne de types, découpage en workspace, sortie déterministe, quality gate |
| 02 : Normalisation | Machine à états SQL, normaliseur HTTP, micro-optimisations (batch push, saut IN-list, UUID codé à la main) |
| 03 : Corrélation et streaming | Groupement batch par HashMap, cache LRU, buffer circulaire, éviction TTL, budget mémoire |
| 04 : Détection | Algorithmes de détection N+1, redondant et lent, clés empruntées, fenêtre basée sur les itérateurs, correctifs suggérés indexés par framework ou par broker |
| 05 : GreenOps et carbone | Formule IIS, dédup du ratio de gaspillage, conversion CO2, alignement SCI, attribution de l'énergie base de données et broker |
| 06 : Ingestion et daemon | Conversion OTLP, admission des spans messaging et résolution du lien producteur, boucle événementielle du daemon, échantillonnage, renforcement sécurité |
| 07 : CLI, config et release | Sous-commandes bench, query, report, diff. Sink dashboard HTML, export CSV, hash deep-link, modal cheatsheet, raccourcis clavier style vim. Parsing de la config, profil release, distribution |
| 08 : Rapport public périodique | Déterminisme du schéma jusqu'à v1.5, granularité G1/G2, validator collect-all, attribution par service, provenance mesurée/déclarée/estimée, writer d'archive daemon, dispatcher CLI disclose |
| 09 : Attribution carbone | Énergie + carbone par service au scoring, attribution de la région, précédence des modèles, branchement runtime-vs-proxy dans l'aggregator |
| 10 : Sigstore et SLSA | Predicate in-toto v1, flow signature Sigstore cosign, provenance SLSA Build L3 du binaire, chaîne verify-hash, privacy sur Rekor public |
Correspondance avec les fichiers source
| Fichier source | Document de conception |
|---|---|
lib.rs | 01 : Pipeline |
event.rs | 01 : Pipeline |
pipeline.rs | 01 : Pipeline |
quality_gate.rs | 01 : Pipeline |
explain.rs | 06 : Ingestion, 07 : CLI/Config |
diff.rs | 07 : CLI/Config |
synth.rs | 07 : CLI/Config |
http_client.rs | 06 : Ingestion |
time.rs | 06 : Ingestion |
acknowledgments.rs | 04 : Détection |
calibrate.rs | 05 : GreenOps |
shutdown.rs | 06 : Ingestion |
text_safety.rs | 07 : CLI/Config |
normalize/sql.rs | 02 : Normalisation |
normalize/http.rs | 02 : Normalisation |
normalize/mod.rs | 02 : Normalisation |
correlate/mod.rs | 03 : Corrélation |
correlate/window.rs | 03 : Corrélation |
detect/mod.rs | 04 : Détection |
detect/n_plus_one.rs | 04 : Détection |
detect/redundant.rs | 04 : Détection |
detect/slow.rs | 04 : Détection |
detect/fanout.rs | 04 : Détection |
detect/chatty.rs | 04 : Détection |
detect/pool_saturation.rs | 04 : Détection |
detect/serialized.rs | 04 : Détection |
detect/sanitizer_aware.rs | 04 : Détection |
detect/suggestions/ | 04 : Détection |
score/mod.rs | 05 : GreenOps, 09 : Attribution carbone |
score/carbon.rs | 05 : GreenOps |
score/carbon_compute.rs | 05 : GreenOps, 09 : Attribution carbone |
score/region_breakdown.rs | 05 : GreenOps |
score/carbon_profiles.rs | 05 : GreenOps |
score/energy_state.rs | 05 : GreenOps |
score/prom_parser.rs | 05 : GreenOps |
score/ops_snapshot_diff.rs | 05 : GreenOps |
score/broker_static.rs | 05 : GreenOps |
score/canonical.rs | 08 : Transparence périodique |
score/alumet/ | 05 : GreenOps, 09 : Attribution carbone |
score/scaphandre/ | 05 : GreenOps, 09 : Attribution carbone |
score/kepler/ | 05 : GreenOps, 09 : Attribution carbone |
score/redfish/ | 05 : GreenOps, 09 : Attribution carbone |
score/cloud_energy/ | 05 : GreenOps, 09 : Attribution carbone |
score/electricity_maps/ | 05 : GreenOps, 09 : Attribution carbone |
ingest/mod.rs | 06 : Ingestion |
ingest/json.rs | 06 : Ingestion |
ingest/otlp/ | 06 : Ingestion |
ingest/pg_stat.rs | 06 : Ingestion |
ingest/jaeger.rs | 06 : Ingestion |
ingest/zipkin.rs | 06 : Ingestion |
ingest/tempo.rs | 06 : Ingestion |
ingest/jaeger_query.rs | 06 : Ingestion |
ingest/auth_header.rs | 06 : Ingestion |
ingest/mysql_stat.rs | 06 : Ingestion |
ingest/lookback.rs | 06 : Ingestion |
ingest/url_enc.rs | 06 : Ingestion |
daemon/mod.rs | 06 : Ingestion |
daemon/event_loop.rs | 06 : Ingestion |
daemon/listeners.rs | 06 : Ingestion |
daemon/tls.rs | 06 : Ingestion |
daemon/json_socket.rs | 06 : Ingestion |
daemon/sampling.rs | 06 : Ingestion |
daemon/findings_store.rs | 06 : Ingestion |
daemon/query_api/ | 06 : Ingestion |
daemon/ack.rs | 06 : Ingestion |
daemon/mem_pressure.rs | 06 : Ingestion |
config/ (mod, raw, validate) | 07 : CLI/Config, 08 : Rapport périodique |
report/mod.rs, json.rs | 01 : Pipeline |
report/html/ | 07 : CLI/Config |
report/metrics.rs | 06 : Ingestion |
report/interpret.rs | 07 : CLI/Config |
report/warnings.rs | 07 : CLI/Config |
report/sarif.rs | 07 : CLI/Config |
report/periodic/* | 08 : Rapport périodique |
daemon/archive.rs | 08 : Rapport périodique |
sentinel-cli/src/main.rs | 07 : CLI/Config |
sentinel-cli/src/disclose.rs | 08 : Rapport périodique |
sentinel-cli/src/tui/ | 07 : CLI/Config |
detect/correlate_cross.rs | 04 : Détection |