Skip to main content

FlowAnalyzer

Struct FlowAnalyzer 

Source
pub struct FlowAnalyzer<K>
where K: Hash + Eq,
{ /* private fields */ }
Available on crate feature analysis only.
Expand description

Per-flow analysis accumulator. Generic over the flow key K.

Implementations§

Source§

impl<K> FlowAnalyzer<K>
where K: Hash + Eq + Clone,

Source

pub fn new(ttl: Duration) -> Self

New analyzer with unbounded per-flow state expired only by ttl (idle flows reclaimed by evict_expired). Prefer with_capacity in production.

Source

pub fn with_capacity(ttl: Duration, capacity: usize) -> Self

New analyzer bounded to capacity concurrently-tracked flows (LRU eviction past the cap) plus the ttl idle expiry — the project’s bounded-memory contract.

Source

pub fn with_ioc(self, ioc: IocSet) -> Self

Attach a threat-intel IocSet to screen flows against at finalize time (SNI / DNS qnames / IPs / JA3 / JA4). Without one, AnalyzedFlow::ioc_hits is always empty.

Source

pub fn len(&self) -> usize

Number of flows with accumulated state.

Source

pub fn is_empty(&self) -> bool

true if no flow state is held.

Source

pub fn observe_tls(&mut self, key: &K, hs: &TlsHandshake, ts: Timestamp)

Available on crate feature tls only.

Fold a completed TLS handshake into the flow’s summary.

Source

pub fn observe_http(&mut self, key: &K, msg: &HttpMessage, ts: Timestamp)

Available on crate feature http only.

Fold an HTTP message into the flow’s summary (requests only; see L7Summary::observe_http).

Source

pub fn observe_dns_query(&mut self, key: &K, q: &DnsQuery, ts: Timestamp)

Available on crate feature dns only.

Record the query names from a DNS query.

Source

pub fn observe_dns_response(&mut self, key: &K, r: &DnsResponse, ts: Timestamp)

Available on crate feature dns only.

Record the query names from a DNS response.

Source

pub fn evict_expired(&mut self, now: Timestamp)

Reclaim per-flow state for flows idle longer than the TTL — call periodically (e.g. on a tracker tick) so flows that end without an explicit finalize don’t linger.

Source

pub fn forget(&mut self, key: &K) -> bool

Drop a flow’s accumulated state without producing a record (e.g. a flow you decided not to analyze). Returns whether state was present.

Source§

impl<K> FlowAnalyzer<K>
where K: Hash + Eq + Clone + KeyFields,

Source

pub fn finalize(&mut self, key: &K, stats: FlowStats) -> AnalyzedFlow<K>

Finalize a flow on its Ended event: take its accumulated L7Summary, compute the FlowRisk and IOC hits, evict the per-flow state, and return the enriched AnalyzedFlow. Idempotent — a second call for the same key sees an empty summary.

Source

pub fn snapshot( &self, key: &K, now: Timestamp, stats: FlowStats, ) -> AnalyzedFlow<K>

Compute the AnalyzedFlow for a flow without evicting its state — a mid-flow snapshot at now. Use finalize on the terminal event.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more