Skip to main content

Installation

The netflow plugin is packaged separately from the main Netdata Agent. You install it on the same host where Netdata runs, after Netdata itself is in place.

The package name is netdata-plugin-netflow on both Debian and RPM distributions. It is not installed by the standard netdata package or by the netdata-updater on its own — you have to install it explicitly on native-package systems.

The static install (the kickstart --static-only path) bundles the plugin automatically. If you used the kickstart installer with the static option, no extra step is needed.

Prerequisites

  • A working Netdata Agent on the host that will receive flow data.
  • That host must be reachable on UDP from your routers and switches (default port 2055).
  • Linux. The plugin is Linux-only.

Install on Debian / Ubuntu / Mint

sudo apt update
sudo apt install netdata-plugin-netflow
sudo systemctl restart netdata

Install on RHEL / Fedora / CentOS / Rocky / Alma

sudo dnf install netdata-plugin-netflow
sudo systemctl restart netdata

(yum install works on older systems where dnf isn't present.)

Install on openSUSE

sudo zypper install netdata-plugin-netflow
sudo systemctl restart netdata

Static install (kickstart)

If you installed Netdata using:

wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && \
sh /tmp/netdata-kickstart.sh --static-only

…the netflow plugin is already installed under /opt/netdata/usr/libexec/netdata/plugins.d/netflow-plugin. No extra step.

To verify:

ls /opt/netdata/usr/libexec/netdata/plugins.d/netflow-plugin

Source build

Building from source requires a Rust toolchain (rustc + cargo, version 1.83 or later). When CMake detects Rust, the plugin is built and installed alongside the rest of Netdata.

git clone https://github.com/netdata/netdata.git
cd netdata
sudo ./netdata-installer.sh

Caveat: source builds do not include the stock GeoIP / IP-intelligence database files. Packaged 32-bit installs ship the stock MMDB payload but do not include topology-ip-intel-downloader. The plugin starts fine without cache files, but country, city, and AS-name fields will be empty until you run the downloader once on an install that includes it:

sudo /usr/sbin/topology-ip-intel-downloader

This populates /var/cache/netdata/topology-ip-intel/ with the DB-IP-based MMDB files. The plugin auto-detects the cache copy on its next 30-second poll. See the Enrichment Intel Downloader page for the refresh tool and the DB-IP integration card for cadence and license details.

IP intelligence defaults

ItemBehaviour
Native packagesShip stock DB-IP ASN and Geo MMDB files under /usr/share/netdata/topology-ip-intel/.
Source buildsDo not include stock MMDB files; run the downloader once if you want GeoIP / ASN enrichment.
Fresh copiesThe downloader writes to /var/cache/netdata/topology-ip-intel/, which takes precedence over the stock files.
Refresh scheduleNetdata does not install a timer or cron job for the downloader. Schedule it yourself if freshness matters.

What gets installed

PathPurpose
/usr/libexec/netdata/plugins.d/netflow-pluginThe plugin binary (mode 0750, root:netdata)
/usr/sbin/topology-ip-intel-downloaderHelper for refreshing the GeoIP / IP-intel MMDBs; not included in packaged 32-bit installs
/usr/lib/netdata/conf.d/netflow.yamlStock configuration (read-only reference; copy to /etc/netdata/netflow.yaml to customise)
/usr/lib/netdata/conf.d/topology-ip-intel.yamlIP-intel downloader configuration
/usr/share/netdata/topology-ip-intel/topology-ip-asn.mmdbStock ASN database (DB-IP)
/usr/share/netdata/topology-ip-intel/topology-ip-geo.mmdbStock geographic database (DB-IP)

(Paths assume native packages. Static installs put everything under /opt/netdata/.)

Verify the plugin is running

After installation and restart:

sudo journalctl --namespace netdata --since "5 minutes ago" | grep -E 'netflow|listener'

You should see entries indicating that the plugin loaded its config and that the UDP listener bound to its port.

Quick sanity check:

sudo ss -unlp | grep 2055

A line for netflow-plugin confirms the listener is up.

Open Netdata to confirm

Open the Netdata UI in your browser. Click the Live tab in the top navigation; Network Flows appears in the Functions list on the right (see Live tab). Selecting it opens the Sankey + Table view. The plugin's operational charts also appear under the standard charts page in the netflow family.

If Network Flows doesn't appear under Live, or the view is empty:

  • Check that the plugin process is running: pgrep -fa netflow-plugin.
  • Check Netdata Cloud SSO: Functions require authenticated access to the agent's space.
  • See Troubleshooting.

Configuring flow sources

Installing the plugin enables it. To actually see flow data, you need to configure a router, switch, or software exporter to send NetFlow / IPFIX / sFlow datagrams to this host's UDP port 2055.

That's the next step:

Uninstall

# Debian / Ubuntu
sudo apt remove netdata-plugin-netflow

# RHEL / Fedora / CentOS / Rocky / Alma
sudo dnf remove netdata-plugin-netflow

# openSUSE
sudo zypper remove netdata-plugin-netflow

Remove the configuration if you also want to clean up:

sudo rm /etc/netdata/netflow.yaml /etc/netdata/topology-ip-intel.yaml

The flow journals at /var/cache/netdata/flows/ and /var/cache/netdata/topology-ip-intel/ are not removed by the package manager. Delete them manually if you want to reclaim the disk:

sudo rm -rf /var/cache/netdata/flows /var/cache/netdata/topology-ip-intel

(Warning: this deletes all your historical flow data.)

What's next


Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.