Visualizer Help

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Typical Application Tasks

This section contains the typical application tasks you can perform with Oracle CEP Visualizer.

Visualizer is fairly self-explanatory and intuitive, so not all tasks are discussed here, but rather, just those that are most common and typical and from which other similar tasks can be deduced.

This section describes how to:

 

Monitor the throughput and latency of a stage or path in the EPN of an application.

You can use Visualizer to monitor a stage or a path in the event processing network (EPN) of an application. Oracle CEP defines the following metrics that you can monitor for each stage or path:

The Visualizer monitoring feature is itself implement as an Oracle CEP application; this means that the diagnostic information can be viewed as an event, and the application uses EPL rules to process these diagnostic events. This means that you can update these EPL rules to customize the behavior of the monitoring feature, in particular to detect patterns and trends in the diagnostic events.

To use Visualizer to monitor a stage or path of the EPN, follow these steps:

  1. Create a diagnostic profile that describes the stages or path you want to monitor as well as the type of latency and throughput information you want to gather.

    2. See Create a Diagnostic Profile.

  2. Click the Dashboard link at the top of Visualizer to go to the diagnostics dashboard window.
  3. Drag the diagnostic profile you created in a preceding step from the domain tree in the left pane to the table at the bottom of the right pane; drop the diagnostic profile into the Profile Name column of the table.
  4. Click on the name of the diagnostic profile in the table; you should start seeing latency and throughput information in the graphs in the middle of the dashboard.
  5. The Management Events section at the top of the Dashboard displays alerts about the incoming monitoring events. The Visualizer monitoring feature defines a set of default EPL rules that specify when these alerts show up in the Management Events table; you can change the EPL rules to customize this behavior. See Customize the Behavior of the Diagnostic Monitoring for details.

Create a Diagnostic Profile

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which the application is deployed.
  2. Expand the appname > Stages node to see a list of the EPN stages in the domain tree.
  3. Click on the stage of the application for which you want to monitor its latency or throughput, or the first stage in the path that you want to monitor.
  4. In the right pane, click the General tab.
  5. Click the Create Diagnostics button. An accordion menu with three tabs appears.
  6. Click the top Diagnostic Profile Information tab and enter the information as follows:
    • Enter the name of the diagnostic profile you are about to create in the Profile Name field.
    • Select whether you want to enable the profile for immediate use.
  7. Click the Latency tab in the accordion menu. Enter the information about the type of monitoring information you want to gather about latency in the Diagnostic Information section as follows:
    • Max Latency Metric—Specifies that you want to monitor the maximum amount of time it takes for events to flow through a stage or a subset of the event processing network (path).
    • Average Latency Metric—Specifies that you want to monitor the average amount of time it takes for events to flow through a stage or a subset of the event processing network (path).
    • Threshold—Specifies threshold for the average latency monitoring. This value is enabled only if you specify Average Latency Metric.
    • Time Unit—Specifies the time units for the threshhold and average interval fields.
    • Average Interval—Specifies the time interval for which you want to gather diagnostic data.

      • Update the Path Information section as follows:

    • If you want to monitor just the current stage, rather than a path in the EPN, set the Start and End Stage Name to the name of the current stage. Select Entry for the Start Stage Name and Exit for the End Stage Name.
    • If you want to monitor a path in the EPN, Visualizer assumes that the current stage is the start of the path, and thus automatically selects it for the Start Stage Name field. Specify whether the start of the path should be the entry or exit of the current stage. Then select the End Stage name, or the end of the path you want to monitor, and specify whether the end of the path should be the entry or exit of the stage.
  8. Click the Throughput tab in the accordion menu. Enter the information about the type of monitoring information you want to gather about throughput as follows:
    • Average Throughput Metric—Specifies that you want to monitor the average throughput of events flowing through the stage.
    • Stage Name—Specify whether you want to monitor the throughput at the entry or exit of the stage.
    • Time Unit—Specifies the time units for the average interval fields.
    • Throughput Interval—Specifies the time interval for which you want to gather metrics.
    • Average Interval—Specifies the interval for gathering the average throughput.
  9. Click Save. The saved diagnostic profile appears in the left domain tree, under the stage from which you created it.

Customize the Behavior of the Diagnostic Monitoring

No documentation available for Beta.

 

View the event processing network (EPN) of an application

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which the application is deployed.
  2. Click the name of the application shown below the Applications node.
  3. In the right pane, click the Event Processing Network tab.
  4. In the Layout drop-down choice box, chose your favorite layout, such as hierarchic or organic.
  5. Alternately, expand the appname > EPN node in the left pane to see a list of the EPN stages in the domain tree. Click on an individual stage to see its configuration.

 

Record and Play Back Events Flowing Through an EPN

