Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-flowd Reference Manual, version 0.5.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:17:02 2020 GMT+0.
• Introduction | What cl-flowd is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Common Lisp Netflow log reader for flowd logs.
The core of this code originally appeared in the small-cl-source@common-lisp.net mailling list. The original author is Ingvar Mattison. The code has been updated to work with modern flowd Netflow log files and extended functionality.
The functions prefixed with -v2 are for working with older flowd datastores. For modern installations of flowd the non prefixed versions of these functions should be used
See source or quickdocs
This library uses Netflow collector Flowd which is available at: http://www.mindrot.org/projects/flowd/
Flowd can be build from tarball our Mecurial repo Tarball: http://flowd.googlecode.com/files/flowd-0.9.1.tar.gz Mecurial: hg clone https://code.google.com/p/flowd/
Buile Instructions: autoreconf configure make make install
Review ''man flowd.conf'' , ''man flowd'' and INSTALL for configuration
This dumps the contents of the flowd log as text to the console similar to the flow-reader, reader.py and reader.pl programs
(with-open-log (flog "/var/log/flowd/flowd.bin")
(do ((f (read-flow flog)
(read-flow flog)))
((eql f nil))
(format-flow t f)))
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-flowd system |
Mike Maul <mike.maul@gmail.com>
BSD
Native Lisp interface to Netflow data stores created by
the Netflow collect flowd (http://www.mindrot.org/projects/flowd/)
0.5.0
cl-annot
cl-flowd.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-flowd.asd file | ||
• The cl-flowd/package.lisp file | ||
• The cl-flowd/flowd.lisp file |
Next: The cl-flowd/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-flowd.asd
cl-flowd (system)
Next: The cl-flowd/flowd․lisp file, Previous: The cl-flowd․asd file, Up: Lisp files [Contents][Index]
Previous: The cl-flowd/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-flowd (system)
flowd.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-flowd package |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Use open-log to obtain a store-header to flowd log located at <filename>
flowd.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
This function closes the log file associated with a storage header.
flowd.lisp (file)
(dst-net flow-obj &optional stream formatted-p)
This function extracts the destination network and masks it against the relevant IPv4 netmask and returns the network part. If given a STREAM and FORMATTED-P is not null, the resulting netblock is emitted using FORMAT-IPV4 to the indicated stream.
flowd.lisp (file)
formats a string representing the next entry in the flowd log <stream> can be stream to write to or nil to return string
flowd.lisp (file)
(format-ipv4 binary-chunk &optiona stream mask)
This function outputs an IPv4 address as a dotted quad to STREAM. If a netmask is passed in, it’s outputted with the dotted quad in CIDR notation.
flowd.lisp (file)
Sends string hex value of <v> to <stream>
flowd.lisp (file)
(open-log <file name>
This function opens a new flowd log file > v2 and returns a header structure containing the relevant file header information.
flowd.lisp (file)
(open-log <file name>
This function opens a new flowd v2 log file and returns a header structure containing the relevant file header information.
flowd.lisp (file)
(read-flow <flow-header> &optional flow-object)
This function reads one flow entry from a log file (return value from OPEN-LOG) and returns it. If a flow object is passed in as an optional parameter, this flow object is re-used for storage instead of allocating a new instance.
flowd.lisp (file)
(read-flow <flow-header> &optional flow-object)
This function reads one flow entry from a flowd log < v2 file (return value from
OPEN-LOG) and returns it. If a flow object is passed in as an optional
parameter, this flow object is re-used for storage instead of allocating
a new instance.
flowd.lisp (file)
(src-net flow-obj &optional stream formatted-p)
This function extracts the source network and masks it against the relevant IPv4 netmask and returns the network part. If given a STREAM and FORMATTED-P is not null, the resulting netblock is emitted using FORMAT-IPV4 to the indicated stream.
flowd.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
automatically generated reader method
flowd.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
flowd.lisp (file)
standard-object (class)
:fields
fields (generic function)
(setf fields) (generic function)
:tag
tag (generic function)
(setf tag) (generic function)
:recv-time
recv-time (generic function)
(setf recv-time) (generic function)
:recv-time-usecs
recv-time-usecs (generic function)
(setf recv-time-usecs) (generic function)
:tcp-flags
tcp-flags (generic function)
(setf tcp-flags) (generic function)
:protocol
protocol (generic function)
(setf protocol) (generic function)
:tos
tos (generic function)
(setf tos) (generic function)
:agent-addr
agent-addr (generic function)
(setf agent-addr) (generic function)
:src-addr
src-addr (generic function)
(setf src-addr) (generic function)
:dst-addr
dst-addr (generic function)
(setf dst-addr) (generic function)
:gateway-addr
gateway-addr (generic function)
(setf gateway-addr) (generic function)
:src-port
src-port (generic function)
(setf src-port) (generic function)
:dst-port
dst-port (generic function)
(setf dst-port) (generic function)
:packets
packets (generic function)
(setf packets) (generic function)
:octets
octets (generic function)
(setf octets) (generic function)
:if-index-in
if-index-in (generic function)
(setf if-index-in) (generic function)
:if-index-out
if-index-out (generic function)
(setf if-index-out) (generic function)
:sys-uptime-ms
sys-uptime-ms (generic function)
(setf sys-uptime-ms) (generic function)
:time-sec
time-sec (generic function)
(setf time-sec) (generic function)
:time-nanosec
time-nanosec (generic function)
(setf time-nanosec) (generic function)
:netflow-version
netflow-version (generic function)
(setf netflow-version) (generic function)
:flow-start
flow-start (generic function)
(setf flow-start) (generic function)
:flow-finish
flow-finish (generic function)
(setf flow-finish) (generic function)
:src-as
src-as (generic function)
(setf src-as) (generic function)
:dst-as
dst-as (generic function)
(setf dst-as) (generic function)
:src-mask
src-mask (generic function)
(setf src-mask) (generic function)
:dst-mask
dst-mask (generic function)
(setf dst-mask) (generic function)
:engine-type
engine-type (generic function)
(setf engine-type) (generic function)
:engine-id
engine-id (generic function)
(setf engine-id) (generic function)
:flow-sequence
flow-sequence (generic function)
(setf flow-sequence) (generic function)
flowd.lisp (file)
standard-object (class)
:fields
flow-v2.fields (generic function)
(setf flow-v2.fields) (generic function)
:tag
flow-v2.tag (generic function)
(setf flow-v2.tag) (generic function)
:recv-time
flow-v2.recv-time (generic function)
(setf flow-v2.recv-time) (generic function)
:tcp-flags
flow-v2.tcp-flags (generic function)
(setf flow-v2.tcp-flags) (generic function)
:protocol
flow-v2.protocol (generic function)
(setf flow-v2.protocol) (generic function)
:tos
flow-v2.tos (generic function)
(setf flow-v2.tos) (generic function)
:agent-addr
flow-v2.agent-addr (generic function)
(setf flow-v2.agent-addr) (generic function)
:src-addr
flow-v2.src-addr (generic function)
(setf flow-v2.src-addr) (generic function)
:dst-addr
flow-v2.dst-addr (generic function)
(setf flow-v2.dst-addr) (generic function)
:gateway-addr
flow-v2.gateway-addr (generic function)
(setf flow-v2.gateway-addr) (generic function)
:src-port
flow-v2.src-port (generic function)
(setf flow-v2.src-port) (generic function)
:dst-port
flow-v2.dst-port (generic function)
(setf flow-v2.dst-port) (generic function)
:packets
flow-v2.packets (generic function)
(setf flow-v2.packets) (generic function)
:octets
flow-v2.octets (generic function)
(setf flow-v2.octets) (generic function)
:if-index-in
flow-v2.if-index-in (generic function)
(setf flow-v2.if-index-in) (generic function)
:if-index-out
flow-v2.if-index-out (generic function)
(setf flow-v2.if-index-out) (generic function)
:sys-uptime-ms
flow-v2.sys-uptime-ms (generic function)
(setf flow-v2.sys-uptime-ms) (generic function)
:time-sec
flow-v2.time-sec (generic function)
(setf flow-v2.time-sec) (generic function)
:time-nanosec
flow-v2.time-nanosec (generic function)
(setf flow-v2.time-nanosec) (generic function)
:netflow-version
flow-v2.netflow-version (generic function)
(setf flow-v2.netflow-version) (generic function)
:flow-start
flow-v2.flow-start (generic function)
(setf flow-v2.flow-start) (generic function)
:flow-finish
flow-v2.flow-finish (generic function)
(setf flow-v2.flow-finish) (generic function)
:src-as
flow-v2.src-as (generic function)
(setf flow-v2.src-as) (generic function)
:dst-as
flow-v2.dst-as (generic function)
(setf flow-v2.dst-as) (generic function)
:src-mask
flow-v2.src-mask (generic function)
(setf flow-v2.src-mask) (generic function)
:dst-mask
flow-v2.dst-mask (generic function)
(setf flow-v2.dst-mask) (generic function)
:engine-type
flow-v2.engine-type (generic function)
(setf flow-v2.engine-type) (generic function)
:engine-id
flow-v2.engine-id (generic function)
(setf flow-v2.engine-id) (generic function)
:flow-sequence
flow-v2.flow-sequence (generic function)
(setf flow-v2.flow-sequence) (generic function)
flowd.lisp (file)
standard-object (class)
:version
version (generic function)
:len-words
len-words (generic function)
:reserved
reserved (generic function)
:fields
fields (generic function)
:stream
stream (generic function)
flowd.lisp (file)
standard-object (class)
:magic
store-header-v2.magic (generic function)
:version
store-header-v2.version (generic function)
:start-time
store-header-v2.start-time (generic function)
:flags
store-header-v2.flags (generic function)
:stream
store-header-v2.stream (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
flowd.lisp (file)
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
flowd.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
flowd.lisp (file)
Checks if a given flag is set. The flag field is expected to be named FIELDS and is for use inside READ-FLOW only!
flowd.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
flowd.lisp (file)
This function is currently a no-op
flowd.lisp (file)
This function is currently a no-op
flowd.lisp (file)
flowd.lisp (file)
Read from STREAM a total of N bytes, mung them together as a single integer. Expects 8-bit bytes.
flowd.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
flowd.lisp (file)
automatically generated writer method
flowd.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
flowd.lisp (file)
standard-object (class)
:address
address (generic function)
(setf address) (generic function)
flowd.lisp (file)
ipaddr (class)
flowd.lisp (file)
ipaddr (class)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A C D E F G H I L M N O P R S T V W |
---|
Jump to: | (
A C D E F G H I L M N O P R S T V W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
A C D E F G I L M N O P R S T V |
---|
Jump to: | *
+
A C D E F G I L M N O P R S T V |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C F I P S |
---|
Jump to: | C F I P S |
---|