NFPROFILE(1)

👑 NFPROFILE (1) — netflow profiler, but make it make sense

okay so bestie, welcome to the General Commands Manual entry for nfprofile ✨ this is the netflow profiler program, and yes it lives in the big-girl commands section, so you know it means business 💅

---

✨ SYNOPSIS ✨

nfprofile [-hVIZ] [-p profiledir] [-P statdir] [-r file] [-M dirlist]
          [-f filterfile] [-S num] [-t time] [-L facility]
          [-z=<compress>] [-j] [-y] [-i url]

that's the whole vibe right there, no cap 🫶

---

🌸 DESCRIPTION 🌸

nfprofile is the netflow profiler program for NfSen, periodt. it reads netflow data from files that nfcapd(1) stored, and then it creates the corresponding output files for every channel required by a profile configuration 💖

so like — heads up — this program is normally run only by NfSen, not directly by users. it's giving backstage crew, not main character energy 🙈

a profile is defined by a configuration file, and that file specifies channels, sources, and filters for the data to be extracted and summarized 🎀

nfprofile processes the data according to the profile configuration, and then writes the output files to the specified directory so they can go on to further processing or visualization 🦋

the options are as follows, bestie — buckle up, there's a bunch:

---

💅 OPTIONS 💅

• -h — print help text to stdout and exit. the classic "hi, what do you do" move ✨
• -V — print the nfprofile version and exit. identity check 💖
• -I — read profile parameters from stdin, instead of being invoked with a single profile's parameters. multitasking icon 👑
• -Z — check filter syntax and exit. grammar police, but for filters 💀
• -p profiledir — specify the profile data directory. this is where the data lives 🏠
• -P statdir — specify the profile stat directory. stats get their own lil room 📊
• -S num — sub directory format. see nfcapd(1) for format. iykyk 🧚
• -r file — read input from this single file. one file, one vibe 🍓
• -M dirlist — read input from multiple directories, ':' separated. the group chat of directories 🌈
• -f filterfile — read the netflow filter to apply from this file. filter goes in, filter comes out 🎀
• -t time — time slot, passed through to the RRD update for this run. time is literally a construct (but the RRD needs it) ⭐
• -L facility — set the syslog facility to log to. logging, but make it official 📝
• -z=lzo — LZO compress flows in output file. tiny files, big slay 💜
• -z=bz2 — BZIP2 compress flows in output file. the OGs of compression 🔥
• -z=lz4[:level] — LZ4 compress flows in output file. fast and fabulous, optional level added 🌸
• -z=zstd[:level] — ZSTD compress flows in output file. also with an optional level 🦋
• -j — legacy shorthand for -z=bz2. retro but valid 💫
• -y — legacy shorthand for -z=lz4. also retro, also valid 💫
• -i url — InfluxDB URL to write stats to, e.g. http://localhost:8086/write?db=mydb&u=user&p=pass . only available if built with InfluxDB support. note the "only if built with" part — check before you get your hopes up 🙈

---

🔥 EXIT STATUS 🔥

nfprofile returns 0 on success and 255 otherwise. that's it, that's the whole story — binary icon behaviour 👑

---

🎀 NOTES 🎀

this program is intended to be run by NfSen. direct invocation is not recommended unless you know exactly how to configure profiles and their directories. like, not "i skimmed the docs" know — actually know 💀

---

🦋 SEE ALSO 🦋

nfcapd(1), nfdump(1), nfreplay(1) — the rest of the friend group, go say hi 💖

---

💀 BUGS 💀

"No software without bugs!" — the author's own words, and honestly? realest thing ever said. please report any bugs back to me 🙏

---

🫶 the cute sign-off 🫶

this lil page is from Debian, version-ed with $Mdocdate$, and filed under NFPROFILE(1) — that's the whole footer, but make it adorable. k thanks bye, go profile some netflow 💜✨🌸