Skip to content

Conversation

@majiayu000
Copy link

Summary

This PR fixes #2310

Changes

  • docs/README.md
  • docs/design/data-flow.md
  • docs/eBPF-cBPF-Overview.md

Add a new document explaining how DeepFlow uses both eBPF and cBPF
technologies for data collection. This addresses FR-016 by providing
clearer documentation for users with observability knowledge.

Changes:
- Add docs/eBPF-cBPF-Overview.md with detailed explanation of:
  - What cBPF and eBPF are and their differences
  - How DeepFlow uses each technology (Dispatcher vs EbpfCollector)
  - Data flow architecture diagrams
  - Supported protocols and probe types
  - Kernel requirements and compatibility
- Update docs/design/data-flow.md with introduction referencing
  the new documentation
- Update docs/README.md to include the new document

Fixes deepflowio#2310

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Signed-off-by: majiayu000 <1835304752@qq.com>
│ Stores in ClickHouse: │
│ • flow_metrics │
│ • flow_log (L4FlowLog, L7FlowLog) │
│ • profile │
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some flowcharts in this doc that are not properly aligned.

@sharang
Copy link
Member

sharang commented Jan 3, 2026

Thank you for your contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FR] FR-016: Clearer eBPF, cBPF documentation

2 participants