Skip to content

docs: add infrastructure documentation — crash_recovery, data_integrity, monitoring, listener, checkpoint#14494

Draft
xingbowang wants to merge 1 commit intofacebook:mainfrom
xingbowang:navi/docs/09-infrastructure
Draft

docs: add infrastructure documentation — crash_recovery, data_integrity, monitoring, listener, checkpoint#14494
xingbowang wants to merge 1 commit intofacebook:mainfrom
xingbowang:navi/docs/09-infrastructure

Conversation

@xingbowang
Copy link
Copy Markdown
Contributor

crash_recovery/ (10 chapters)

MANIFEST recovery, WAL replay, recovery modes (kTolerateCorruptedTailRecords, kPointInTimeRecovery, best-efforts recovery), background error handling and auto-resume, RepairDB.

data_integrity/ (10 chapters)

Block checksums (CRC32c, xxHash, XXH3), WAL checksums, file checksums, per-key protection (kv checksum), handoff checksums, compaction output verification, unique file IDs, paranoid checks.

monitoring/ (11 chapters)

Statistics framework, PerfContext, IOStatsContext, DB properties, compaction stats, event logging, thread status.

listener/ (8 chapters)

EventListener callbacks, flush/compaction/error/stall/file operation notifications, external file ingestion events.

checkpoint/ (9 chapters)

Checkpoint (hard-link snapshots), BackupEngine, ExportColumnFamily, live file management.

Part 9 of 11 in the RocksDB AI documentation series.

…ty, monitoring, listener, checkpoint

crash_recovery/ (10 chapters): MANIFEST recovery, WAL replay, recovery modes
(kTolerateCorruptedTailRecords, kPointInTimeRecovery, best-efforts recovery),
background error handling and auto-resume, RepairDB.

data_integrity/ (10 chapters): Block checksums (CRC32c, xxHash, XXH3),
WAL checksums, file checksums, per-key protection (kv checksum), handoff
checksums, compaction output verification, unique file IDs, paranoid checks.

monitoring/ (11 chapters): Statistics framework, PerfContext, IOStatsContext,
DB properties, compaction stats, event logging, thread status.

listener/ (8 chapters): EventListener callbacks, flush/compaction/error/
stall/file operation notifications, external file ingestion events.

checkpoint/ (9 chapters): Checkpoint (hard-link snapshots), BackupEngine,
ExportColumnFamily, live file management.
@meta-cla meta-cla bot added the CLA Signed label Mar 23, 2026
@github-actions
Copy link
Copy Markdown

✅ clang-tidy: No findings on changed lines

Completed in 0.0s.

@xingbowang xingbowang marked this pull request as draft March 23, 2026 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant