SNMP Input Adapter Sample

Contents

About This Sample
Importing This Sample into StreamBase Studio
Running This Sample in StreamBase Studio
Sample Location

About This Sample

This sample demonstrates the use of the Spotfire Streaming SNMP Input Adapter.

Importing This Sample into StreamBase Studio

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

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

  • Enter snmp to narrow the list of options.

  • Select SNMP input adapter from the StreamBase Standard Adapters category.

  • Click Import Now.

StreamBase Studio creates a project for this sample.

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/packageName folder.

  3. Open the snmp.sbapp file.

  4. If you wish the adapter to listen on a UDP port different from the standard for SNMP traps (port 162):

    1. Select the adapter icon to open the Properties view for the adapter.

    2. Select the Adapter Properties tab and enter the desired UDP port number.

    3. Save the application.

  5. Click the Run button. This opens the SB Test/Debug perspective and starts the module.

  6. In the Test/Debug Perspective, open the Output Streams view. Look for a tuple emitted on the Status stream with its action value set to Connected, indicating that the adapter has established a connection to the configured port and is listening for traps.

  7. In the Manual Input view, select the Commands stream. Enter disconnect in the command field. Click Send Data and observe that a tuple has been emitted on the Status stream, and a message has been printed to the console to indicate the adapter has disconnected from the configured port.

  8. In the Manual Input view, select the Commands stream again. Enter connect in the command field. Click Send Data and observe that a tuple has been emitted on the Status stream, and a message has been printed to the console to indicate the adapter has reconnected to the port and is again listening for traps.

  9. To see traps being emitted by the adapter, you may cause one to be sent via the use of an application capable of acting as an SNMP agent and sending traps, such as the snmptrap utility included in the open-source Net-SNMP project. You can use the following snmptrap command to generate a v1 trap: 

    snmptrap -v 1 -c private localhost 
  NET-SNMP-EXAMPLES-MIB::netSnmpExampleHeartbeatNotification 
  "" 6 17 "" netSnmpExampleHeartbeatRate i 123456

    (Lines in the single command above are shown wrapped for clarity.)

  10. As traps are received by the adapter you will see a tuple emitted on the Traps stream describing its contents.

  11. 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_snmp

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