IPFIX Adapter Samples

About the Sample

In this sample, the TIBCO StreamBaseĀ® Adapter for IPFIX parses inbound IPFIX packets processed by a UDP adapter set to receive data on the standard IPFIX port.

An IPFIX UDP feed must be available for this sample to pull data and parse the IPFIX packets.

This sample includes a full IPFIX Enterprise 0 dictionary file for reference, located in src/main/resources/BaseDictionary.json. The dictionary contains all available entities for the base enterprise. A second dictionary src/main/resources/IPFIXDictionary.json is also included. It is an example of an actual dictionary file that you should use, as it uses multiple enterprise values but also takes only some fields from the base.

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top-level menu, select File>Import Samples and Community Content.

  • Enter ipfix to narrow the list of options.

  • Select IPFIX Parsing from the Network category.

  • Click Import Now.

StreamBase Studio creates a single project containing the sample files.

Samples Setup

Before running the samples, open the supplied src/main/resources/IPFIXDictionary.json and add, delete, or modify dictionary enterprise and entities as required for your feed.

Running This Sample in StreamBase Studio

  1. In the Project Explorer view, open the sample you just loaded.

    If you see red marks on a project folder, wait a moment for the project to load its features.

    If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven>Update Project from the context menu.

  2. Open the src/main/eventflow/com/streambase/sb/adapter/ipfix folder.

  3. Open the IPFIX.sbapp file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

  4. In the Output Streams view, look for the IPFIXData, IPFIXDictionary and IPFIXStatus tuples for the selected operation.

  5. When done, press F9 or click the Terminate EventFlow Fragment button.

Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

studio-workspace/sample_adapter_embedded_ipfix

See Default Installation Directories for the default location of studio-workspace on your system.