rsigma engine eval🔗
One-shot evaluation of Sigma rules against events from a file, stdin, or an inline argument.
Synopsis🔗
Description🔗
Loads rules from a file or directory, optionally applies one or more processing pipelines, reads events from --event (or stdin), and writes matched MatchResult JSON to stdout. Exits when the event source is exhausted.
This is the right tool for CI fixtures, ad-hoc threat hunting, forensic replay over .evtx and NDJSON files, and any "run rules against this data, then exit" workflow. For a long-running daemon with hot-reload and metrics, use engine daemon.
For a narrative tutorial see Evaluating Rules.
Flags🔗
Required🔗
| Flag | Description |
|---|---|
-r, --rules <RULES> | Path to a Sigma rule file or directory of rules (recursive). May also be supplied via eval.rules in a config file. |
Configuration🔗
| Flag | Default | Description |
|---|---|---|
--config <PATH> | unset | Load a specific YAML config file instead of running the discovery chain. CLI flags still take precedence over file values. |
--dry-run | off | Print the effective eval section (defaults < file < env) and exit 0 without evaluating anything. |
Input selection🔗
| Flag | Default | Description |
|---|---|---|
-e, --event <EVENT> | stdin | Single event as a JSON string, or @path to read NDJSON or .evtx. Without this flag, reads NDJSON from stdin. |
--jq <JQ> | unset | jq filter to extract the event payload from each input object. Example: --jq '.event', --jq '.records[]'. Mutually exclusive with --jsonpath. |
--jsonpath <JSONPATH> | unset | JSONPath (RFC 9535) query to extract the event payload. Example: --jsonpath '$.event', --jsonpath '$.records[*]'. |
--input-format <FORMAT> | auto | Input log format: auto, json, syslog, plain. With the logfmt and cef features: also logfmt, cef. |
--syslog-tz <OFFSET> | +00:00 | Timezone offset for RFC 3164 syslog parsing. Format: +HH:MM or -HH:MM. |
--syslog-strip-bom <BOOL> | true | Strip a leading UTF-8 BOM (U+FEFF) from RFC 5424 syslog messages. RFC 5424 treats the BOM as an encoding marker, not content. Pass --syslog-strip-bom false to keep it byte-for-byte. |
Pipeline🔗
| Flag | Description |
|---|---|
-p, --pipeline <PIPELINES> | Processing pipeline(s) to apply. Accepts the builtin names (ecs_windows, sysmon) or YAML file paths. Repeatable; applied in priority order. |
Output🔗
The global --output-format / --color / --quiet / --no-stats flags apply here too; see Output Formats. The flags below are eval-specific.
| Flag | Default | Description |
|---|---|---|
--pretty | off | Pretty-print JSON output. Kept for backwards compatibility; equivalent to --output-format json with pretty-printing on. |
--no-detections | off | Suppress detection output for rules that exist only to feed correlations (generate: false). |
--include-event | off | Embed the full event JSON in every MatchResult. Equivalent to setting rsigma.include_event: "true" per-rule. |
--match-detail <LEVEL> | off | Match-detail verbosity: off (field + value only), summary (adds matcher kind, selection, case sensitivity, and reports keyword/absence matches), or full (also records the matched pattern). See Evaluating Rules. |
Correlation behavior🔗
| Flag | Default | Description |
|---|---|---|
--suppress <DURATION> | unset | Suppress duplicate correlation alerts within the window (5m, 1h, 30s). |
--action <ACTION> | alert | Post-fire action for correlations: alert (keep state, re-alert on next match) or reset (clear window state). |
--correlation-event-mode <MODE> | none | Whether to embed contributing events in correlation output: none, full (deflate-compressed full bodies), refs (timestamp + ID only). |
--max-correlation-events <N> | 10 | Cap on stored events per correlation window when --correlation-event-mode is not none. Oldest evicted. |
--max-state-entries <N> | 100000 | Hard cap on correlation state entries across all correlations and group keys. When reached, the stalest entries are evicted to 90% capacity and a warning is logged. |
--max-group-entries <N> | unset | Cap on retained entries within a single correlation group's window state. Bounds within-window growth of chatty groups; oldest entries are dropped (session windows keep their span anchor). Unset = unbounded. Equivalent to the rsigma.max_group_entries custom attribute. |
--timestamp-field <FIELD> | unset | Field name to prepend to the timestamp extraction priority list. Default list: @timestamp, timestamp, EventTime, TimeCreated, eventTime. Repeatable. |
Performance (advanced)🔗
| Flag | Default | Description |
|---|---|---|
--bloom-prefilter | off | Enable per-field bloom filter over positive substring needles. Useful for IOC-heavy rule sets against mostly-non-matching telemetry. See Performance Tuning. |
--bloom-max-bytes <BYTES> | 1048576 | Memory budget for the bloom index (1 MiB default). No effect without --bloom-prefilter. |
--cross-rule-ac | off | Enable the cross-rule Aho-Corasick pre-filter. Available when compiled with the daachorse-index Cargo feature. See Performance Tuning. |
Field observability (offline coverage report)🔗
The same gap / broken-coverage signals exposed by the daemon's /api/v1/fields* endpoints are available offline as a one-shot report:
| Flag | Default | Description |
|---|---|---|
--observe-fields | off | Record the field keys of every evaluated event and emit a coverage report at end-of-run. The report has the same JSON shape as GET /api/v1/fields, so the same jq queries work against either runtime (suited for CI gap analysis). |
--observe-fields-max-keys <N> | 10000 | Hard ceiling on distinct field names tracked. New keys are dropped after the cap (and counted via overflow_dropped in the report). |
--observe-fields-report <PATH> | unset | Write the report to a file. When omitted (and --observe-fields is set), the report goes to stderr so detections on stdout stay machine-consumable. |
# CI: keep stdout for detection NDJSON, stderr for logs, report in its own file
rsigma engine eval -r rules/ -e @events.ndjson \
--observe-fields \
--observe-fields-report coverage.json
# Quick interactive run: the report shows up on stderr alongside the
# "Processed N events, M matches." line
rsigma engine eval -r rules/ -e @events.ndjson --observe-fields
See Observability: detection coverage for the operator workflow shared with the daemon path.
CI gating🔗
| Flag | Description |
|---|---|
--fail-on-detection | Exit with code 1 when any detection or correlation fires. |
Examples🔗
Single inline event🔗
NDJSON file with pretty output🔗
Table view for interactive triage🔗
A width-aligned LEVEL | RULE | TYPE | DETAIL table appears on stdout. Use --output-format csv or --output-format tsv to pipe into a spreadsheet instead. See Output Formats.
EVTX file with the bundled Windows-mapping pipeline🔗
EVTX records are nested under Event.System.* and Event.EventData.*; rules must reference fields by their full dotted path. See Input Formats.
Tail a JSON log file into the engine🔗
Extract events from a wrapper envelope🔗
CI fixture: assert nothing matches🔗
Exits 1 if any rule fires. Exits 0 if the fixture stays quiet.
Apply a builtin pipeline🔗
Correlation with suppression🔗
rsigma engine eval -r rules/ --suppress 5m --action reset \
--correlation-event-mode refs --max-correlation-events 50 \
< security-events.ndjson
Exit codes🔗
| Code | Meaning |
|---|---|
0 | Events processed cleanly. With --fail-on-detection, no rule fired. Per-rule parse errors are logged as warnings but do not change the exit code. |
1 | With --fail-on-detection, at least one detection or correlation fired. |
2 | The rules path itself could not be read. Use rule validate for a strict per-rule gate that fails on parse or compile errors. |
3 | Configuration error: bad -p, malformed --suppress, invalid --jq filter, etc. |
See also🔗
- Evaluating Rules for the narrative version with event-extraction patterns and correlation walkthroughs.
- Input Formats for JSON, syslog, logfmt, CEF, EVTX, OTLP, plain text, and auto-detect.
- Processing Pipelines for
-psemantics and the builtin pipelines. - Performance Tuning for
--bloom-prefilterand--cross-rule-ac. - CI/CD for
--fail-on-detectionpatterns. engine daemonfor the long-running streaming counterpart.