mirror of
https://github.com/taylanbakircioglu/flowfish.git
synced 2026-09-17 08:05:09 +00:00
taylanbakircioglu
22c32ea18f
README content - Expand the eBPF data-collection section into L4 (Inspektor Gadget) and L7 (Beyla + flowfish-l7-collector) subsections - Add three L7 deep-dive sections: Service Map, Distributed Tracing & Trace Explorer, APM Services & RED Metrics - Add a "Why Flowfish?" highlights bullet list, a Production Readiness Checklist, and a Further Reading section - Refresh System Architecture / Data Collection Flow ASCII diagrams to include the L7 path (Beyla -> flowfish-l7-collector -> l7-ingestion-service -> RabbitMQ flowfish.l7.*) - Update API Reference, Data Architecture, Project Structure, and Backend Environment Variables to reflect the dual-agent (L4 + L7) setup - Add troubleshooting entries for Beyla DaemonSet, L7 Service Map, and missing trace_id - Simplify verbose detail throughout: collapse repeated phrasing, trim implementation-level file paths and code expressions, keep claims that are verified against the codebase Discovery section reordering - Place Service Map immediately after Dependency Map / Focus Mode so the maps are introduced back-to-back; move Network Explorer (tabular view) to the end of the section Screenshots - Refresh new-analysis-1.png with an L7-aware version (shows the L4 / L7 / Both Analysis Level selector and the updated sidebar with Service Map, Trace Explorer, and APM Services) - Drop the redundant analysis-new-1.png: the new Entry Point screenshot already covers Basic Information in its current form, and the old shot is stuck in a pre-L7 state (L4-only tagline, pre-L7 sidebar)
🐟 Flowfish Documentation
This directory contains all project documentation organized by category.
📁 Directory Structure
/architecture/ - Architecture & Design Documents
Technical architecture, system design, and integration details.
🎯 Start Here (Architecture Overview)
- ARCHITECTURE_QUICK_REF.md - One-page architecture diagram & port reference
- ARCHITECTURE_SIMPLE.md - Simple data flow diagram with service summary
- ARCHITECTURE_DETAILED.md - Complete layered architecture with sequences
Detailed Documentation
- MICROSERVICES_ARCHITECTURE.md - Microservices architecture overview
- ENTERPRISE_MULTI_CLUSTER.md - Multi-cluster enterprise architecture
- RABBITMQ_INTEGRATION.md - RabbitMQ message queue integration
- INSPECTOR_GADGET_EVENTS.md - Inspektor Gadget event types
- HYBRID_STORAGE_ARCHITECTURE.md - Storage strategy (ClickHouse + Neo4j)
- MICROSERVICES_NAMES.md - Service naming conventions
- change-detection-worker.md - Change Detection Worker (scalable microservice)
/sprints/ - Sprint Plans & Roadmaps
Sprint planning, task breakdown, and development roadmaps.
- Sprint plans coming soon...
/analysis/ - Analysis & Status Reports
Project status, integration reports, and analysis documents.
- INTEGRATION_STATUS.md - Current integration status
- MODERNIZATION_SUMMARY.md - UI/UX modernization summary
/guides/ - User & Developer Guides
How-to guides, tutorials, and best practices.
- Guides coming soon...
Root Level Documents
Core project documentation that lives in the repository root:
- 01-executive-summary.md - Project overview and goals
- 02-feature-list.md - Detailed feature list by phase
- 03-architecture.md - High-level architecture
- 04-technology-stack.md - Technology choices and rationale
- 05-scalability.md - Scalability approach
- 06-security.md - Security design
- 07-roadmap.md - Project roadmap
📋 Quick Links
For Developers
- 🎯 Architecture Quick Reference - Start here!
- Simple Architecture Diagram
- Detailed Architecture
- Microservices Architecture
- Getting Started
- Local Development
For DevOps
For Project Managers
🔄 Document Status
| Category | Status | Last Updated |
|---|---|---|
| Architecture | ✅ Up to date | 2025-01-08 |
| Sprints | 🔴 Pending | - |
| Analysis | ✅ Up to date | 2024-11-21 |
| Guides | 🔴 Pending | - |
| Core Docs | ✅ Up to date | 2025-01-08 |
Note: This documentation structure follows best practices for organizing technical documentation in large projects.