Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/capability-catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"kind": "ingest",
"name": "flow",
"description": "NetFlow v5/v9 + IPFIX + sFlow v5.",
"maturity": "stable"
"maturity": "alpha"
},
{
"kind": "ingest",
Expand Down
2 changes: 1 addition & 1 deletion docs/capability-catalog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
2 changes: 1 addition & 1 deletion docs/protocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/deployment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ fn capabilities() -> Vec<scalo::deployment::Capability> {
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")
Expand Down
Loading