The event repository feature of Oracle CEP allows you to record events flowing through an event processing network (EPN) and store them so you can later play back the events. The event repository is configured per stage, such as a processor or stream.

You cannot dynamically create the record and playback configuration in Visualizer. Instead, you must manually add the initial parameters to the configuration file of the stage you want to record using an IDE or your favorite XML editor. After that you can use Visualizer to modify the record and playback operations.

You can add only one entry per stage for the record and playback operations.

  1. Using your favorite XML editor or IDE, edit the configuration file of the stage for which you want to configure record and playback. Add a <record-parameters> child element of the stage (<processor>, <stream>, or <adapter>) to configure a record operation and a <playback-parameters> child element to configure a playback operation. The following example shows how to add record and playback to the helloworldProcessor of the HelloWorld sample application; relevant sections shown in bold:
    2.     <processor>
            <name>helloworldProcessor</name>
            <record-parameters>
                <dataset-name>test1data</dataset-name>
                <event-type-list>
                    <event-type>HelloWorldEvent</event-type>
                </event-type-list>
                <provider-name>test-rdbms-provider</provider-name>
                <time-range>
                    <start>2008-03-03T17:32:02.000-05:00</start>
                    <end>2008-03-03T17:33:02.000-05:00</end>
                </time-range>
                <batch-size>1</batch-size>
                <batch-time-out>10</batch-time-out>
            </record-parameters>
            <playback-parameters>
                <dataset-name>test1data</dataset-name>
                <event-type-list>
                    <event-type>HelloWorldEvent</event-type>
                </event-type-list>
                <provider-name>test-rdbms-provider</provider-name>
                <time-range>
                    <start>2008-03-03T17:32:02.000-05:00</start>
                    <end>2008-03-03T17:33:02.000-05:00</end>
                </time-range>
                <playback-speed>1.0</playback-speed>
                <loopback>false</loopback>
            </playback-parameters>
            <rules>
                <rule id="helloworldRule"> select * from HelloWorldEvent retain 1 event </rule>
            </rules>
            <bindings/>
        </processor>
  2. Redeploy the application so the new configuration takes effect.
  3. Invoke Visualizer.
  4. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which the application is deployed.
  5. Expand the appname > Stages node to see a list of the EPN stages in the domain tree.
  6. Click on the stage for which you added record and playback configuration to its configuration file.
  7. In the right pane, click the Record tab.
  8. If you want to change the time to start and end recording, click on the entry in the table, update the dates in the Change Schedule area, then click Update Schedule.
  9. Click Start Recording to start recording, End Recording to end.
  10. To playback, click the Playback tab. The buttons below work similarly to those of the Record tab.

 

Add or delete rules from a processor

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which the application is deployed.
  2. Expand the appname > Stages node to see a list of the EPN stages in the domain tree.
  3. Click on the processor to which you want to add or delete rules.
  4. In the right pane, click the Rules tab.
  5. To delete a rule, select a rule in the table and click Delete Rule.
  6. To add a rule, enter the rule ID and rule text in the boxes at the bottom of the page, then click New Rule.
Note: You cannot change an existing rule using Visualizer.

 

View and change the configuration of a stage

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which the application is deployed.
  2. Expand the appname > Stages node to see a list of the EPN stages in the domain tree.
  3. Click on the stage whose configuration you want to update.
  4. In the right pane, click the General tab.
    5. Note: Not all stage’s configuration can be updated by Visualizer. A Modify button will appear if the configuration can be updated.
  5. If a stage’s configuration can be updated, click Modify.
  6. Enter the new values.
  7. Click Commit.

 

Deploy an application

Deploying an application refers to uploading to the server the JAR file that contains the application and then installing it, which makes it available to clients.

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which you want to deploy the application.
  2. In the right pane, click the Deployment tab.
  3. Click the Install button.
  4. Click the Upload tab.
  5. Click on the "..." button to invoke a file browsing window, browse to the directory that contains the JAR file of application, and click Open.
  6. Click Upload. The JAR file appears in the table of applications.
  7. Click the Install button and select your application in the table.
  8. Click Deploy.
  9. Click OK.

Your application is deployed and ready for clients to use.

 

Uninstall an application

When you uninstall an application, you completely remove it from the server so that clients can no longer access it.

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which you want to uninstall the application.
  2. In the right pane, click the Deployment tab.
  3. In the Deployments table, select the application you want to uninstall by checking the box to the left of its name.
  4. Click Uninstall.
  5. Click OK.

 

Suspend or Resume an application

  1. In the left pane, navigate to and expand the Applications node of the Oracle CEP instance to which you want to suspend or resume an application.
  2. In the right pane, click the Deployment tab.
  3. In the Deployments table, select the application you want to suspend or resume by checking the box to the left of its name.
  4. Click Suspend to suspend the application or Resume to resume the application.
  5. Click OK.

  Back to Top       Previous  Next