| Oracle® CEP Visualizer User's Guide Release 11gR1 (11.1.1) E14302-02 |
|
 Previous |
 Next |
This section contains information on the following topics:
Oracle CEP Visualizer is a Web 2.0 application that consumes data from Oracle Complex Event Processing Server (or Oracle CEP for short), displays it in a useful and intuitive way to system administrators and operators, and, for specified tasks, accepts data that is then passed back to Oracle CEP so as to change its configuration.
In particular, you can use the tool to perform the following tasks:
View the structure of an Oracle CEP domain
Manage security
Configure Oracle CEP server instances
Install, uninstall, suspend, resume, and update applications
View, update, create, and delete Oracle CQL and EPL rules
View the EPN associated with an application
Tune application parameters and monitor application status
Record and playback of events flowing through the EPN.
Create diagnostic profile to monitor application stage latency and throughput.
Monitor and perform diagnosis on your CQL Processor with Query Plan.
Manage and create server wide resources such as HTTP publish-subscribe channels and data sources.
Dynamically turn server and application logging on and off.
Manage Oracle Coherence cluster and server instances.
This section describes:
Section 1.1.1, "Understanding the Oracle CEP Visualizer User Interface"
Section 1.1.2, "Understanding Oracle CEP Visualizer Administration Tasks"
Oracle CEP Visualizer has three main panes, as shown in Figure 1-1.
Figure 1-1 Sample Oracle CEP Visualizer Window
Top Pane: Includes the most used buttons, such as a
Home button that takes you to the main Oracle CEP Visualizer page.
Security button that takes you to the security page in which you can add or configure users and groups and map users to application roles and task roles; see Chapter 4, "Security Tasks" for details.
Dashboard button takes you to the performance management screen that you use to monitor the throughput and latency of a running application and its stages; see Section 1.1.1.1, "Overview of the Oracle CEP Visualizer Dashboard" for more information.
ViewStream button takes you to a screen from which you can monitor the messages streaming through the configured HTTP publish-subscribe channels; see Section 1.1.1.2, "Overview of the Viewstream Panel" for more information.
Full Screen button fills your entire computer screen with the Oracle CEP Visualizer tool; press the Esc key to return to a normal screen.
Preferences button takes you to a page where you can set user preferences, such as the language and maximum number of open panes, and accessibility settings such as restricting the maximum number of open panes to 1 and disabling Full Screen mode.
Help button takes you to the task-oriented online-help hosted by the Oracle CEP server.
Left Pane: Displays a domain tree for the domain that includes all the objects contained in the domain, such as the Oracle CEP server instances, the deployed applications and services within each server instance, and domain-level security configuration.
The domain name is determined by the Oracle CEP server config.xml file domain element. For example, the domain tree is named mydomain if your config.xml file is like this:
<domain>
<name>mydomain</name>
</domain>
The Open Items box in the lower half of the left pane lists the items that are currently open, making it easy to return to or close the windows after you have navigated away from them. Any open panels that require refresh are marked with a red X in the Open Items list. For more information, see Section 1.1.1.3, "Oracle CEP Visualizer Panels that Require Refresh".
Right Pane: A multi-document container. When you open multiple documents, the documents are overlaid one on top of the other.
This pane displays information about objects that you have clicked on in the left pane. The format of the information depends on the object; for example, if you click on a deployed application in the domain tree in the left pane, the right pane shows general information about the application (General tab) as well as various visual representations of the event processing network of the application (Event Processing Network tab). If you click on a particular stage of the network, such as a stream or processor, the right pane shows general information about it as well as stage-specific information, such as the rules for a processor.
Any open panels that require refresh are marked with a red X in the title of the panel. For more information, see Section 1.1.1.3, "Oracle CEP Visualizer Panels that Require Refresh".
Table 1-1 describes the buttons in the top right corner of the right pane that you can use to manage panels. Note that these buttons are not visible if you set the Max Open Panels preference to 1 (see Section 1.3, "Managing User Preferences").
Figure 1-1 shows a domain that contains a single server instance called NonClusteredServer. The server contains four deployed applications: com.bea.wlevs.dataservices, cql, fx, and signalgeneration; the signalgeneration application is currently opened. The right pane contains the configuration of the rules of the processor1 stage; in particular, processor1 has been configured with rules vTrend, trend, percent, and S. The application called com.bea.wlevs.dataservices is associated with Oracle CEP Visualizer itself and is always deployed in an Oracle CEP server instance. Section 1.1.2.1.1, "The com.bea.wlevs.dataservices Application" for details.
Figure 1-2 shows the Oracle CEP Visualizer dashboard: a performance management screen that you use to monitor the throughput and latency of a running application and its stages or a path between two stages. You get to the dashboard by clicking the Dashboard button in the top pane.
Figure 1-2 Oracle CEP Visualizer Dashboard
The dashboard has two main sections:
Management Events: the section at the top of the dashboard displays information and warning messages about the incoming monitoring events. Click the Warning bar to view the list of warning messages; click the Information bar to view the list of information messages. The Oracle CEP 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 Section 2.5.4, "Changing the dataservices Application Event Filter Rule Using EPL".
Performance Monitoring: the latency and throughput graphs display the amount of time it takes an event to pass through the specified stage or path in the EPN or the number of events passing through, respectively. The stage or path is defined in the diagnostic profile. The table at the bottom lists the available diagnostic profiles; when you click on a particular profile, the corresponding latency and throughput information is displayed in the graphs. See Section 2.2.4, "Monitoring the Throughput and Latency of a Stage or Path in the EPN" for details.
For detailed instructions on how to use this monitoring feature, see Section 2.2.4, "Monitoring the Throughput and Latency of a Stage or Path in the EPN".
The main purpose of the Viewstream panel is to allow users to watch events being published to a given HTTP publish-subscribe channel without any additional work. This is useful for debugging your application or just monitor events flowing through the EPN.
Click the Viewstream button in the top panel of Oracle CEP Visualizer, to display the Stream Visualizer panel.
Figure 1-3 Oracle CEP Visualizer Stream Visualizer
The Pub/Sub Server URL text box displays the HTTP pub-sub server URL included with Oracle CEP. Click the Initialize Client button to start the process. You can either subscribe or publish a message to a channel using the options mentioned in this panel.
To subscribe to user and internal channels, enter the channel name (beginning with a /) in the Subscribe Channel text box and click Subscribe. For more information on obtaining information on available channels, see Section 3.5.1, "How to View HTTP Publish-Subscribe Server Channels".
To publish a message to a channel, enter its name (again with a beginning /) in the Publish Channel text box, enter the message in the Publish Message text box, and then click Publish. The message itself must be a JSON style message.
The Debug Messages pane is displayed at the bottom of the Stream Visualizer panel, which displays the timestamp along with the status of the action performed.
See Section 3.5.4, "How to View Messages Published to HTTP Publish-Subscribe Server Channels" for detailed instructions on how to use this monitoring feature.
Some operations, such as uninstalling and redeploying an application, will require you to refresh open panels.
When CEPVIS receives a notification for application re-deployment, it goes though all the affected panels that are still opened and marks the title of the panel with a red X to indicate that this panel is obsolete. To refresh such a panel, close and then re-open the panel.
For example, Figure 1-4 shows the Event Processing Network tab for an application that has been redeployed.
Figure 1-4 Event Processing Network Tab - Requiring Refresh
This section describes the principle administration tasks you can perform using the Oracle CEP Visualizer, including:
Using Oracle CEP Visualizer, you can monitor and configure applications you develop and deploy as well as applications that Oracle CEP server deploys such as the com.bea.wlevs.dataservices application. You can monitor and configure the Event Processing Network (EPN), application lifecycle, and Oracle CQL and EPL rules.
For more information, see:
The com.bea.wlevs.dataservices application, called dataservices for short, is internal to Oracle CEP Visualizer and is automatically deployed every time you start an Oracle CEP server instance. You are not allowed to uninstall the dataservices application.
The purpose of this application is to provide a filter for diagnostic monitoring metrics. The application is itself an Oracle CEP application made up of adapters, streams, and a processor. The processor includes the following default EPL rule used to filter the metrics; this rule determines which event show up in the Diagnostics dashboard. The rule is as follows:
SELECT * FROM DSMonitorEvent RETAIN 1 EVENT WHERE metric > 10000
You can change this rule if you want to customize the filtering of events. See Section 2.5.4, "Changing the dataservices Application Event Filter Rule Using EPL" for details.
Using Oracle CEP Visualizer, you can manage Oracle CEP server instances and the services they provide such as JMX, data sources, Jetty Web server, work managers, the persistent event store, event type repository, HTTP publish-subscribe server, and logs.
For more information, see Chapter 3, "Server and Domain Tasks".
Using Oracle CEP Visualizer, you can manage Oracle CEP server and application security including users, groups, and roles, SSL, and HTTP publish-subscribe server access.
For more information, see Chapter 4, "Security Tasks".
Although you can update much of the configuration of an Oracle CEP instance and its deployed applications, not all fields can be updated. The following rules determine what fields can be updated:
Information in the EPN assembly file is static and thus read-only. Examples of this type of information include the stages of the EPN and how they are wired together.
Information in the component configuration files can be modified, although not typically added to or deleted from; the next bullet lists the two exceptions. Examples of this type of information include the maximum size and threads of a stream.
When you are allowed to update fields on a Oracle CEP Visualizer window, you will see three buttons: Edit, Save, and Cancel. Click the Edit button to modify the fields, then click Save to commit the changes to the server or Cancel to cancel.
The Oracle CQL and EPL rules associated with a processor and the channels associated with an HTTP publish-subscribe server cannot be modified, but you can add or delete to the existing list of rules or channels.
For these two scenarios you will see buttons for adding and deleting rules or channels; the Modify button will not be provided.
Some information in the Oracle CEP server's configuration file (config.xml) can be modified, although much of it is read-only. An example of this type of information includes the configuration of work managers, the logging service, and user-defined channels of the HTTP publish-subscribe server.
|
Note: Do not modify or delete the internal channels of the HTTP publish-subscribe server. If you modify or delete these internal channels, Oracle CEP Visualizer will not function properly |
Server configuration updates also use the three buttons: Edit, Save, and Cancel.
|
Note: The preceding rules assume that you have logged onto Oracle CEP Visualizer with the required authentication credentials for performing the desired update task. |
For more information, see Oracle CEP Administrator's Guide.
Oracle CEP Visualizer provides valuable services to a variety of Oracle CEP users, including:
Administrators who use Oracle CEP Visualizer to connect to an Oracle CEP instance use role-based authorization to gain access. Users that successfully authenticate themselves when using Oracle CEP Visualizer are assigned roles based on their group membership, and then subsequent access to administrative functions is restricted according to the roles held by the user. Anonymous users (non-authenticated users) will not have any access to Oracle CEP Visualizer.
When an administrator uses the Configuration Wizard to create a new domain, they enter an administrator user that will be part of the wlevsAdministrators group. By default, this information is stored in a file-based provider filestore. The password is hashed using the SHA-256 algorithm. Once the domain has been created, the administrator can create new groups using Oracle CEP Visualizer, assign roles to them, and then create new users and assign them to groups.
For more information, see Section 4.1.1, "Users, Groups, and Roles".
|
Note: The security features of Oracle CEP Visualizer work only if you have security enabled for Oracle CEP server. If you disable Oracle CEP server security, then:
For more information, see "Enabling and Disabling Security" in the Oracle CEP Administrator's Guide |
Developers can use Oracle CEP Visualizer to view server resources (such as data sources), perform event record and playback, and trouble shoot performance issues by turning on latency and throughput statistics.
Business users can use the Oracle CEP Visualizer Query Wizard to create and modify queries within a given processor. This allows rule experts to manage Oracle CQL queries and views with minimal development assistance.
Before you start Oracle CEP Visualizer, ensure that your system meets the minimum prerequisites as Section 1.2.1, "Prerequisites" describes.
Choose how you want to start Oracle CEP Visualizer:
Section 1.2.2, "How to Start Oracle CEP Visualizer Using a Browser"
Section 1.2.3, "How to Start Oracle CEP Visualizer Using Oracle CEP IDE for Eclipse"
Section 1.2.4, "How to Start Oracle CEP Visualizer in a Multi-Server Domain"
After you start Oracle CEP Visualizer, you are ready to begin using Oracle CEP Visualizer to manage, configure, and monitor Oracle CEP instances and the applications deployed to the server instances. For information on typical tasks, see:
Oracle CEP Visualizer is itself an Oracle CEP application that is automatically deployed each time you start a server. You invoke Oracle CEP Visualizer in a browser to use it.
For best performance, install version 10,0,22,87 of the Adobe Flash Player. Go to the Version test for Adobe Flash Player Web site (http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_15507) for instructions on testing the current version of Flash Player installed on your computer. For more information, see http://www.adobe.com/products/flashplayer/.
Oracle recommends that you use Internet Explorer 7 or higher.
For some Oracle CEP Visualizer tasks, you must log into Oracle CEP Visualizer using an Oracle CEP server account configured for the administrator role. For more information, see Section 4.1.1, "Users, Groups, and Roles".
You can start the Oracle CEP Visualizer using any browser that meets the minimum perquisites as Section 1.2.1, "Prerequisites" describes.
To start Oracle CEP Visualizer using a browser:
Invoke the following URL in your browser:
http://host:port/wlevs
where host refers to the name of the computer on which Oracle CEP is running and port refers to the Jetty NetIO port configured for the server (default value 9002).
The port number is configured in the config.xml file in the ORACLE_CEP_HOME/user_projects/domains/DOMAIN_DIR/servername/config directory, where ORACLE_CEP_HOME refers to the Oracle CEP installation directory (such as d:/oracle_cep), DOMAIN_DIR refers to the domain directory (such as my_domain), and servername refers to the server instance directory (such as server1). The port number is the value of the port child element of the netio object configured for the Jetty server, as shown in the following example (only relevant parts shown):
<netio>
<name>NetIO</name>
<port>9002</port>
</netio>
...
<jetty>
<name>JettyServer</name>
<network-io-name>NetIO</network-io-name>
...
</jetty>
For example, if your browser is running on the same computer as Oracle CEP and you are using the default port, invoke the following URL:
http://localhost:9002/wlevs
If you want to use HTTPS to connect to Oracle CEP Visualizer, specify the SSL port number. This is the port assigned to the netio element referenced by the secure-network-io-name Jetty element. The default value is 9003.
For example, if you have the following configuration (only relevant parts shown):
<netio>
<name>sslNetIo</name>
...
<port>9003</port>
</netio>
<jetty>
...
<secure-network-io-name>sslNetIo</secure-network-io-name>
</jetty>
use the following URL:
https://localhost:9003/wlevs
The Logon screen appears as Figure 1-5 shows.
Figure 1-5 Oracle CEP Visualizer Logon Screen
In the Logon screen, enter the name and password of the administrator user you configured when you created the domain.
|
Note: The security features of Oracle CEP Visualizer work only if you have security enabled for Oracle CEP server. If you disable Oracle CEP server security, then:
For more information, see "Enabling and Disabling Security" in the Oracle CEP Administrator's Guide |
Click Logon.
Oracle provides an IDE targeted specifically to programmers that want to develop Oracle CEP applications. Oracle CEP IDE for Eclipse is a set of plugins for the Eclipse IDE designed to help develop, deploy, and debug applications for Oracle CEP. You can start the Oracle CEP Visualizer from within the Oracle CEP IDE for Eclipse to make using Oracle CEP Visualizer a seamless part of Oracle CEP application development.
For more information, see "How to Start the Oracle CEP Visualizer from Oracle CEP IDE for Eclipse" in the Oracle CEP IDE Developer's Guide for Eclipse.
You can use Oracle CEP Visualizer to administer a multi-server domain. As described in Section 1.2.2, "How to Start Oracle CEP Visualizer Using a Browser," Oracle CEP Visualizer works by connecting to one particular Oracle CEP server, based on its host and port.
In the case of a multi-server domain, you connect to one Oracle CEP server in the domain and then access the other servers from that server. All servers in a multi-server domain are candidates to host Oracle CEP Visualizer, from which you administer all the other servers in the domain. However, considering the performance factor, it is recommended that you select one server to host Oracle CEP Visualizer and disable Oracle CEP Visualizer access from all servers except for one in the multi-server domain.
To avoid a single point of failure, consider enabling Oracle CEP Visualizer on a small subset of n machines in the domain.
When using Oracle CEP Visualizer in a multi-server domain, the navigation tree in the left pane is automatically refreshed to reflect changes in the domain. For example, when a new server joins the domain, it automatically shows up in the navigation tree. Conversely, if the server leaves the domain, the server automatically disappears from the navigation tree.
|
Note: To manage multiple Oracle CEP servers using Oracle CEP Visualizer when the Oracle CEP servers are distributed to different machines, theserver-host-name attribute is mandatory. You must configure cluster element child element server-host-name in the config.xml of each Oracle CEP server.
If all the Oracle CEP servers in your multi-server domain are on the same host, this element is optional. For more information, see "Administrating Oracle CEP Multi-Server Domains" in the Oracle CEP Administrator's Guide. |
You can perform configuration management, of both the servers and applications, and operation management (such as diagnostics and event record and playback) on all servers in the multi-server domain.
To start Oracle CEP Visualizer in a multi-server domain:
Create a multi-server domain.
For example, assume you have a multi-server domain with three servers (defaultserver, server1, and server2). Each server directory is a child directory of the domain directory, which is /oracle_cep/user_projects/domains/myDomain.
For more information, see "Administrating Oracle CEP Multi-Server Domains" in the Oracle CEP Administrator's Guide.
Configure SSL to secure communication between the servers in the multi-server domain.
For more information, see "Securing the Messages Sent Between Servers in a Multi-Server Domain" in the Oracle CEP Administrator's Guide.
Choose one Oracle CEP server in the multi-server domain to host Oracle CEP Visualizer access.
In this example, defaultserver will host Oracle CEP Visualizer access.
Specify the -disablevisualizer flag when you start the other servers in the multi-server domain that will not provide access to Oracle CEP Visualizer.
You want the defaultserver to host Oracle CEP Visualizer and thus must disable access to Oracle CEP Visualizer from the other two servers. In this case, you would start each server as follows:
prompt> cd /oracle_cep/user_projects/domains/myDomain/defaultserver prompt> startwlevs prompt> cd ../server1 prompt> startwlevs -disablevisualizer prompt> cd ../server2 prompt> startwlevs -disablevisualizer
Configure SSL to secure communication between Oracle CEP Visualizer and defaultserver.
For more information, see "How to Configure SSL in a Multi-Server Domain for Oracle CEP Visualizer" in the Oracle CEP Administrator's Guide.
Start Oracle CEP Visualizer.
For more information, see:
Oracle CEP Visualizer allows you to customize its behavior using user preferences.
You can use Oracle CEP Visualizer to manage user preferences.
To manage user preferences:
Click the Preference button at the top-right corner of any Oracle CEP Visualizer screen. The Preference screen appears in the right panel, as shown in Figure 1-6.
Update the preferences as Table 1-2 describes:
Table 1-2 Oracle CEP Visualizer Preferences Attributes
| Attribute | Description |
|---|---|
|
|
Select the language that Oracle CEP Visualizer uses. Default: English. For more information, see Section 1.5, "National Language Support". |
|
|
Set the time, in minutes, after which the client (browser) times out and automatically logs you out. Default value is 20 minutes, maximum 30. |
|
|
Set the maximum number of open items that will appear in the Open Items frame in the lower left corner. Default value is 5; maximum value is 10. NOTE: For users that require accessibility, set the maximum open items to 1 to make keyboard navigation easier to use. For more information, see Section 1.4, "Accessibility". |
|
|
Click whether you want the domain tree in the left panel to be fully expanded every time you start Oracle CEP Visualizer |
|
|
Click whether you want to enable the full screen function in Oracle CEP Visualizer. NOTE: For users that require accessibility, uncheck this item. For more information, see Section 1.4, "Accessibility" |
Click Save.
When the preferences have been successfully modified, a confirmation message appears momentarily.
Oracle CEP Visualizer is a Web application that uses Adobe Flex. This section describes how to improve the accessibility of Oracle CEP Visualizer when using a screen reader like JAWS.
For more information, see:
To improve Oracle CEP Visualizer accessibility:
Open the Oracle CEP Visualizer preferences panel.
Set the Max Opened Panels option to 1.
Uncheck the Enable Fullscreen option.
Click Save.
Oracle CEP Visualizer observes Java localization and supports the use of double-byte characters in all configuration files and Oracle CEP Visualizer text entry fields.
This section describes topics of interest when using Oracle CEP Visualizer with double-byte locales, including:
|
Note: By default, Oracle CEP Visualizer ships with an English resource bundle that supplies all the text that appears in the Oracle CEP Visualizer user interface. |
Oracle CEP server encodes all configuration XML files using UTF-8 encoding. This encoding is specified in the header of all Oracle CEP configuration XML files. Example 1-1 shows the encoding specified in the config.xml file.
Example 1-1 UTF-8 Encoding Attribute in Oracle CEP Server config.xml
<?xml version="1.0" encoding="UTF-8"?>
<n1:config xsi:schemaLocation="http://www.bea.com/ns/wlevs/config/server wlevs_server_config.xsd" xmlns:n1="http://www.bea.com/ns/wlevs/config/server" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<domain>
<name>WLEventServerDomain</name>
</domain>
<netio>
<name>NetIO</name>
<port>9002</port>
</netio>
...
</config>
When manually editing an Oracle CEP configuration XML file, be sure to save the file in UTF-8 encoding. Some editors will automatically save configuration XML files in the correct encoding based on the encoding attribute. However, some editors will not automatically save configuration XML files in the correct encoding. In this case, you must ensure that you select UTF-8 encoding when you save an Oracle CEP configuration XML file.
You can enter double-byte characters in any Oracle CEP Visualizer text field. The Oracle CEP Visualizer and Oracle CEP server will always write configuration XML files in the correct UTF-8 encoding.
|
 Copyright © 2007, 2009, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|