NAME¶

nfprofile — netflow profiler

SYNOPSIS¶

DESCRIPTION¶

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

This program is normally run only by NfSen, not directly by users.

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

nfprofile processes the data according to the profile configuration, and writes the output files to the specified directory for further processing or visualization.

The options are as follows:

-h

Print help text to stdout and exit.

-V

Print nfprofile version and exit.

-I

Read profile parameters from stdin, instead of being invoked with a single profile's parameters.

-Z

Check filter syntax and exit.

-p profiledir

Specify the profile data directory.

-P statdir

Specify the profile stat directory.

-S num

Sub directory format. See nfcapd(1) for format.

-r file

Read input from this single file.

-M dirlist

Read input from multiple directories, ':' separated.

-f filterfile

Read the netflow filter to apply from this file.

-t time

Time slot, passed through to the RRD update for this run.

-L facility

Set the syslog facility to log to.

-z=lzo

LZO compress flows in output file.

-z=bz2

BZIP2 compress flows in output file.

-z=lz4[:level]

LZ4 compress flows in output file.

-z=zstd[:level]

ZSTD compress flows in output file.

-j

Legacy shorthand for -z=bz2.

-y

Legacy shorthand for -z=lz4.

-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.

EXIT STATUS¶

nfprofile returns 0 on success and 255 otherwise.

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.

SEE ALSO¶

nfcapd(1), nfdump(1), nfreplay(1)

BUGS¶

No software without bugs! Please report any bugs back to me.