refactor(eval): split correlation.rs into module directory#54
Merged
Conversation
Modularize the 1781-line correlation.rs into focused submodules for
maintainability. No behavior changes; identical test results
(366 unit tests pass).
New structure:
correlation/
mod.rs -- module wiring and public re-exports
types.rs -- compiled correlation types and conditions
keys.rs -- group key extraction
buffers.rs -- event buffers and references
window.rs -- window state and aggregation helpers
compiler.rs -- correlation rule compilation
tests.rs -- all unit tests
mostafa
added a commit
that referenced
this pull request
May 15, 2026
Both the ASCII diagram in README.md and the Mermaid diagram in
assets/architecture.mmd lagged the codebase by several releases. Update
them to reflect:
- Dynamic Sigma Pipelines (v0.10.0): new sources/ subsystem inside
rsigma-runtime with SourceResolver, TemplateExpander, SourceCache,
RefreshScheduler, extract languages (jq, JSONPath, CEL), and the
flow back into the eval pipeline via ${source.*} template expansion.
- Matcher optimizer and eval prefilters (v0.11.0): Aho-Corasick and
RegexSet batching plus CaseInsensitiveGroup inside compiler/, and
the prefilter layers (RuleIndex, bloom trigram filter, cross-rule
AC index via daachorse) inside engine/.
- DLQ as a sink target and broaden hot-reload to rules + pipelines.
- Builtin pipelines (ecs_windows, sysmon).
- Rename single-file module references (compiler.rs, engine.rs,
correlation.rs) to the directory module style that landed in the
v0.9.0 modularization PRs (#53, #54, #55).
- Add a legend explaining * = feature-gated and ** = requires the
daachorse-index feature.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
crates/rsigma-eval/src/correlation.rs(1781 lines) into acorrelation/module directory with focused submodules for types, keys, buffers, window state, compilation, and testsTest plan
cargo fmt --all -- --checkpassescargo clippy --workspace --all-targets --all-features -- -D warningspasses (zero warnings)cargo test -p rsigma-evalpasses (366 unit tests + 47 integration/doc tests, 0 failures)