rsigma_runtime/
lib.rs

1//! # rsigma-runtime
2//!
3//! Streaming runtime for rsigma — event sources, sinks, and log processing pipeline.
4//!
5//! This crate extracts the streaming pipeline from the `rsigma` CLI daemon into
6//! a reusable library. It provides:
7//!
8//! - **I/O adapters**: [`io::EventSource`] trait for inputs (stdin, NATS) and
9//!   [`io::Sink`] enum for outputs (stdout, file, NATS).
10//! - **Engine wrapper**: [`RuntimeEngine`] wraps `rsigma-eval`'s `Engine` and
11//!   `CorrelationEngine` with rule loading and state management.
12//! - **Log processor**: [`LogProcessor`] combines engine + metrics + event
13//!   filtering into a batch processing pipeline with atomic hot-reload via
14//!   `ArcSwap`.
15//! - **Metrics abstraction**: [`MetricsHook`] trait lets consumers plug in
16//!   Prometheus, OpenTelemetry, or any other metrics backend without the
17//!   runtime depending on a specific implementation.
18//!
19//! # Example
20//!
21//! ```rust,no_run
22//! use std::sync::Arc;
23//! use rsigma_runtime::{LogProcessor, RuntimeEngine, NoopMetrics};
24//! use rsigma_eval::CorrelationConfig;
25//!
26//! let mut engine = RuntimeEngine::new(
27//!     "rules/".into(),
28//!     vec![],
29//!     CorrelationConfig::default(),
30//!     false,
31//! );
32//! engine.load_rules().unwrap();
33//!
34//! let processor = LogProcessor::new(engine, Arc::new(NoopMetrics));
35//!
36//! let batch = vec![r#"{"EventID": 1}"#.to_string()];
37//! let results = processor.process_batch_lines(&batch, &|v| vec![v.clone()]);
38//! for result in &results {
39//!     for r in result.iter().filter(|r| r.is_detection()) {
40//!         println!("Detection: {}", r.header.rule_title);
41//!     }
42//! }
43//! ```
44
45pub mod egress;
46pub mod engine;
47pub mod enrichment;
48pub mod error;
49pub mod input;
50pub mod io;
51pub mod metrics;
52pub mod parse;
53pub mod pipeline_deprecation;
54pub mod processor;
55pub mod sources;
56
57pub use egress::{
58    EgressDenial, EgressFilteredResolver, EgressPolicy, default_egress_policy,
59    set_default_egress_policy,
60};
61pub use engine::{EngineStats, RuntimeEngine};
62pub use enrichment::{
63    CacheKey, CacheOutcome, CommandEnricher, EnrichError, EnrichErrorKind, Enricher,
64    EnricherFactory, EnricherKind, EnrichmentPipeline, HttpEnricher, HttpEnricherClient,
65    HttpResponseCache, LookupEnricher, OnError, OutputFormat, Scope, TemplateEnricher,
66    TemplateError, build_default_http_client, lookup_builtin, register_builtin,
67    validate_template_namespace,
68};
69pub use error::RuntimeError;
70pub use input::{EventInputDecoded, InputFormat, parse_line};
71pub use io::{
72    AckToken, EventSource, FileSink, RawEvent, Sink, StdinSource, StdoutSink, spawn_source,
73};
74pub use metrics::{MetricsHook, NoopMetrics};
75pub use pipeline_deprecation::warn_pipeline_inline_sources;
76pub use processor::{EventFilter, LogProcessor};
77
78pub use rsigma_eval::{
79    FieldCoverage, FieldObservation, FieldObservationEntry, FieldObserver, ProcessResult,
80    ProcessResultExt,
81};
82pub use sources::refresh::{RefreshResult, RefreshScheduler, RefreshTrigger};
83pub use sources::{
84    DefaultSourceResolver, ResolvedValue, SourceCache, SourceError, SourceErrorKind,
85    SourceResolver, TemplateExpander,
86};
87
88#[cfg(feature = "nats")]
89pub use io::{NatsConnectConfig, NatsSink, NatsSource, ReplayPolicy};
90
91#[cfg(feature = "evtx")]
92pub use input::evtx::{EvtxError, EvtxFileReader};
93
94#[cfg(feature = "otlp")]
95pub use io::otlp::{
96    ExportLogsServiceRequest, ExportLogsServiceResponse, LogsService, LogsServiceServer,
97    logs_request_to_raw_events,
98};
rsigma_runtime/lib.rs

rsigma_runtime/
lib.rs
