Skip to content

Commit d7cecd3

Browse files
dmitriimaksimovdevelopclaude
dmitriimaksimovdevelop
and
claude
committed
docs: add All Chapters index page (EN + RU)
Complete table of contents with chapter descriptions. Grouped by: Getting Started, Analysis, Internals, Intelligence, Advanced, Operations, Reference. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1967a3d commit d7cecd3

2 files changed

Lines changed: 122 additions & 0 deletions

File tree

‎doc/en/00-chapters.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# All Chapters
2+
3+
Complete table of contents for the melisai documentation. 22 chapters covering Linux performance theory, melisai internals, and production tuning.
4+
5+
## Getting Started
6+
7+
| # | Chapter | What You'll Learn |
8+
|---|---------|-------------------|
9+
| — | [Quick Start](00-quickstart.md) | Install → run → read results → fix → verify. 2 minutes to first diagnosis |
10+
| 0 | [Introduction](00-introduction.md) | What melisai is, USE methodology, three-tier architecture, report structure |
11+
| 1 | [Linux Fundamentals](01-linux-fundamentals.md) | /proc, /sys, jiffies, CPU states, cgroups v1/v2, PSI, buddy allocator |
12+
13+
## Performance Analysis
14+
15+
| # | Chapter | What You'll Learn |
16+
|---|---------|-------------------|
17+
| 2 | [CPU Analysis](02-cpu-analysis.md) | Delta sampling, per-CPU breakdown, load average, CFS scheduler tuning |
18+
| 3 | [Memory Analysis](03-memory-analysis.md) | MemAvailable vs MemFree, vmstat, PSI, NUMA stats, swap, dirty pages |
19+
| 4 | [Disk I/O Analysis](04-disk-analysis.md) | /proc/diskstats, 512-byte sectors, I/O schedulers, queue depth |
20+
| 5 | [Network Analysis](05-network-analysis.md) | TCP stats, conntrack, softnet, IRQ distribution, NIC hardware, 30+ sysctls |
21+
| 6 | [Process Analysis](06-process-analysis.md) | Top-N by CPU/memory, /proc/[pid]/stat, FD counting, state tracking |
22+
| 7 | [Container Analysis](07-container-analysis.md) | K8s/Docker detection, cgroup v1/v2, CPU throttling, memory limits |
23+
24+
## Internals
25+
26+
| # | Chapter | What You'll Learn |
27+
|---|---------|-------------------|
28+
| 8 | [System Collector](08-system-collector.md) | OS detection, uptime, filesystems, block devices, dmesg parsing |
29+
| 9 | [BCC Tools](09-bcc-tools.md) | 67-tool registry, executor, security model, parsers, aggregation |
30+
| 10 | [Native eBPF](10-ebpf-native.md) | BTF/CO-RE, cilium/ebpf loader, Tier 3 strategy |
31+
| 15 | [Orchestrator](15-orchestrator.md) | Two-phase execution, parallel collectors, signal handling, profiles |
32+
| 16 | [Output Formats](16-output-formats.md) | JSON schema, atomic writes, FlameGraph SVG, progress reporter |
33+
34+
## Intelligence
35+
36+
| # | Chapter | What You'll Learn |
37+
|---|---------|-------------------|
38+
| 11 | [Anomaly Detection](11-anomaly-detection.md) | 37 threshold rules, rate-based detection, health score formula |
39+
| 12 | [Recommendations](12-recommendations.md) | 35 sysctl fixes, "fix" vs "optimization" types, evidence-based |
40+
| 13 | [AI Integration](13-ai-integration.md) | Dynamic prompt generation, 27 anti-patterns, MCP server setup |
41+
42+
## Advanced Topics
43+
44+
| # | Chapter | What You'll Learn |
45+
|---|---------|-------------------|
46+
| 18 | [GPU & PCIe Topology](18-gpu-pcie-analysis.md) | NVIDIA detection, PCI→NUMA mapping, cross-NUMA GPU-NIC pairs, GPUDirect |
47+
| 19 | [Page Reclaim & THP](19-page-reclaim-thp.md) | Watermarks, direct reclaim, compaction, THP defrag modes, tuning |
48+
| 20 | [NUMA Optimization](20-numa-optimization.md) | Distance matrix, miss ratio, numactl, K8s topology manager |
49+
50+
## Operations
51+
52+
| # | Chapter | What You'll Learn |
53+
|---|---------|-------------------|
54+
| 14 | [Report Diffing](14-report-diffing.md) | Before/after comparison, USE deltas, histogram changes |
55+
| 21 | [Production Checklist](21-production-checklist.md) | All sysctls in one place, one-liner tuning script, anomaly→fix mapping |
56+
57+
## Reference
58+
59+
| # | Chapter | What You'll Learn |
60+
|---|---------|-------------------|
61+
| 17 | [Appendix](17-appendix.md) | Glossary, /proc reference, /sys hierarchy, sysctl table, CLI reference |

