Skip to content

docs(guides): add storage backend implementation guide#467

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-457-create-storage-backend-implementation-guide
Feb 9, 2026
Merged

docs(guides): add storage backend implementation guide#467
kcenon merged 1 commit into
mainfrom
docs/issue-457-create-storage-backend-implementation-guide

Conversation

@kcenon

@kcenon kcenon commented Feb 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/guides/STORAGE_BACKENDS.md covering the complete storage subsystem
  • Document dual interface architecture (storage_backend + snapshot_storage_backend)
  • Detail all 10 backend types across 4 categories: memory, file (JSON/binary/CSV), database (SQLite/PostgreSQL/MySQL), cloud (S3/GCS/Azure Blob)
  • Include backend comparison matrix with decision guide
  • Document configuration validation, retention policies, and capacity sizing
  • Provide custom backend implementation guide with Redis example
  • Include 4 configuration examples: tiered storage, development, PostgreSQL production, cloud archival

Resolves #457

Test Plan

  • All 4 referenced source files exist and paths are correct
    • storage_backends.h, monitoring_core.h, result_types.h, error_codes.h
  • Backend types match actual storage_backend_type enum values
    • All 10 types documented: memory_buffer, file_json, file_binary, file_csv, database_sqlite, database_postgresql, database_mysql, cloud_s3, cloud_gcs, cloud_azure_blob ✓
  • Interface methods match actual source signatures
    • snapshot_storage_backend: store, retrieve, retrieve_range, size, capacity, flush, clear, get_stats ✓
    • storage_backend: store, retrieve, retrieve_range, capacity, size, clear, flush ✓
  • Document covers all 4 acceptance criteria from issue
    1. All backends documented with configuration (Section 4, all 10 types) ✓
    2. Comparison table with selection criteria (Section 3) ✓
    3. Retention and cleanup policies documented (Section 5) ✓
    4. Custom backend implementation guide (Section 6, Redis example) ✓
  • Cross-references to other guides are valid
    • COLLECTOR_DEVELOPMENT.md, EXPORTER_DEVELOPMENT.md, ARCHITECTURE.md ✓

Document the complete storage subsystem covering:
- Dual interface architecture (storage_backend + snapshot_storage_backend)
- All 10 backend types across 4 categories (memory, file, database, cloud)
- Backend comparison matrix with selection decision guide
- Configuration per backend with validation rules
- Retention and cleanup policies with capacity sizing guidelines
- Custom backend implementation guide with Redis example
- 4 configuration examples (tiered, development, PostgreSQL, cloud)

Resolves #457
@kcenon kcenon merged commit a563d35 into main Feb 9, 2026
21 checks passed
@kcenon kcenon deleted the docs/issue-457-create-storage-backend-implementation-guide branch February 9, 2026 02:05
kcenon added a commit that referenced this pull request Apr 13, 2026
Document the complete storage subsystem covering:
- Dual interface architecture (storage_backend + snapshot_storage_backend)
- All 10 backend types across 4 categories (memory, file, database, cloud)
- Backend comparison matrix with selection decision guide
- Configuration per backend with validation rules
- Retention and cleanup policies with capacity sizing guidelines
- Custom backend implementation guide with Redis example
- 4 configuration examples (tiered, development, PostgreSQL, cloud)

Resolves #457
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.

[Task] docs: Create storage backend implementation guide

1 participant