Skip to content

Commit 27d2df4

Browse files
committed
README: update the main readme document
1 parent ebfdf4e commit 27d2df4

File tree

1 file changed

+33
-21
lines changed

1 file changed

+33
-21
lines changed

README.rst

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ network interface and a port. Multiple instances of these plugins can run concur
3131
**Intermediate plugins** - modify, enrich and filter flow records.
3232

3333
- `anonymization <src/plugins/intermediate/anonymization/>`_ - anonymize IP addresses
34-
(in flow records) with Crypto-PAn algorithm.
34+
(in flow records) with Crypto-PAn algorithm
3535

3636
**Output plugins** - store or forward your flows.
3737

3838
- `JSON <src/plugins/output/json>`_ - convert flow records to JSON and send/store them
39-
- `dummy <src/plugins/output/dummy>`_ - simple module example,
39+
- `dummy <src/plugins/output/dummy>`_ - simple module example
4040
- `lnfstore <extra_plugins/output/lnfstore>`_ (*) - store all flows in nfdump compatible
4141
format for long-term preservation
4242

@@ -85,41 +85,53 @@ Finally, build and install the collector:
8585
$ make
8686
# make install
8787
88-
How to configure
89-
----------------
88+
How to configure and start IPFIXcol
89+
-----------------------------------
9090

91-
TODO: Prepared configurations
92-
93-
TODO: example configuration files
94-
95-
TODO: description of information elements are
91+
Before you can start IPFIXcol, you have to prepare a configuration file. The file describes how
92+
IPFIXcol is configured at startup, which plugins are used and, for example, where flow data will
93+
be stored. The structure of the configuration is described
94+
`here <doc/sphinx/configuration.rst>`_. Several configuration examples that demonstrate features
95+
of the collector are given in the section
96+
"`Example configuration files <doc/sphinx/configuration.rst#example-configuration-files>`_".
9697

98+
Coming soon
99+
-----------
100+
- NetFlow v5/v9 support
101+
- Runtime reconfiguration (improved compared to the previous generation)
102+
- RPM/DEB packages
103+
- Support for structured data types (lists, etc.)
97104

98105
FAQ
99106
--------------
100107

101108
Do you have any troubles? Unable to build and run the collector? *Feel free to submit a new issue.*
102109

103110
We are open to new ideas! For example, are you missing a specific plugin that could
104-
be useful also for other users? Please, share your experience and thoughts.
111+
be useful also for other users? Please, share your experiences and thoughts.
105112

106113
----
107114

108-
:Q: How to...? UDP or TCP
109-
:A: You should...
110-
111-
:Q: How to...? UDP and no records
112-
:A: You should...
115+
:Q: My exporter sends flow data over UDP, however, the IPFIXcol doesn't process/store any data
116+
immediately after start.
117+
:A: This is normal behaviour caused by UDP transport protocol. It may take up few minutes until
118+
the first record is processed based on template refresh interval on the exporter.
119+
For more information, see documentation of `UDP <src/plugins/input/udp>`_ plugin.
113120

114121
:Q: How can I add more IPFIX fields into records?
115122
:A: The collector receives flow records captured and prepared by an exporter. IPFIX is an
116123
unidirectional protocol which means that the collector is not able to instruct the exporter
117124
what to measure or how to behave. If you want to enhance your records, please, check
118125
configuration of your exporter.
119126

120-
Coming soon
121-
-----------
122-
- NetFlow v5/v9 support
123-
- Runtime reconfiguration (improved compared to the previous generation)
124-
- RPM/DEB packages
125-
- Support for structured data types (lists, etc.)
127+
:Q: After *manual build and installation* the collector is unable to start and a message similar to
128+
``error while loading shared libraries: libfds.so.0: cannot open shared object file: No such file or directory``
129+
is given.
130+
:A: Make sure that ``libfds`` is installed properly and your system is able to locate it.
131+
Some systems (e.g. RHEL/CentOS/Fedora) for historical reason doesn't search for shared libraries
132+
in the default installation directory where the ``libfds`` is installed. You can permanently
133+
include this directory. For example, if the library is located in ``/usr/local/lib64``, use
134+
as administrator "``echo "/usr/local/lib64" > /etc/ld.so.conf.d/local64.conf && ldconfig``"
135+
or temporarily change an environment variable
136+
"``export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib64/``"
137+

0 commit comments

Comments
 (0)