Skip to content
This repository was archived by the owner on Nov 27, 2018. It is now read-only.

Commit 4fb6a8a

Browse files
committed
Update README
1 parent 3cc580d commit 4fb6a8a

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ github.com/calmh/ipfix package.
88
Installation
99
------------
1010

11-
Make sure you have Go 1.1 installed. See http://golang.org/doc/install.
11+
Grab a binary release from https://github.com/calmh/ipfixcat/releases.
12+
13+
You can also build from source. Make sure you have Go 1.1 installed. See
14+
http://golang.org/doc/install.
1215

1316
$ go install github.com/calmh/ipfixcat
1417

@@ -24,34 +27,28 @@ display as `F[vendor,field]` with a byte array as value. A custom
2427
dictionary can be loaded to support vendor fields; see
2528
`procera-fields.ini` included.
2629

27-
Until a template set has been received all datasets will display without
28-
elements (because they can't be interpreted). If the session is over
29-
TCP, template sets should be sent before any data sets. For UDP data,
30-
template sets will be sent periodically.
31-
3230
Examples
3331
--------
3432

35-
Parse a UDP IPFIX stream. Note the empty data sets prior to having
36-
received templates.
33+
Parse a UDP IPFIX stream. Note that it might take a while to start
34+
displaying datasets, because we need to receive the periodically sent
35+
template sets first in order to be able to parse them.
3736

3837
$ socat udp-recv:4739 stdout | ipfixcat
39-
{"elements":null,"exportTime":1374494095,"templateId":49836}
40-
{"elements":null,"exportTime":1374494100,"templateId":49836}
4138
{"elements":{"F[15397.12]":[0,0,0,0],"F[15397.18]":[],"F[15397.1]":[66,105,116,84,111,114,114,101,110,116,32,75,82,...
4239
{"elements":{"F[15397.12]":[0,0,0,0],"F[15397.18]":[],"F[15397.1]":[68,114,111,112,98,111,120,32,76,65,78,32,115,12...
4340
...
4441

4542
Use a custom dictionary to interpret vendor fields.
4643

47-
$ socat udp-recv:4739 stdout | ipfixcat -dict $GOPATH/src/github.com/calmh/ipfixcat/procera-fields.ini
44+
$ socat udp-recv:4739 stdout | ipfixcat -dict procera-fields.ini
4845
{"elements":{"destinationIPv4Address":"172.16.32.15","proceraExternalRtt":47,"proceraIncomingOctets":146,"proeraOut...
4946
{"elements":{"destinationIPv4Address":"172.16.32.15","proceraExternalRtt":3,"proceraIncomingOctets":140,"proceraOut...
5047
{"elements":{"destinationIPv4Address":"172.16.32.15","proceraExternalRtt":4,"proceraIncomingOctets":642,"proceraOut...
5148
...
5249

53-
Don't attempt to use netcat (`nc`). Almost all distributed versions are
54-
broken and truncate UDP packets at 1024 bytes.
50+
Don't attempt to use netcat (`nc`) for reading UDP streams. Almost all
51+
distributed versions are broken and truncate UDP packets at 1024 bytes.
5552

5653
License
5754
-------

0 commit comments

Comments
 (0)