Skip to content

docs(guides): add stream processing and aggregation framework guide#469

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-459-document-stream-processing-and-aggregation-framework
Feb 9, 2026
Merged

docs(guides): add stream processing and aggregation framework guide#469
kcenon merged 1 commit into
mainfrom
docs/issue-459-document-stream-processing-and-aggregation-framework

Conversation

@kcenon

@kcenon kcenon commented Feb 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/guides/STREAM_PROCESSING.md covering all 7 stream processing components
  • Comprehensive guide with architecture diagram, 4 usage examples, memory sizing guidelines
  • Complete configuration reference and error code appendices

Resolves #459
Part of documentation EPIC kcenon/common_system#325

What's Covered

Component Key Topics
Stream Aggregator Welford's algorithm, P2 quantile estimation, moving window, outlier detection
Aggregation Processor Multi-metric pipeline, aggregation rules, force_aggregation, standard rules factory
Time Series Dead-band compression, step-based querying, retention policies, factory pattern
Time Series Buffer Ring buffer-backed bounded storage, automatic statistics, load average history
Ring Buffer Lock-free CAS, cache-line aligned indices, overflow handling, batch operations
Statistics Engine Generic percentile computation, chrono duration support, in-place vs copy modes
Metric Storage Unified ring buffer ingestion + time series history, background flush thread

Test Plan

  • All 7 stream processing source files referenced and verified (9/9 PASS incl. internal + types)
  • All code examples compile-compatible with actual API signatures
  • Architecture diagram accurately reflects data flow
  • At least 3 usage examples included (4 provided)
  • Memory management patterns documented with sizing guidelines
  • Markdown renders correctly on GitHub
  • No broken internal links

…459)

Add docs/guides/STREAM_PROCESSING.md covering all 7 stream processing
components plus supporting types:

- Stream Aggregator: Welford's algorithm, P2 quantile estimation,
  moving window, outlier detection, Pearson correlation
- Aggregation Processor: multi-metric pipeline with storage integration
- Time Series: chronological storage with dead-band compression
- Time Series Buffer: ring buffer-backed bounded storage with statistics
- Ring Buffer: lock-free CAS implementation with cache-line alignment
- Statistics Engine: generic percentile computation with chrono support
- Metric Storage: unified ring buffer ingestion + time series history

Includes architecture diagram, 4 usage examples, memory sizing guide,
and complete configuration reference appendices.

Resolves #459
@kcenon kcenon merged commit 2fcf778 into main Feb 9, 2026
21 checks passed
@kcenon kcenon deleted the docs/issue-459-document-stream-processing-and-aggregation-framework branch February 9, 2026 04:36
kcenon added a commit that referenced this pull request Apr 13, 2026
…459) (#469)

Add docs/guides/STREAM_PROCESSING.md covering all 7 stream processing
components plus supporting types:

- Stream Aggregator: Welford's algorithm, P2 quantile estimation,
  moving window, outlier detection, Pearson correlation
- Aggregation Processor: multi-metric pipeline with storage integration
- Time Series: chronological storage with dead-band compression
- Time Series Buffer: ring buffer-backed bounded storage with statistics
- Ring Buffer: lock-free CAS implementation with cache-line alignment
- Statistics Engine: generic percentile computation with chrono support
- Metric Storage: unified ring buffer ingestion + time series history

Includes architecture diagram, 4 usage examples, memory sizing guide,
and complete configuration reference appendices.

Resolves #459
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: Document stream processing and aggregation framework

1 participant