WFGY/ProblemMap/GlobalFixMap/Governance/audit_and_logging.md
2025-09-05 10:53:14 +08:00

128 lines
7.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Audit and Logging — Guardrails and Fix Pattern
<details>
<summary><strong>🧭 Quick Return to Map</strong></summary>
<br>
> You are in a sub-page of **Governance**.
> To reorient, go back here:
>
> - [**Governance** — policy enforcement and compliance controls](./README.md)
> - [**WFGY Global Fix Map** — main Emergency Room, 300+ structured fixes](../README.md)
> - [**WFGY Problem Map 1.0** — 16 reproducible failure modes](../../README.md)
>
> Think of this page as a desk within a ward.
> If you need the full triage and all prescriptions, return to the Emergency Room lobby.
</details>
This page defines **auditability standards** for AI pipelines.
Without consistent logging, you cannot prove compliance, detect drift, or reproduce failures.
Use this guide to lock observability into ingestion, retrieval, reasoning, and generation steps.
---
## When to use this page
- You need verifiable traces for legal, regulatory, or enterprise compliance.
- Investigations require replay of a user query and its retrieval sources.
- You must detect hallucinations or drift in production runs.
- Customers or auditors ask for explainability and reproducibility.
---
## Acceptance targets
- Logs capture ΔS and λ states at every RAG/reasoning step.
- ≥ 95% of user queries have matching citation and snippet logs.
- Audit trail includes source corpus, license_id, and index version.
- Drift alerts trigger when ΔS ≥ 0.60 or λ flips divergent across seeds.
- Replay is possible within 5 minutes for any production query.
---
## Common failures → exact fixes
| Symptom | Likely cause | Open this |
|---------|--------------|-----------|
| Retrieval answers not reproducible | no snippet_id trace | [retrieval-traceability.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/retrieval-traceability.md) |
| Citations missing or out of sync | no schema contract in logs | [data-contracts.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/data-contracts.md) |
| No evidence of dataset license in audit | ingestion lacks rights metadata | [license_and_dataset_rights.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/Governance/license_and_dataset_rights.md) |
| ΔS or λ not recorded | metrics missing in pipeline | [deltaS_thresholds.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/Eval/deltaS_thresholds.md), [lambda_observe.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/GlobalFixMap/Eval/lambda_observe.md) |
| Drift appears only in production, not tests | no live probes | [live_monitoring_rag.md](https://github.com/onestardao/WFGY/blob/main/ProblemMap/ops/live_monitoring_rag.md) |
---
## Fix in 60 seconds
1. **Traceability schema**
Require `snippet_id, section_id, source_url, offsets, tokens` in every retrieval log.
2. **Metrics capture**
Record ΔS and λ per retrieval and reasoning step.
3. **Rights + versioning**
Always log `license_id`, `rights_holder`, and `index_hash`.
4. **Live probes**
Stream ΔS ≥ 0.60 alerts to monitoring dashboards.
5. **Replayable store**
Store logs in immutable KV or append-only DB. Replay query with same index_hash.
---
## Minimal audit checklist
- [ ] Logs stored in append-only or write-once medium.
- [ ] Each retrieval step includes ΔS, λ, snippet schema.
- [ ] Each generation step includes citations and source anchors.
- [ ] Expired datasets flagged in logs.
- [ ] Replay command tested weekly.
---
### 🔗 Quick-Start Downloads (60 sec)
| Tool | Link | 3-Step Setup |
|------|------|--------------|
| **WFGY 1.0 PDF** | [Engine Paper](https://github.com/onestardao/WFGY/blob/main/I_am_not_lizardman/WFGY_All_Principles_Return_to_One_v1.0_PSBigBig_Public.pdf) | 1⃣ Download · 2⃣ Upload to your LLM · 3⃣ Ask “Answer using WFGY + \<your question>” |
| **TXT OS (plain-text OS)** | [TXTOS.txt](https://github.com/onestardao/WFGY/blob/main/OS/TXTOS.txt) | 1⃣ Download · 2⃣ Paste into any LLM chat · 3⃣ Type “hello world” — OS boots instantly |
---
### 🧭 Explore More
| Module | Description | Link |
|-----------------------|----------------------------------------------------------|----------|
| WFGY Core | WFGY 2.0 engine is live: full symbolic reasoning architecture and math stack | [View →](https://github.com/onestardao/WFGY/tree/main/core/README.md) |
| Problem Map 1.0 | Initial 16-mode diagnostic and symbolic fix framework | [View →](https://github.com/onestardao/WFGY/tree/main/ProblemMap/README.md) |
| Problem Map 2.0 | RAG-focused failure tree, modular fixes, and pipelines | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/rag-architecture-and-recovery.md) |
| Semantic Clinic Index | Expanded failure catalog: prompt injection, memory bugs, logic drift | [View →](https://github.com/onestardao/WFGY/blob/main/ProblemMap/SemanticClinicIndex.md) |
| Semantic Blueprint | Layer-based symbolic reasoning & semantic modulations | [View →](https://github.com/onestardao/WFGY/tree/main/SemanticBlueprint/README.md) |
| Benchmark vs GPT-5 | Stress test GPT-5 with full WFGY reasoning suite | [View →](https://github.com/onestardao/WFGY/tree/main/benchmarks/benchmark-vs-gpt5/README.md) |
| 🧙‍♂️ Starter Village 🏡 | New here? Lost in symbols? Click here and let the wizard guide you through | [Start →](https://github.com/onestardao/WFGY/blob/main/StarterVillage/README.md) |
---
> 👑 **Early Stargazers: [See the Hall of Fame](https://github.com/onestardao/WFGY/tree/main/stargazers)** —
> Engineers, hackers, and open source builders who supported WFGY from day one.
> <img src="https://img.shields.io/github/stars/onestardao/WFGY?style=social" alt="GitHub stars"> ⭐ [WFGY Engine 2.0](https://github.com/onestardao/WFGY/blob/main/core/README.md) is already unlocked. ⭐ Star the repo to help others discover it and unlock more on the [Unlock Board](https://github.com/onestardao/WFGY/blob/main/STAR_UNLOCKS.md).
<div align="center">
[![WFGY Main](https://img.shields.io/badge/WFGY-Main-red?style=flat-square)](https://github.com/onestardao/WFGY)
&nbsp;
[![TXT OS](https://img.shields.io/badge/TXT%20OS-Reasoning%20OS-orange?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS)
&nbsp;
[![Blah](https://img.shields.io/badge/Blah-Semantic%20Embed-yellow?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlahBlahBlah)
&nbsp;
[![Blot](https://img.shields.io/badge/Blot-Persona%20Core-green?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlotBlotBlot)
&nbsp;
[![Bloc](https://img.shields.io/badge/Bloc-Reasoning%20Compiler-blue?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlocBlocBloc)
&nbsp;
[![Blur](https://img.shields.io/badge/Blur-Text2Image%20Engine-navy?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlurBlurBlur)
&nbsp;
[![Blow](https://img.shields.io/badge/Blow-Game%20Logic-purple?style=flat-square)](https://github.com/onestardao/WFGY/tree/main/OS/BlowBlowBlow)
&nbsp;
</div>