HDFS Regular Expression File Reader Input Adapter Sample

About This Sample

This sample demonstrates the use of the TIBCO StreamBase® Regular Expression File Reader for Apache Hadoop Distributed File System (HDFS) in a StreamBase application that processes a text log file, storing the information extracted from the log in a query table. The log file is typical of a server log: it contains information about user logins, as well as other, spurious information. The format of the log file means it is not particularly suited to direct use in an application. It does not, for example, consist of CSV records that are ready to be turned into tuples; it must be parsed first and useful information extracted. Because the log file is text- and line-oriented, it is well suited to parsing using regular expressions.

Keep in mind that it is difficult to observe all log reading activities. The input adapter begins reading the input file and outputting tuples as soon as the application starts, before StreamBase Studio or external dequeuers have time to connect to the output of the reader. However, the application itself is fully functional, and all tuples read from the input file will be present in the query table.

Initial Setup

You must open the RegexReader.sbapp file and select the Parameters tab and edit the value to represent both your current HDFS setup and where you would like to store the sample data. The .sbapp file is located in sample_adapter_embedded_hdfsregexreadersrc/main/eventflowcom.sample.adapter.hdfsregexreader

The samplelog.txt file used in the sample must be placed on your HDFS file system in the location you specified in the Parameters tab before this sample can run.

Importing This Sample into StreamBase Studio

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

  • From the top-level menu, click FileLoad StreamBase Sample.

  • Type hdfs to narrow the list of options.

  • Select hdfsregexreader from the Large Data Storage and Analysis category.

  • Click OK.

StreamBase Studio creates a project for the sample.

Running RegexReader.sbapp in StreamBase Studio

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

  2. Open the src/main/eventflow folder.

  3. Open the package folder (most samples contain a single package folder. Open the top-level package folder if your sample contains more than one folder).

  4. Open the named application file and click the Run button. This opens the SB Test/Debug perspective and starts the application.

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

    If red marks do not resolve themselves in a moment, select the project and right-click MavenUpdate Project from the context menu.

  5. Select the Manual Input tab.

  6. Enter joe, fred, bob, or max for Username, and click Send Data.

  7. The Application Output pane shows the time and IP address for the last queried user, according to the log.

  8. When done, press F9 or click the Stop Running Application 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_hdfsregexreader

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