json

JSON storage plugin

Plugin description

Plugin converts IPFIX data into JSON format.

Format

Each data set is an array of data records.

Example:

{
	"@type": "ipfix.entry",
	"ipfix.octetDeltaCount": 3970,
	"ipfix.packetDeltaCount": 14,
	"ipfix.flowStartMilliseconds": "2015-08-03T14:10:2.012",
	"ipfix.flowEndMilliseconds": "2015-08-03T14:11:2.380",
	"ipfix.ingressInterface": 2,
	"ipfix.ipVersion": 4,
	"ipfix.sourceIPv4Address": "52.24.214.8",
	"ipfix.destinationIPv4Address": "147.175.54.248",
	"ipfix.ipClassOfService": 0,
	"ipfix.ipTTL": 52,
	"ipfix.protocolIdentifier": "TCP",
	"ipfix.tcpControlBits": ".AP.SF",
	"ipfix.sourceTransportPort": 443,
	"ipfix.destinationTransportPort": 49285,
	"ipfix.egressInterface": 0,
	"ipfix.samplingInterval": 0,
	"ipfix.samplingAlgorithm": 0
}

Configuration

Default plugin configuration in internalcfg.xml

<storagePlugin>
    <fileFormat>json</fileFormat>
    <file>/usr/share/ipfixcol/plugins/ipfixcol-json-output.so</file>
    <threadName>json</threadName>
</storagePlugin>

Or as ipfixconf output:

     Plugin type         Name/Format     Process/Thread         File
 ----------------------------------------------------------------------------
       storage              json             json          /usr/share/ipfixcol/plugins/ipfixcol-json-output.so

Here is an example of configuration in startup.xml:

<destination>
    <name>JSON storage plugin</name>
	<fileWriter>
		<fileFormat>json</fileFormat>
		<metadata>no</metadata>
		<odid>no</odid>
		<tcpFlags>formatted</tcpFlags>
		<timestamp>formatted</timestamp>
		<protocol>formatted</protocol>
		<ignoreUnknown>yes</ignoreUnknown>
		<nonPrintableChar>yes</nonPrintableChar>
		<detailedInfo>no</detailedInfo>
		<prefix>ipfix.</prefix>

		<output>
			<type>print</type>
		</output>

		<output>
			<type>send</type>
			<ip>127.0.0.1</ip>
			<port>4444</port>
			<protocol>udp</protocol>
		</output>

		<output>
			<type>file</type>
			<path>/tmp/ipfixcol/flow/%Y/%m/%d/</path>
			<prefix>json.</prefix>
			<dumpInterval>
				<timeWindow>300</timeWindow>
				<timeAlignment>yes</timeAlignment>
			</dumpInterval>
		</output>

		<output>
			<type>server</type>
			<port>4800</port>
			<blocking>no</blocking>
		</output>

		<output>
			<type>kafka</type>
			<ip>127.0.0.1</ip>
			<port>9092</port>
			<partitions>2</partitions>
			<topic>ipfix.kafkaexport</topic>
		</output>
	</fileWriter>
</destination>

• metadata - Add record metadata to the output (yes/no) [default == no].

• odid - Add source ODID to the output (yes/no) [default == no].

• tcpFlags - Convert TCP flags to formatted style of dots and letters (formatted) or to a number (raw) [default == raw].

• timestamp - Convert time to formatted style (formatted) or to a number (unix) [default == unix].

• protocol - Convert protocol identification to formatted style (formatted) or to a number (raw) [default == formatted].

• ignoreUnknown - Skip elements with unknown semantics (yes/no). Data of unknown elements are formatted as unsigned integer (1, 2, 4, 8 bytes length) or binary values. Names will have format 'eXXidYY' where XX is enterprise number and YY is element ID [default == yes].

• nonPrintableChar - Convert non-printable characters (control characters, tab, newline, etc.) from IPFIX fields with data type of a string. (yes/no) [default == yes].

• detailedInfo - Add detailed info about the IPFIX message (export time, sequence number, ...) to each record under "ipfixcol." prefix. (yes/no) [default == no].

• prefix - Prefix of the IPFIX element names. [default == ipfix.].

• output - Specifies JSON data processor. Multiple outputs are supported.

  • type - Output type. print, send, file, server. and kafka are supported.

• output : print - Writes data to the standard output.

• output : send - Sends data over the network.

  • ip - IPv4/IPv6 address of remote host (default 127.0.0.1).
  • port - Remote port number (default 4739)
  • protocol - Connection protocol, one of UDP/TCP/SCTP (default UDP). This field is case insensitive.

• output : file - Store data to files.

  • path - The path specifies storage directory for data collected by JSON plugin. Path can contain format specifier for day, month, etc. This allows you to create directory hierarchy based on format specifiers. See "strftime" for conversion specification.
  • prefix - Specifies name prefix for output files.
  • dumpInterval
    • timeWindow - Specifies the time interval in seconds to rotate files, minimum is 60 [default == 300].
    • timeAlignment - Align file rotation with next N minute interval [default == yes].

• output : server - Sends data over the network to connected clients.

  • port - Local port number.
  • blocking - Type of the connection. Blocking (yes) or non-blocking (no).

• output: kafka - Sends data to Kafka. Must be compiled with --enable-kafka, tested against version 0.8.6.

  • ip - Address of Kafka host.
  • port - Port of Kafka host.
  • partitions - Number of partitions to which send data. Uses round robin to send to partitions 0 - (N-1).
  • topic - Kafka topic to send data to.

Back to Top