Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synfinatic/netflow2ng
NetFlow v9 collector for ntopng
https://github.com/synfinatic/netflow2ng
collector netflow netflow-v9 nprobe ntopng
Last synced: about 2 months ago
JSON representation
NetFlow v9 collector for ntopng
- Host: GitHub
- URL: https://github.com/synfinatic/netflow2ng
- Owner: synfinatic
- License: mit
- Created: 2020-02-06T02:44:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T21:21:43.000Z (3 months ago)
- Last Synced: 2024-06-18T23:14:15.877Z (3 months ago)
- Topics: collector, netflow, netflow-v9, nprobe, ntopng
- Language: Go
- Size: 125 KB
- Stars: 142
- Watchers: 7
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# netflow2ng
NetFlow v9 collector for [ntopng](https://www.ntop.org/products/traffic-analysis/ntop/)[![Tests](https://github.com/synfinatic/netflow2ng/actions/workflows/tests.yml/badge.svg)](https://github.com/synfinatic/netflow2ng/actions/workflows/tests.yml)
[![codeql-analysis.yml](https://github.com/synfinatic/netflow2ng/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/synfinatic/netflow2ng/actions/workflows/codeql-analysis.yml)
[![golangci-lint](https://github.com/synfinatic/netflow2ng/actions/workflows/golangci-lint.yaml/badge.svg)](https://github.com/synfinatic/netflow2ng/actions/workflows/golangci-lint.yaml)### TL;DR
ntopng is a free/commercial NetFlow/sFlow analysis console suitible for a
variety of use cases. However, if you want to collect NetFlow or sFlow
data and load that into ntopng you currently have no choice but to spend
199Euro on [nProbe](https://www.ntop.org/products/netflow/nprobe/) which
in my case is more expensive than the
[Ubiquiti USG](https://www.ui.com/unifi-routing/usg/) that I wanted to
collect NetFlow stats from.Hence, I created netflow2ng.
### Installing
##### Build From Source
1. Make sure you have a recent version of go. I used 1.14.2. Older versions
may have problems.
1. `git clone https://github.com/synfinatic/netflow2ng.git`
1. `cd netflow2ng`
1. `make`
1. The binary should now be in the `dist` directory. Copy it somewhere
appropriate and create the necessary startup script(s).##### Install via Docker
1. Pull the latest [docker image](https://hub.docker.com/r/synfinatic/netflow2ng)
1. Use the optional [docker-compose.yaml](docker-compose.yaml) file### Configuration
1. For a list of configuration arguments, run `netflow2ng -h`
1. Configure your network device(s) to send NetFlow stats to netflow2ng
1. Configure your [ntopng](https://www.ntop.org/products/traffic-analysis/ntop/)
service to read from netflow2ng: `ntopng -i tcp://192.168.1.1:5556` where
"192.168.1.1" is the IP address of your netflow2ng server.### Features
* Collect NetFlow v9 stats from one or more probes
* Run a ZMQ Publisher for ntopng to collect metrics from
* Prometheus metrics
* NetFlow Templates### NetFlow v9 Support
netflow2ng utilizes [goflow](https://github.com/cloudflare/goflow) for NetFlow
decoding. For more information on what NetFlow fields are supported in
netflow2ng, please read the goflow docs.### sFlow/IPFIX/etc support?
In theory, adding sFlow/IPFIX/NetFlow v5 support should be pretty trivial, but
isn't something I plan on doing due to lack of hardware for testing/need.### How is netflow2ng different from nProbe?
* Not 199Euro
* Doesn't support any probe features (sniffing traffic directly)
* Can't write stats to MySQL/disk or act as a NetFlow proxy
* Not tested with lots of probes or on 10Gbit networks
* Targeted for Home/SOHO use.
* No commercial support, etc.
* May not support the latest versions/features of ntopng
* Written in GoLang instead of C/C++