diff --git a/docs/capability-catalog.json b/docs/capability-catalog.json index 55914f7..d18ec43 100644 --- a/docs/capability-catalog.json +++ b/docs/capability-catalog.json @@ -63,7 +63,7 @@ "kind": "ingest", "name": "flow", "description": "NetFlow v5/v9 + IPFIX + sFlow v5.", - "maturity": "stable" + "maturity": "alpha" }, { "kind": "ingest", diff --git a/docs/capability-catalog.yaml b/docs/capability-catalog.yaml index 362bafe..16ee04c 100644 --- a/docs/capability-catalog.yaml +++ b/docs/capability-catalog.yaml @@ -42,7 +42,7 @@ - kind: ingest name: flow description: NetFlow v5/v9 + IPFIX + sFlow v5. - maturity: stable + maturity: alpha - kind: ingest name: webhook description: "Generic authenticated webhook intake: POST /webhook/{caller}, per-caller HMAC or static-header auth, per-caller topic." diff --git a/docs/protocols.md b/docs/protocols.md index b4868b3..afe601b 100644 --- a/docs/protocols.md +++ b/docs/protocols.md @@ -64,7 +64,7 @@ The other listeners do not offer the knob: their payload is JSON or passes throu ## Flow (NetFlow + sFlow) is experimental -Status: experimental. `flow.experimental` defaults to `true`, and with it set the handler logs a startup WARN and sets `handler_experimental{handler="flow"} 1`. The generated capability catalogue lists flow as stable, and [#254](https://github.com/hyperi-io/dfe-receiver/issues/254) tracks settling the two. +Status: experimental. `flow.experimental` defaults to `true`, and with it set the handler logs a startup WARN and sets `handler_experimental{handler="flow"} 1`. The generated capability catalogue lists flow as alpha. Native UDP ingestion for NetFlow v5/v9, IPFIX and sFlow v5, with autosense dispatch on each of the default ports (2055, 4739, 6343). `canonical` output (default) is one JSON envelope per UDP datagram with a `flows: [...]` array, and `exploded` one envelope per flow record, which multiplies the events. A record's kind is `flow`, `counter` (an sFlow counter sample), `security_event` (an NSEL firewall event, Cisco ASA firewallEvent / NF_F_FW_EVENT) or `nat_translation` (a CGNAT NAT44 natEvent). One listener per port takes every flow protocol by default, and `flow.split:` runs a NetFlow listener and an sFlow listener instead. diff --git a/src/deployment.rs b/src/deployment.rs index 01a49d9..ca888ab 100644 --- a/src/deployment.rs +++ b/src/deployment.rs @@ -359,7 +359,7 @@ fn capabilities() -> Vec { ingest("prometheus_rw", "Prometheus Remote Write."), ingest("fluent", "Fluent Forward protocol."), ingest("gelf", "Graylog Extended Log Format."), - ingest("flow", "NetFlow v5/v9 + IPFIX + sFlow v5."), + ingest("flow", "NetFlow v5/v9 + IPFIX + sFlow v5.").maturity("alpha"), ingest("webhook", "Generic authenticated webhook intake: POST /webhook/{caller}, per-caller HMAC or static-header auth, per-caller topic."), ]), Capability::sink("destinations")