‎doc/ru/00-chapters.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Все главы
2+
3+
Полное оглавление документации melisai. 22 главы — от теории производительности Linux до production-тюнинга.
4+
5+
## Начало работы
6+
7+
| # | Глава | Что узнаете |
8+
|---|-------|-------------|
9+
| — | [Быстрый старт](00-quickstart.md) | Установка → запуск → чтение → исправление → проверка. 2 минуты |
10+
| 0 | [Введение](00-introduction.md) | Что такое melisai, методология USE, трёхуровневая архитектура |
11+
| 1 | [Основы Linux](01-linux-fundamentals.md) | /proc, /sys, jiffies, состояния CPU, cgroups, PSI, buddy allocator |
12+
13+
## Анализ производительности
14+
15+
| # | Глава | Что узнаете |
16+
|---|-------|-------------|
17+
| 2 | [Анализ CPU](02-cpu-analysis.md) | Дельта-сэмплинг, per-CPU, load average, настройка CFS |
18+
| 3 | [Анализ памяти](03-memory-analysis.md) | MemAvailable, vmstat, PSI, NUMA, swap, dirty pages |
19+
| 4 | [Анализ дисков](04-disk-analysis.md) | /proc/diskstats, секторы 512 байт, планировщики I/O |
20+
| 5 | [Анализ сети](05-network-analysis.md) | TCP, conntrack, softnet, IRQ, NIC hardware, 30+ sysctls |
21+
| 6 | [Анализ процессов](06-process-analysis.md) | Top-N по CPU/памяти, /proc/[pid]/stat, FD, состояния |
22+
| 7 | [Анализ контейнеров](07-container-analysis.md) | K8s/Docker, cgroup v1/v2, CPU throttling, лимиты памяти |
23+
24+
## Внутреннее устройство
25+
26+
| # | Глава | Что узнаете |
27+
|---|-------|-------------|
28+
| 8 | [Системный коллектор](08-system-collector.md) | ОС, uptime, файловые системы, блочные устройства, dmesg |
29+
| 9 | [BCC инструменты](09-bcc-tools.md) | Реестр 67 инструментов, executor, безопасность, парсеры |
30+
| 10 | [Нативный eBPF](10-ebpf-native.md) | BTF/CO-RE, cilium/ebpf loader, стратегия Tier 3 |
31+
| 15 | [Оркестратор](15-orchestrator.md) | Двухфазный сбор, параллельные коллекторы, профили |
32+
| 16 | [Форматы вывода](16-output-formats.md) | JSON-схема, FlameGraph SVG, progress reporter |
33+
34+
## Интеллект
35+
36+
| # | Глава | Что узнаете |
37+
|---|-------|-------------|
38+
| 11 | [Обнаружение аномалий](11-anomaly-detection.md) | 37 пороговых правил, rate-based детекция, формула health score |
39+
| 12 | [Рекомендации](12-recommendations.md) | 35 sysctl-исправлений, типы "fix" и "optimization" |
40+
| 13 | [AI-интеграция](13-ai-integration.md) | Генерация промпта, 27 анти-паттернов, настройка MCP |
41+
42+
## Продвинутые темы
43+
44+
| # | Глава | Что узнаете |
45+
|---|-------|-------------|
46+
| 18 | [GPU и PCIe](18-gpu-pcie-analysis.md) | NVIDIA детекция, PCI→NUMA маппинг, cross-NUMA GPU-NIC, GPUDirect |
47+
| 19 | [Page Reclaim и THP](19-page-reclaim-thp.md) | Watermarks, direct reclaim, компакция, режимы THP defrag |
48+
| 20 | [Оптимизация NUMA](20-numa-optimization.md) | Матрица расстояний, miss ratio, numactl, K8s topology manager |
49+
50+
## Эксплуатация
51+
52+
| # | Глава | Что узнаете |
53+
|---|-------|-------------|
54+
| 14 | [Сравнение отчётов](14-report-diffing.md) | Before/after, дельты USE, изменения гистограмм |
55+
| 21 | [Чек-лист для production](21-production-checklist.md) | Все sysctls, скрипт тюнинга, маппинг аномалия→исправление |
56+
57+
## Справочник
58+
59+
| # | Глава | Что узнаете |
60+
|---|-------|-------------|
61+
| 17 | [Приложение](17-appendix.md) | Глоссарий, справка /proc, /sys, таблица sysctl, CLI |

0 commit comments

Comments
 (0)