Skip to content

Testing Siddhi Applications

The Streaming Integrator allows the following tasks to be carried out to ensure that the Siddhi applications you create and deploy are validated before they are run in an actual production environment.

  • Validate Siddhi applications that are written in the Streaming Integrator Studio.
  • Run Siddhi applications that were written in the Streaming Integrator Studio in either Run or Debug mode.
  • Simulate events to test the Siddhi applications and analyze events that are received and sent. This allows you to analyze the status of each query within a Siddhi application at different execution points.

Validating a Siddhi application

To validate a Siddhi application, follow the procedure below:

  1. Start and access the Streaming Integrator Studio. For detailed instructions, see Starting Stream Integration Studio .
  2. In this example, let's use an existing sample as an example. Click on the ReceiveAndCount sample to open it.
  3. Sample opens in a new tab. This sample does not have errors, and therefore, no errors are displayed in the editor. To create an error for demonstration purposes, change the count() function in the query1 query to countNew() as shown below.

    @info(name='query1') 
    from SweetProductionStream 
    select countNew() as totalCount 
    insert into TotalCountStream;      `

    Now, the editor indicates that there is a syntax error. If you move the cursor over the error icon, it indicates that countNew is an invalid function name as shown below.
    Source View indicates a syntax error

Running or debugging a Siddhi application

You can run or debug a Siddhi application to verify whether the logic you have written is correct. To start a Siddhi application in the run/debug mode, follow the procedure below:

  1. Start and access the Streaming Integrator Studio. For detailed instructions, see Starting Stream Integration Studio.

  2. For this example, click the existing sample ReceiveAndCount. It opens in a new untitled tab.

  3. Save the Siddhi file so that you can run it in the Run or Debug mode.  To save it, click File => Save.  Once the file is saved, you can see the Run and Debug menu options enabled as shown below.
    Run and Debug options enabled
    1. To start the application in Run mode, click Run => Run. This logs the following output in the console.
      Run log
    2. Start the application in the Debug mode, click Run => Debug . As a result, the following mesage is logged in the console. You can also note that another console tab is opened with debug options.
      Console with Debug Tab
  4. To create an error for demonstration purposes, change the count() function in the query1 query to countNew(), and save. Then click Run => Run. As a result, the following output is logged in the console.
    Siddhi application in a faulty state

Simulating events

This section demonstrates how to test a Siddhi application via event simulation. Event simulation involves simulating predefined event streams. These event stream definitions have stream attributes. You can use event simulator to create events by assigning values to the defined stream attributes and send them as events. This is useful for testing Siddhi applications in order to evaluate whether they function as expected

Events can be simulated in the following methods:

Tip

Before you simulate events for a Siddhi application, you need to run or debug it. Therefore, before you try this section, see Running or debugging a Siddhi application.

Simulating a single event

This section demonstrates how to simulate a single event to be processed via the Streaming Integrator.

Tip

Before simulating events, a Siddhi application should be deployed.

To simulate a single event, follow the steps given below.

  1. Access the Streaming Integrator Studio via the http://localhost:/editor URL. The Streaming Integrator Studio opens as shown below.

    Info

    The default URL ishttp://localhost:9090/editor.

    SI Studio Welcome Page

  2. Click the Event Simulator icon in the left pane of the editor to open the Single Simulation panel.
    Event Simulation icon
    It opens the left panel for event simulation as follows.
    Event Simulation Panel

  3. Enter Information in the Single Simulation panel as described  below.
    1. In the Siddhi App Name field, select a currently deployed Siddhi application.
    2. In the Stream Name field, select the event stream for which you want to simulate events. The list displays all the event streams defined in the selected Siddhi application.
    3. If you want to simulate the event for a specific time different to the current time, enter a valid timestamp in the Timestamp field. To select a timestamp, click the time and calendar icon next to the Timestamp field.
      Time and Calendar icon
      Then select the required date, hour, minute, second and millisecond. Click Done to select the time stamp entered. If you want to select the current time, you can click Now.
    4. Enter values for the attributes of the selected stream.
  4. Click Send to start sending the event. The simulated event is logged similar to the sample log given below.
    Output Log

Simulating multiple events via CSV files

This section explains how to generate multiple events via CSV files to be analyzed via the Streaming Integrator.

Tip

Before simulating events, a Siddhi application should be deployed.

To simulate multiple events from a CSV file, follow the steps given below.

  1. Access the Streaming Integrator Studio via the http://localhost:/editor URL. The Streaming Integrator Studio opens as shown below.

    Info

    The default URL ishttp://localhost:9090/editor.

    SI Studio Welcome Page

  2. Click the Event Simulator icon in the left pane of the editor.
    Event Simulator Icon

  3. In the event simulation left panel that opens, click on the Feed Simulation tab.
    Feed Simulation tab

  4. To create a new simulation, click Create . This opens the following panel.
    New feed simulatioin

  5. Enter values for the displayed fields as follows.
    1. In the Simulation Name field, enter a name for the event simulation.
    2. In the Description field, enter a description for the event simulation.
    3. If you want to receive events only during a specific time interval, enter that time interval in the Time Interval field.
    4. Click Advanced Configurations if you want to enter detailed specifications to filter events from the CSV file. Then enter information as follows.
      1. If you want to include only events that belong to a specific time interval in the simulation feed, enter the start time and the end time  in the Starting Event's Timestamp and Ending Event's Timestamp fields respectively. To select a timestamp, click the time and calendar icon next to the field.
        Time and calendar icon
        Then select the required date, hour, minute, second and millisecond. Click Done to select the time stamp entered. If you want to select the current time, you can click Now .
      2. If you want to restrict the event simulation feed to a specific number of events, enter the required number in the No of Events field.
    5. In the Simulation Source field, select CSV File .
    6. Click Add Simulation Source to open the following section.
      Simulation Source
      In the Siddhi App Name field, select the required Siddhi application. Then more fields as shown below.
      Feed simulation details
      Enter details as follows:
      1. In the Stream Name field, select the stream for which you want to simulate events. All the streams defined in the Siddhi App you selected are available in the list.
      2. In the CSV File field, select an available CSV file. If no CSV files are currently uploaded, select Upload File from the list. This opens the Upload File dialog box.
        Uploading the CSV file
        Click Choose File and browse for the CSV file you want to upload. Then click Upload .
      3. In the Delimiter field, enter the character you want to use in order to separate the attribute values in each row of the CSV file.
      4. If you want to enter more detailed specificiations, click Advanced Configuration . Then enter details as follows.
        1. To use the index value as the event timestamp, select the Timestamp Index option. Then enter the relevant index.
        2. If you want to increase the value of the timestamp for each new event, select the Increment event time by(ms) option. Then enter the number of milliseconds by which you want to increase the timestamp of each event.
        3. If you want the events to arrive in order based on the timestamp, select Yes under the Timestamp Interval option.
      5. Click Save to save the information relating to the CSV file. The name os the CSV file appears in the Feed Simulation tab in the left panel.
  6. To simulate a CSV file that is uploaded and visible in the Feed Simulation tab in the left panel, click on the arrow to its right. The simulated events are logged n the output console.

Simulating multiple events via databases

This section explains how to generate multiple events via databases to be analyzed via the Streaming Integrator.

Tip

Before simulating events via databases: - A Siddhi application must be created. - The database from which you want to simulate events must be already configured for the Streaming Integrator.

To simulate multiple events from a database, follow the procedure below:

  1. Access the Streaming Integrator Studio via the http://localhost:/editor URL. The Streaming Integrator Studio opens as shown below.

    Info

    The default URL ishttp://localhost:9090/editor.

    SI Studio Welcome Page

  2. Click the Event Simulator icon in the left pane of the editor.
    Event Simulator Icon

  3. Click the Feed tab to open the Feed Simulation panel.
    Feed Simulation tab
  4. To create a new simulation, click Create. This opens the following panel.
    New Simulation
  5. Enter values for the displayed fields as follows.

    1. In the Simulation Name field, enter a name for the event simulation.
    2. In the Description field, enter a description for the event simulation.
    3. If you want to simulate events at time intervals of a specific length, enter that length in milliseconds in the Time Interval(ms) field.
    4. If you want to enter more advanced conditions to simulate the events, click Advanced Configurations. As a result, the following section is displayed.
      Advanced onfigurations{width="442" height="191"}
      Then enter details as follows.
      1. If you want to include only events that belong to a specific time interval in the simulation feed, enter the start time and the end time  in the Starting Event's Timestamp and Ending Event's Timestamp fields respectively. To select a timestamp, click the time and calendar icon next to the field.
        Time and Calendar icon
        Then select the required date, hour, minute, second and millisecond. Click Done to select the time stamp entered. If you want to select the current time, you can click Now .
      2. If you want to restrict the event simulation feed to a specific number of events, enter the required number in the No of Events field.
    5. In the Simulation Source field, select Database . To connect to a new database, click Add Simulation Source to open the following section.
      Configuring the database
      Enter information as follows:

      Field Description
      Siddhi App Name Select the Siddhi Application in which the event stream for which you want to simulate events is defined.
      Stream Name Select the event stream for which you want to simulate events. All the streams defined in the Siddhi Application you selected are available to be selected.
      Data Source The JDBC URL to be used to access the required database.
      Driver Class The driver class name of the selected database.
      Username The username that must be used to access the database.
      Password The password that must be used to access the database.
    6. Once you have entered the above information, click Connect to Database . If the datasource is correctly configured, the following is displayed to indicate that Streaming Integrator can successfully connect to the database.
      Successfully connected to database

    7. To use the index value as the event timestamp, select the Timestamp Index option. Then enter the relevant index. If you want the vents in the CSV file to be sorted based on the timestamp, select the Yes option under CSV File is Ordered by Timestamp .
    8. To increase the timestamp of the published events, select the Timestamp Interval option. Then enter the number of milliseconds by which you want to increase the timestamp of each event.
  6. Click Save. This adds the fed simulation you created as an active simulation in the Feed Simulation tab of the left panel as shown below.
    Feed simulation added

  7. Click on the play button of this simulation to open the Run or Debug dialog box.
    Run or Debug dialog box
  8. If you want to run the Siddhi application you previously selected and simulate events for it, select Run . If you want to simulate events in the Debug mode, select Debug . Once you have selected the required mode, click Start Simulation . A message appears to inform you that the feed simulation started successfully. Similarly, when the simulation is completed, a message appears to inform you that the event simulation has finished.

Generating random events

This section explains how to generate random data to be analyzed via the Streaming Integrator.

Tip

Before simulating events, a Siddhi application should be deployed.

To simulate random events, follow the steps given below:

  1. Access the Streaming Integrator Studio via the http://localhost:/editor URL. The Streaming Integrator Studio opens as shown below.

    Info

    The default URL ishttp://localhost:9090/editor.

    SI Studio Welcome Page

  2. Click the Event Simulator icon in the left pane of the editor.
    Event Simulator Icon

  3. Click the Feed tab to open the Feed Simulation panel.
    Feed Simulation
  4. To create a new simulation, click Create . This opens the following panel.
    Create feed simulation
  5. Enter values for the displayed fields as follows.

    1. In the Simulation Name field, enter a name for the event simulation.
    2. In the Description field, enter a description for the event simulation.
    3. If you want to include only events that belong to a specific time interval in the simulation feed, enter the start time and the end time  in the Starting Event's Timestamp and Ending Event's Timestamp fields respectively. To select a timestamp, click the time and calendar icon next to the field.
      Time and Calendar icon
      Then select the required date, hour, minute, second and millisecond. Click Done to select the time stamp entered. If you want to select the current time, you can click Now .
    4. If you want to restrict the event simulation feed to a specific number of events, enter the required number in the No of Events field.
    5. If you want to receive events only during a specific time interval, enter that time interval in the Time Interval field.
    6. In the Simulation Source field, select Random.
    7. If the random simulation source from which you want to simulate events does not already exist in the Feed Simulation pane, click Add New to open the following section.
      Random Simulation Source
    8. Enter information relating to the random source as follows:

      1. In the Siddhi App Name field, s elect the name of the Siddhi App with the event stream for which the events are simulated.
      2. In the Stream Name field, select the event stream for which you want to simulate events. All the streams defined in the Siddhi Application you selected are available to be selected.
      3. In the Timestamp Interval field, enter the number of milliseconds by which you want to increase the timestamp of each event.
      4. To enter values for the stream attributes, follow the instructions below.

        • To enter a custom value for a stream attribute, select Custom data based from the list. When you select this value, data field in which the required value can be entered appears as shown in the example below.
          Custom data based simulation{width="235" height="88"}
        • To enter a primitive based value, select Primitive based from the list. The information to be entered varies depending on the data type of the attribute. The following table explains the information you need to enter when you select Primitive based for each data type.

          Data Type Values to enter
          STRING Specify a length in the Length field that appears. This results in a value of the specified length being auto-generated.
          FLOAT or DOUBLE The value generated for the attribute is based on the following values specified.
          • Min : The minimum value.
          • Max : The maximum value.
          • Precision : The precise value. The number of decimals included in the auto-generated values are the same as that of the value specified here.
          INT or LONG The value generated for the attribute is based on the following values specified.
          • Min : The minimum value.
          • Max : The maximum value.
          BOOL No further information is required because true and false values are randomly generated.

        • To randomly assign values based on a pre-defined set of meaningful values, select Property based from the list. When you select this value, a field in which the set of available values are listed appears as shown in the example below.
          Property-based simulation

        • To assign a regex value, select Regex based from the list.
  6. Click Save to save the simulation information.  The saved random simulation appears in the Feed tab of the left panel.

  7. To simulate events, click the arrow to the right os the saved simulation (shown in the example below).
    Simulating random events
    The simulated events are logged in the CLI as shown in the extract below.
    Random Events Output Log
Top