agnes-the-ai-analyst/dev_docs
Vojtech 38f6b639d2
feat(observability): request_id end-to-end + dev debug toolbar + centralized logging (#136)
Cuts release 0.20.0.

## Highlights
- X-Request-ID header on every response + sanitized to [A-Za-z0-9_-] (CRLF log-forging mitigation)
- Error pages (HTML + JSON 500) surface request_id for support tickets
- Dev debug toolbar gated by DEBUG=1 — fastapi-debug-toolbar with custom DuckDBPanel
- Centralized app.logging_config.setup_logging() replaces 23 scattered basicConfig calls
- Telegram bot drops bot.log file — stdout only (BREAKING)

## Devin findings addressed
- BUG_0001: .env.template no longer claims FastAPI debug=True
- BUG_0002: subprocess extractor logs INFO to stderr again
- ANALYSIS_0003: _wants_html no longer matches Accept: */* (curl gets JSON as before)
- BUG on b1c6ee9: HTML 500 page no longer leaks str(exc) in production
- BUG on b13d2fe: 2 CLAUDE.md compliance flags (transform.py + ws_gateway) accepted as scope-limited logging refactor — follow-up to update CLAUDE.md if needed

See CHANGELOG [0.20.0] for full notes.
2026-04-29 22:54:21 +02:00
..
design-system.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
desktop-app.md Update paths in docs and sudoers after services/ extraction 2026-03-09 13:02:13 +01:00
disaster-recovery.md docs: update stale v1 docs to v2 Docker/FastAPI/DuckDB architecture 2026-04-09 18:44:25 +02:00
insights.md chore: clean repo for public release — fix references, remove drafts 2026-04-08 19:27:25 +02:00
README.md docs: update references to deleted files 2026-04-09 17:15:19 +02:00
security.md Update paths in docs and sudoers after services/ extraction 2026-03-09 13:02:13 +01:00
server.md docs: update stale v1 docs to v2 Docker/FastAPI/DuckDB architecture 2026-04-09 18:44:25 +02:00
session_explore.md Security fixes: sanitize dev_docs, harden sudoers and config validation 2026-03-09 08:06:45 +01:00
telegram_bot.md feat(observability): request_id end-to-end + dev debug toolbar + centralized logging (#136) 2026-04-29 22:54:21 +02:00

Developer Documentation

This folder contains documentation for developers and server administrators only.

⚠️ This folder is NOT synced to analyst machines - it stays on the server and in the git repository only.

Contents

Server Administration

  • server.md - Data broker server configuration and management
  • disaster-recovery.md - Recovery procedures for server failures
  • security.md - Security audit report and hardening guidelines
  • jira.md - Jira webhook integration and server-side processing

Application Development

  • desktop-app.md - macOS desktop app architecture and development
  • telegram_bot.md - Telegram notification bot technical docs
  • design-system.md - UI/UX design system for web applications
  • insights.md - Activity Center dashboard feature documentation

Planning & Meetings

  • meetings/ - Meeting transcripts, summaries, and notes

For Analysts

If you're an analyst looking for documentation on how to use the platform, see the docs/ folder instead:

  • docs/GETTING_STARTED.md - Quick start guide
  • docs/data_description.md - Data schemas and table definitions
  • docs/metrics/ - Business metric definitions
  • docs/jira_schema.md - Jira data schema reference
  • docs/notifications.md - How to use Telegram notifications in your scripts