This appendix provides a reference to the Oracle Event Processing wlevs.Admin
utility, which you can use to administer Oracle Event Processing, dynamically configure rules for Oracle Continuous Query Language processors, and monitor event latency and throughput.
This appendix includes the following sections:
The wlevs.Admin
utility is a command-line interface to administer Oracle Event Processing and, in particular, dynamically configure the rules for Oracle CQL and EPL processors and monitor the event latency and throughput of an application. The utility internally uses JMX to query the configuration and runtime MBeans of both the Oracle Event Processing server and deployed applications.
The Oracle Event Processing configuration framework allows concurrent changes to both the application and Oracle Event Processing server configuration by multiple users. The framework does not use locking to manage this concurrency, but rather uses optimistic version-based concurrency. This means that two users can always view the configuration of the same object with the intention to update it, but only one user is allowed to commit their changes. The other user will then get an error if they try to update the same configuration object, and must refresh their session to view the updated configuration.
Each wlevs.Admin
utility command runs in its own transaction, which means that there is an implicit commit after each execution of a command. If you want to batch multiple configuration changes in a single transaction, you must use JMX directly to make these changes rather than the wlevs.Admin
utility.
Before you can use the wlevs.Admin
utility, you must configure your environment appropriately.
To configure the wlevs.Admin utility environment:
Install and configure the Oracle Event Processing software, as described in ”Installing Oracle Event Processing” in the Oracle Fusion Middleware Getting Started Guide for Oracle Event Processing.
Configure JMX connectivity for the domain you want to administer. See Chapter 12, "Configuring JMX for Oracle Event Processing."
Open a command window and set your environment as described in ”Setting Your Development Environment” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse.
Set your CLASSPATH
in one of the following ways:
Implicitly set your CLASSPATH
by using the -jar
argument when you run the utility.
Set the argument to the ORACLE_CEP_HOME
/ocep_11.1/bin/wlevsadmin.jar
file, where ORACLE_CEP_HOME
refers to the main Oracle Event Processing installation directory.
When you use the -jar
argument, you do not specify the wlevs.Admin
utility name at the command line. For example:
prompt> java -jar d:/oracle_cep/ocep_11.1/bin/wlevsadmin.jar -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector UPLOAD -application helloworld -processor helloworldProcessor -sourceURL file:///d:/test/newrules2.xml
Explicitly update your CLASSPATH
by adding the following files to the CLASSPATH
environment variable:
ORACLE_CEP_HOME/ocep_11.1/bin/wlevsadmin.jar ORACLE_CEP_HOME/ocep_11.1/bin/wlevs.jar ORACLE_CEP_HOME/ocep_11.1/modules/com.bea.wlevs.deployment.server_11.1.0.0.jar ORACLE_CEP_HOME/ocep_11.1/modules/com.bea.wlevs.ede_11.1.0.0.jar ORACLE_CEP_HOME/ocep_11.1/modules/com.bea.wlevs.management_11.1.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.jndi.context_6.0.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.jmx_6.0.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.rmi_6.0.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.i18n_1.4.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.diagnostics.core_2.1.0.0.jar ORACLE_CEP_HOME/modules/javax.xml.stream_1.1.1.0.jar ORACLE_CEP_HOME/com.bea.core.bootbundle_8.0.0.0.jar
Where ORACLE_CEP_HOME
refers to the main directory into which you installed Oracle Event Processing.
Sometimes it is useful to run the wlevs.Admin
utility on a computer different from the computer on which Oracle Event Processing is installed and running.
To run the wlevs.Admin utility remotely:
Copy the following JAR files from the computer on which Oracle Event Processing is installed to the computer on which you want to run wlevs.Admin
; you can copy the JAR files to the directory name of your choice:
ORACLE_CEP_HOME/ocep_11.1/bin/wlevsadmin.jar ORACLE_CEP_HOME/ocep_11.1/bin/wlevs.jar ORACLE_CEP_HOME/ocep_11.1/modules/com.bea.wlevs.deployment.server_11.1.0.0.jar ORACLE_CEP_HOME/ocep_11.1/modules/com.bea.wlevs.ede_11.1.0.0.jar ORACLE_CEP_HOME/ocep_11.1/modules/com.bea.wlevs.management_11.1.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.jndi.context_6.0.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.jmx_6.0.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.rmi_6.0.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.i18n_1.4.0.0.jar ORACLE_CEP_HOME/modules/com.bea.core.diagnostics.core_2.1.0.0.jar ORACLE_CEP_HOME/modules/javax.xml.stream_1.1.1.0.jar
Where ORACLE_CEP_HOME
refers to the main directory into which you installed Oracle Event Processing.
Set your CLASSPATH
in one of the following ways:
Implicitly set your CLASSPATH
by using the -jar
argument when you run the utility; set the argument to the NEW_DIRECTORY/
wlevsadmin.jar
file, where NEW_DIRECTORY
refers to the directory on the remote computer into which you copied the required JAR files. When you use the -jar
argument, you do not specify the wlevs.Admin
utility name at the command line.
Explicitly update your CLASSPATH
by adding all the files you copied to the remote computer to your CLASSPATH
environment variable:
Invoke the wlevs.Admin
utility as described in the next section.
To use SSL when using the wlevs.Admin
command-line utility, you must first create a trust keystore.
For more information, see Section 10.1.4, "SSL".
To run wlevs.Admin utility in SSL mode:
Open a command window and set your environment as described in ”Setting Your Development Environment” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse.
If not already running, start the Oracle Event Processing server.
See Section 1.5.4, "Starting and Stopping Oracle Event Processing Servers".
Change to the DOMAIN_DIR
/
servername
/ssl
directory, where DOMAIN_DIR
refers to the main domain directory and servername
refers to the name of your server.
For example:
d:\oracle_cep\user_projects\domains\mydomain\myserver\ssl
.
Generate a trust keystore by specifying the following command (in practice, the command should be on one line):
prompt> java -classpath ORACLE_CEP_HOME\ocep_11.1\common\lib\evspath.jar;ORACLE_CEP_HOME\ocep_11.1\utils\security\wlevsgrabcert.jar com.bea.wlevs.security.util.GrabCert host:secureport -alias=alias truststorepath
where
ORACLE_CEP_HOME
refers to the Oracle Event Processing installation directory (such as d:/oracle_cep
)
host
refers to the computer on which server2
is running.
secureport
refers to the SSL network i/o port configured for server2
. Default value is 9003.
For more information, see Example 10-5 in Section 10.5.1, "How to Configure SSL Manually."
alias
refers to the alias for the certificate in the trust keystore. Default value is the hostname.
truststorepath
refers to the full pathname of the generated trust keystore file; default is evstrust.jks
For example (in practice, the command should be on one line):
prompt> java -classpath C:\OracleCEP\ocep_11.1\common\lib\evspath.jar;C:\OracleCEP\ocep_11.1\utils\security\wlevsgrabcert.jar com.bea.wlevs.security.util.GrabCert server2:9003 -alias=server2 evstrust.jks
To specify that the wlevs.Admin
command-line utility use this trust keystore file, use the following properties:
-Djavax.net.ssl.trustStore
—Name of the trust keystore file you created in the preceding step
-Djavax.net.ssl.trustStorePassword
—Password of the trust keystore file.
Also be sure to specify the secure port in the URL. For example:
prompt> java -Djavax.net.ssl.trustStore=clitrust.jks -Djavax.net.ssl.trustStorePassword=secret -jar wlevsadmin.jar -url service:jmx:msarmis://localhost:9003/jndi/jmxconnector -username wlevs -password wlevs SHUTDOWN -scheduleAt 600
The syntax for using the wlevs.Admin
utility is as follows:
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] COMMAND-NAME command-arguments
The command names and arguments are not case sensitive.
The following sections provide detailed syntax information about the arguments you can supply to the wlevs.Admin
utility:
The following sections provide detailed syntax information about the supported commands of the wlevs.Admin
utility:
Section A.11, "Commands for Managing the Oracle CQL Rules of an Application"
Section A.12, "Commands for Managing the EPL Rules of an Application"
Section A.13, "Commands for Managing Oracle Event Processing MBeans"
Section A.14, "Commands for Controlling Event Record and Playback"
Section A.15, "Commands for Monitoring Throughput and Latency"
In many of the examples throughout the sections that follow, it is assumed that a certain environment has been set up:
The Oracle Event Processing instance listens to JMX requests on port 9002
.
The Oracle Event Processing instance is installed on a host machine named ariel
and uses this host name as its listen address.
The wlevs
username has system-administrator privileges and uses wlevs
for a password.
Also, for clarity, all the examples are shown on multiple lines; however, when you run the command, enter all arguments and commands on a single line.
All wlevs.Admin
commands return an exit code of 0
if the command succeeds and an exit code of 1
if the command fails.
To view the exit code from a Windows command prompt, enter echo %ERRORLEVEL%
after you run a wlevs.Admin
command. To view the exit code in a bash
shell, enter echo $?
.
wlevs.Admin
calls System.exit(1)
if an exception is raised while processing a command, causing Ant and other Java client JVMs to exit.
java wlevs.Admin [ {-url URL} | {-listenAddress hostname -listenPort port} ] [ User Credentials Arguments ] [ Common Arguments ] COMMAND-NAME command-arguments
When you invoke most wlevs.Admin
commands, you specify the arguments in Table A-1 to connect to an Oracle Event Processing instance.
Table A-1 Connection Arguments
Argument | Definition |
---|---|
-url service:jmx:msarmi://host:port/jndi/jmxconnector |
Specifies the URL that establishes a JMX connection to the Oracle Event Processing instance you want to administer, where:
If you use this argument, do not specify Other than For example, if Oracle Event Processing is running on a computer with hostname ariel, and the JMX listening port is 9002, then the URL would be: -url service:jmx:msarmi://ariel:9002/jndi/jmxconnector See Chapter 12, "Configuring JMX for Oracle Event Processing" for details about configuring JMX, JNDI, and RMI for Oracle Event Processing. |
-listenAddress hostname
|
Specifies the name of computer on which the Oracle Event Processing instances is running. This argument, together with You use this argument, together with For example, if Oracle Event Processing is running on a computer with hostname -listenAddress ariel |
-listenPort port
|
Specifies the port configured for Oracle Event Processing that listens to JMX connections. This argument, together with You use this argument, together with The JMX port is configured in the <netio>
<name>NetIO</name>
<port>9002</port>
</netio>
In the example, the port is -listenPort 9002 See Chapter 12, "Configuring JMX for Oracle Event Processing" for details about configuring JMX, JNDI, and RMI for Oracle Event Processing. |
java wlevs.Admin [ Connection Arguments ] [ -username username [-password password] ] [ Common Arguments ] COMMAND-NAME command-arguments
When you invoke most wlevs.Admin
commands, you specify the arguments in Table A-2 to provide the user credentials of an Oracle Event Processing user who has permission to invoke the command.
If security has not been enabled for your Oracle Event Processing domain, then you do not have to provide user credentials.
Table A-2 User Credentials Arguments
Argument | Definition |
---|---|
-username username |
The name of the user who is issuing the command. This user must have appropriate permission to view or modify the target of the command. |
-password password |
The password that is associated with the username. |
Note:
The exit code for all commands is 1 if thewlevs.Admin
utility cannot connect to the server or if the Oracle Event Processing instance rejects the username and password.java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ -verbose ] COMMAND-NAME command-arguments
All wlevs.Admin
commands support the argument in Table A-3 to get verbose output.
This section describes the command for getting usage help.
Provides syntax and usage information for all Oracle Event Processing commands (by default) or for a single command if a command value is specified on the HELP command line.
You can issue this command from any computer on which the Oracle Event Processing is installed. You do not need to start a server instance to invoke this command, nor do you need to supply user credentials, even if security is enabled for the server.
java wlevs.Admin HELP [COMMAND]
The COMMAND
argument can be:
The keyword ALL
, which returns usage information about all commands.
One of the keywords MBEAN
, RULES
, or LIFECYCLE
, which returns usage information about the three different groups of commands.
An actual command, such as UPLOAD
, which returns usage information about the particular command.
In the following example, information about using the UPLOAD command is requested:
prompt> java wlevs.Admin HELP UPLOAD
The command returns the following (in practice, Java commands should be on one line):
Description: Uploads rules to be configured in the processor. Usage: java wlevs.Admin [-url | -listenAddress <host-name> -listenPort <port>] -username <username> -password <password> UPLOAD -application <application name> -processor <processor name> -sourceURL "source url" Where: -application = Name of the application. -processor = Name of the processor. -sourceURL = source URL containing the rules in an XML format. java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs UPLOAD -application myapplication -processor processor -sourceURL file:/d:/test/rules.xml
Table A-4 is an overview of commands that manage the life cycle of a server instance. Subsequent sections describe command syntax and arguments, and provide an example for each command.
Table A-4 Overview of Commands for Managing the Server Life Cycle
Command | Description |
---|---|
Gracefully shuts down a WebLogic Event Server. |
Gracefully shuts down the specified Oracle Event Processing instance.
A graceful shutdown gives Oracle Event Processing time to complete certain application processing currently in progress.
The -url
connection argument specifies the particular Oracle Event Processing instance that you want to shut down, based on the host
and jmxport
values. See Section A.6, "Connection Arguments" for details.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] SHUTDOWN [-scheduleAt seconds]
The following example instructs the specified Oracle Event Processing instance to shut down in ten minutes:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs SHUTDOWN -scheduleAt 600
After you issue the command, the server instance prints messages to its log file and to its standard out. The messages indicate that the server state is changing and that the shutdown sequence is starting.
Table A-6 is an overview of commands that manage the Oracle CQL rules for a particular processor of an Oracle Event Processing application. Subsequent sections describe command syntax and arguments, and provide an example for each command.
Table A-6 Overview of Commands for Managing Application Oracle CQL Rules
Command | Description |
---|---|
Returns the text of an existing Oracle CQL rule, query, or view of the processor of an Oracle Event Processing application. |
|
Adds a new Oracle CQL rule, query, or view to the processor of an Oracle Event Processing application. |
|
Deletes an existing Oracle CQL rule, query, or view from the processor of an Oracle Event Processing application. |
|
Replaces an existing Oracle CQL rule, query, or view with new Oracle CQL text. |
|
Starts a previously stopped Oracle CQL rule or query. |
|
Stops a previously started Oracle CQL rule or query. |
|
Configures a set of Oracle CQL rules, queries, or views for a processor of an Oracle Event Processing application by uploading the rules from a component configuration XML file. |
|
Downloads the set of Oracle CQL rules, queries, or views associated with a processor of an Oracle Event Processing application to a component configuration XML file. |
Returns the full text of an Oracle CQL rule, query, or view from the specified Oracle CQL processor of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] GETRULE -application application -processor processor -rule rulename
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular Oracle CQL processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the Oracle CQL rule, query, or view you want to see. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule, query, or view name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor. |
The following example shows how to get the full text of the Oracle CQL view called myview
from the Oracle CQL helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs GETRULE -application helloworld -processor helloworldProcessor -rule myview
Adds a new Oracle CQL rule, query, or view to the specified processor of an Oracle Event Processing application.
If a rule, query, or view with the same name (identified with the rulename
, queryname
, or viewname
parameter) already exists, then the ADDRULE
command replaces the existing rule, query, or view with the new one.
Note:
An Oracle CQL query will immediately begin outputting events if its input channels provide input events. If you plan to use a query selector on a channel with an upstream Oracle CQL processor, you may observe unwanted query results on the downstream channel between the time you add the query to the upstream Oracle CQL processor and the time you configure the query selector on the downstream channel. For more information, see ”Channel Properties: Outbound Channel With Query Selector” in the Oracle Fusion Middleware Visualizer User's Guide for Oracle Event Processing.java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] ADDRULE -application application -processor processor -rule [rulename] rulestring | -query [queryname] querystring | -view [viewname] viewstring [-schema comma-separated-names] [-active true | false]
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule [rulename] rulestring |
Specifies the Oracle CQL rule you want to add to the specified processor of your application. An Oracle CQL rules include:
The Enter the Oracle CQL |
-query [queryname] querystring |
Specifies the Oracle CQL query you want to add to the specified processor of your application. The Enter the Oracle CQL |
-view [viewname] viewstring [-schema comma-separated-names] |
Specifies the Oracle CQL view you want to add to the specified processor of your application. The Enter the Oracle CQL The |
-active true | false |
Specifies if the rule should be started and ready to process events after being added. Valid values for this argument are |
The following example shows how to add the Oracle CQL query SELECT * FROM Withdrawal [Rows 5]
, with name myquery
, to the Oracle CQL processor helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs ADDRULE -application helloworld -processor helloworldProcessor -query myquery "SELECT * FROM Withdrawal [Rows 5]"
Deletes an existing Oracle CQL rule from the specified processor of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] DELETERULE -application application -processor processor -rule rulename
Table A-9 DELETERULE Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the Oracle CQL rule, query, or view you want to delete. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules, queries, or views for a particular Oracle CQL processor. |
The following example shows how to delete the Oracle CQL view called myview
from the Oracle CQL helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs DELETERULE -application helloworld -processor helloworldProcessor -rule myview
Replaces an existing Oracle CQL rule, query, or view with another rule, query, or view. Oracle Event Processing first destroys the original rule, query, or view and then inserts the new one in its place.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] REPLACERULE -application application -processor processor -rule rulename rulestring
Table A-10 REPLACERULE Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular Oracle CQL processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename rulestring |
Specifies the name of the Oracle CQL rule, query, or view you want to replace. Oracle Event Processing deletes the old rule, query, or view and then inserts a new one, with the same name but with the new rule text. In the case of a view, Oracle Event Processing generates the schema based on the select statement in the Enter the Oracle CQL |
The following example shows how to replace an Oracle CQL query called myquery
with the Oracle CQL text SELECT * FROM Withdrawal [Rows 10]
in the Oracle CQL helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs REPLACERULE -application helloworld -processor helloworldProcessor -rule myquery "SELECT * FROM Withdrawal [Rows 10]"
Starts an existing Oracle CQL rule or query that was previously stopped in the specified processor of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] STARTRULE -application application -processor processor -rule rulename
Table A-11 STARTRULE Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the Oracle CQL rule or query you want to start. NOTE: You cannot stop and start a view. Views are always active. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules, queries, or views for a particular Oracle CQL processor. |
The following example shows how to start the Oracle CQL query called myquery
from the Oracle CQL helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs STARTRULE -application helloworld -processor helloworldProcessor -rule myquery
Stops an existing Oracle CQL rule or query that was previously started in the specified processor of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] STOPRULE -application application -processor processor -rule rulename
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules or queries you want to manage. See Section A.13.5.3, "Querying for Application and Processor Names" for details on using You can also get the exact application name by looking at the |
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the Oracle CQL rule or query you want to stop. NOTE: You cannot stop and start a view. Views are always active. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules, queries, or views for a particular Oracle CQL processor. |
The following example shows how to stop the Oracle CQL query called myquery
from the Oracle CQL helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs STOPRULE -application helloworld -processor helloworldProcessor -rule myquery
Replaces the configured Oracle CQL rules for a specified processor with the Oracle CQL rules from an uploaded component configuration file.
The component configuration file that contains the list of Oracle CQL rules conforms to the component configuration file schema (see ”Component Configuration XSD Schema: wlevs_application_config.xsd” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse). This file contains one or more Oracle CQL rules that will replace those currently configured for the specified processor. An example of such a component configuration file is as follows:
<?xml version="1.0" encoding="UTF-8" ?> <config> <processor> <name>helloworldProcessor</name> <rules> <query id="helloworldRule1"> <![CDATA[ SELECT * FROM HelloWorldEvent [Rows 2] ]]> </query> </rules> </processor> </config>
In the preceding example, the component configuration file configures a single Oracle CQL query, with name helloworldRule1
, and its Oracle CQL query text is SELECT * FROM HelloWorldEvent [Rows 2]
.
Caution:
When you use theUPLOAD
command of the wlevs.Admin
utility, you use the -processor
argument to specify the name of the Oracle CQL processor to which you want to add the Oracle CQL rules, as you do with the other Oracle CQL commands. This means that the utility ignores any <name>
elements in the component configuration file to avoid any naming conflicts.For details and examples of creating the component configuration file, see ”Configuring Oracle CQL Processors” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse.
You an obtain a copy of a processor's component configuration file using the DOWNLOAD
command as Section A.12.9, "DOWNLOAD" describes.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] UPLOAD -application application -processor processor -sourceURL sourcefileURL
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular Oracle CQL processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-sourceURL sourcefileURL
|
Specifies the URL of the component configuration file that contains the Oracle CQL rules in the form:
|
The following example shows how upload the Oracle CQL rules in the c:\processor\config\myrules.xml
file to the Oracle CQL helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs UPLOAD -application helloworld -processor helloworldProcessor -sourceURL file:///c:/processor/config/myrules.xml
Downloads the set of Oracle CQL rules associated with the specified Oracle CQL processor of an Oracle Event Processing application to an XML component configuration file.
The XML file is of the same format as described in Section A.12.8, "UPLOAD."
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] DOWNLOAD -application application -processor processor -file destinationfile [-overwrite overwrite]
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-file destinationfile
|
Specifies the name of the component configuration XML file to which you want the Be sure you specify the full pathname of the file. |
-overwrite overwrite
|
Specifies whether the Valid values for this argument are |
The following example shows how download the set of Oracle CQL rules currently attached to the Oracle CQL helloworldProcessor
of the helloworld
application to the file c:\processor\config\myrules.xml
; the utility overwrites any existing file:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs DOWNLOAD -application helloworld -processor helloworldProcessor -file c:\processor\config\myrules.xml -overwrite true
Table A-15 is an overview of commands that manage the EPL rules for a particular processor of an Oracle Event Processing application. Subsequent sections describe command syntax and arguments, and provide an example for each command.
Table A-15 Overview of Commands for Managing Application EPL Rules
Command | Description |
---|---|
Adds a new EPL rule to the processor of an Oracle Event Processing application. |
|
Deletes an existing EPL rule from the processor of an Oracle Event Processing application. |
|
Replaces an existing EPL rule with new EPL text. |
|
Returns the text of an existing EPL rule of the processor of an Oracle Event Processing application. |
|
Configures a set of EPL rules for a processor of an Oracle Event Processing application by uploading the rules from an XML file. |
|
Downloads the set of EPL rules associated with a processor of an Oracle Event Processing application to a file. |
|
Adds a new set of parameters to a parameterized EPL query. |
|
Deletes a set of parameters from a parameterized EPL query. |
|
Returns the parameters currently bound to a parameterized EPL query. |
Adds a new EPL rule to the specified processor of an Oracle Event Processing application.
If a rule with the same name (identified with the rulename
parameter) already exists, then the ADDRULE
command replaces the existing rule with the new one.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] ADDRULE -application application -processor processor -rule [rulename] rulestring
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule [rulename] rulestring |
Specifies the EPL rule you want to add to the specified processor of your application. The Enter the EPL rule using double quotes. |
The following example shows how to add the EPL rule SELECT * FROM Withdrawal RETAIN 5 EVENTS
, with name myrule
, to the helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs ADDRULE -application helloworld -processor helloworldProcessor -rule myrule "SELECT * FROM Withdrawal RETAIN 5 EVENTS"
Deletes an existing EPL rule from the specified processor of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] DELETERULE -application application -processor processor -rule rulename
Table A-17 DELETERULE Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the EPL rule you want to delete. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor. |
The following example shows how to delete the EPL rule called myrule
from the helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs DELETERULE -application helloworld -processor helloworldProcessor -rule myrule
Replaces an existing EPL rule with another rule. Oracle Event Processing first destroys the original rule and then inserts the new one in its place. If the original rule was parameterized, any existing bindings are applied to the new rule.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] REPLACERULE -application application -processor processor -rule rulename rulestring
Table A-18 REPLACERULE Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename rulestring |
Specifies the EPL rule you want to replace. Oracle Event Processing deletes the old rule and then inserts a new one, with the same name but with the new rule text. Enter the EPL rule using double quotes. |
The following example shows how to replace a rule called myrule
with the EPL text SELECT * FROM Withdrawal RETAIN 10 EVENTS
in the helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs REPLACERULE -application helloworld -processor helloworldProcessor -rule myrule "SELECT * FROM Withdrawal RETAIN 10 EVENTS"
Returns the full text of an EPL rule from the specified processor of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] GETRULE -application application -processor processor -rule rulename
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the EPL rule for which you want to view its full text. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor. |
The following example shows how to get the full text of the EPL rule called myrule
from the helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs GETRULE -application helloworld -processor helloworldProcessor -rule myrule
Adds a new set of parameters to a parameterized EPL query.
See ”Parameterized Queries” in the Oracle Fusion Middleware EPL Language Reference for Oracle Event Processing information about using parameterized EPL queries.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] ADDPARAMS -application application -processor processor -rule rulename -values values -params params
Table A-20 ADDPARAMS Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the parameterized EPL rule for which you want add a new set of parameters. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor. |
-values values
|
Specifies a comma-separated list of values that make up the parameter you want to add. Each value corresponds to a placeholder in the parameterized EPL query. |
-params params
|
Specifies a unique identifier for this new parameter set. |
The following example shows how to use the ADDPARAMS command:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs ADDPARAMS -application myApplication -processor myProcessor -rule MarketRule -values "NYSE,BGP" -params nyBGP
The example shows how to add a parameter set identified by the string nyBGP
, with values NYSE,BGP
, to a parameterized query MarketRule
running in the myProcessor
component of myApplication
. Because the parameter set is composed of two values, the EPL query must contain two placeholders.
Deletes one or all set of parameters associated with a parameterized EPL query.
See ”Parameterized Queries” in the Oracle Fusion Middleware EPL Language Reference for Oracle Event Processing information about using parameterized EPL queries.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] DELETEPARAMS -application application -processor processor -rule rulename [-params params]
Table A-21 DELETEPARAMS Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the parameterized EPL rule for which you want to delete one or all of its parameter sets. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor. |
-params params
|
Specifies the parameter set you want to delete. This argument is optional; if you do not specify it, |
The following example shows how to use the DELETEPARAMS command:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs DELETEPARAMS -application myApplication -processor myProcessor -rule MarketRule -params nasORCL
The example shows how to delete the parameter set identified with the nasORCL
string from the parameterized query MarketRule
running in the myProcessor
component of myApplication
.
To delete all parameter sets associated to the query, do not specify the -params
option:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs DELETEPARAMS -application myApplication -processor myProcessor -rule MarketRule
Returns one or all the parameter sets currently bound to a parameterized EPL query.
See ”Parameterized Queries” in the Oracle Fusion Middleware EPL Language Reference for Oracle Event Processing information about using parameterized EPL queries.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] GETPARAMS -application application -processor processor -rule rulename [-params params]
Table A-22 GETPARAMS Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-rule rulename
|
Specifies the name of the parameterized EPL rule for which you get the parameter sets. See Section A.13.5.3, "Querying for Application and Processor Names" for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor. |
-params params
|
Specifies the parameter set you want return. This argument is optional; if you do not specify it, |
The following example shows how to use the GETPARAMS command:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs GETPARAMS -application myApplication -processor myProcessor -rule MarketRule
The example shows how to get all the parameters currently associated with the parameterized query MarketRule
running in the myProcessor
component of myApplication
. The command would return something like:
NASDAQ,ORCL NYSE,JPM NYSE,WFC NYSE,BGP
To retrieve a particular parameter set, specify its ID using the -params
option:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs GETPARAMS -application myApplication -processor myProcessor -rule MarketRule -params nasORCL
Replaces the configured EPL rules for a specified processor with the EPL rules from an uploaded XML file.
The XML file that contains the list of EPL rules conforms to component configuration file schema (see ”Component Configuration XSD Schema: wlevs_application_config.xsd” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse). This file contains one or more EPL rules that will replace those currently configured for the specified processor. An example of the XML file is as follows:
<?xml version="1.0" encoding="UTF-8" ?> <config> <processor> <name>helloworldProcessor</name> <rules> <rule id="helloworldRule1"> <![CDATA[ SELECT * FROM HelloWorldEvent RETAIN 2 EVENTS ]]> </rule> </rules> </processor> </config>
In the preceding example, the XML file configures a single rule, with name helloworldRule1
, and its EPL query text is SELECT * FROM HelloWorldEvent RETAIN 2 EVENTS
.
Caution:
When you use the UPLOAD command of thewlevs.Admin
utility, you use the -processor argument to specify the name of the processor to which you want to add the EPL rules, as you do with the other EPL commands. This means that the utility ignores any <name>
elements in the XML file to avoid any naming conflicts.See ”Configuring EPL Processors” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse for details and examples of creating the EPL rule XML file.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] UPLOAD -application application -processor processor -sourceURL sourcefileURL
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-sourceURL sourcefileURL
|
Specifies the URL of the XML file that contains the EPL rules. |
The following example shows how upload the EPL rules in the c:\processor\config\myrules.xml
file to the helloworldProcessor
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs UPLOAD -application helloworld -processor helloworldProcessor -sourceURL file:///c:/processor/config/myrules.xml
Downloads the set of EPL rules associated with the specified processor of an Oracle Event Processing application to an XML file.
The XML file is of the same format as described in Section A.12.8, "UPLOAD."
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] DOWNLOAD -application application -processor processor -file destinationfile [-overwrite overwrite]
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose EPL rules you want to manage. To get the exact name of your application, you can:
|
-processor processor
|
Specifies the name of the particular processor, attached to the Oracle Event Processing application specified with the See Section A.13.5.3, "Querying for Application and Processor Names" for details on getting the exact name if you do not know it. |
-file destinationfile
|
Specifies the name of the XML file to which you want the wlevs.Admin utility to download the EPL rules. Be sure you specify the full pathname of the file. |
-overwrite overwrite
|
Specifies whether the Valid values for this argument are |
The following example shows how download the set of EPL rules currently attached to the helloworldProcessor
of the helloworld
application to the file c:\processor\config\myrules.xml
; the utility overwrites any existing file:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs DOWNLOAD -application helloworld -processor helloworldProcessor -file c:\processor\config\myrules.xml
The following sections describe wlevs.Admin
commands for managing Oracle Event Processing MBeans.
See the Oracle Fusion Middleware Java API Reference for Oracle Event Processing for the full description of the Oracle Event Processing MBeans.
To specify which MBean or MBeans you want to access, view, or modify, all of the MBean management commands require either the -mbean
argument or the -type
argument.
Use the -mbean
argument to operate on a single instance of an MBean.
Use the -type
argument to operate on all MBeans that are an instance of a type that you specify. An MBean's type refers to the interface class of which the MBean is an instance. All Oracle Event Processing MBeans are an instance of one of the interface classes defined in the com.bea.wlevs.management.configuration
, com.bea.wlevs.management.runtime
, com.bea.wlevs.deployment.mbean
and com.bea.wlevs.server.management.mbean
packages. For a complete list of all Oracle Event Processing MBean interface classes, see the Oracle Fusion Middleware Java API Reference for Oracle Event Processing for the respective packages.
To determine the value that you provide for the -type
argument, do the following: Find the MBean's interface class and remove the MBean
suffix from the class name. For example, for an MBean that is an instance of the com.bea.wlevs.management.configuration.CQLProcessorMBean
, use CQLProcessor
.
Table A-25 is an overview of the MBean management commands.
Table A-25 MBean Management Command Overview
Command | Description |
---|---|
Displays properties of MBeans. |
|
Invokes management operations that an MBean exposes for its underlying resource. |
|
Searches for MBeans whose |
|
Sets the specified property values for the named MBean instance. |
Displays MBean properties (attributes) and JMX object names (in the http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html
format).
The output of the command is as follows:
{MBeanName object-name {property1 value} {property2 value}. . .} . . .
Note that the properties and values are expressed as name-value pairs, each of which is returned within curly brackets. This format facilitates parsing of the output by a script.
If -pretty
is specified, each property-value pair is displayed on a new line and curly brackets are not used to separate the pairs:
MBeanName: object-name property1: value property2: value . . . MBeanName: object-name property1: value abbribute2: value
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] GET [-pretty] {-type mbeanType| -mbean objectName} [-property property1] [-property property2]...
Argument | Definition |
---|---|
-type mbeanType
|
Returns information for all MBeans of the specified type. For more information, see Section A.13.1, "Specifying MBean Types." |
-mbean objectName
|
Fully qualified object name of an MBean in the For example, if you want to look up an MBean for an EPL Processor Stage, the naming is as follows (in practice, the string should be on one line): "com.bea.wlevs:Name=<name of the Stage>,Type=<type of Mbean>, Application=<name of the application>" |
-pretty |
Places property-value pairs on separate lines. |
-property property
|
The name of the MBean property (attribute) or properties to be listed. If |
The following example displays all properties of the CQLProcessorMBean
that was registered for the Processor Stage when the application called helloworld
was deployed in Oracle Event Processing.
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs GET -pretty -mbean com.bea.wlevs:Name=eplprocessor,Type=CQLProcessor,Application=helloworld
The following example displays all instances of all CQLProcessorMBean
MBeans.
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs GET -pretty -type CQLProcessor
Invokes a management operation for one or more MBeans. For Oracle Event Processing MBeans, you usually use this command to invoke operations other than the get
Attribute
and set
Attribute
that most Oracle Event Processing MBeans provide.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] INVOKE {-type mbeanType | -mbean objectName} -method methodname [argument . . .]
Arguments | Definition |
---|---|
-type mbeanType
|
Invokes the operation on all MBeans of a specific type. For more information, see Section A.13.1, "Specifying MBean Types." |
-mbean objectName
|
Fully qualified object name of an MBean in the For example, if you want to invoke an MBean for an EPL Processor Stage, the naming is as follows "com.bea.wlevs:Name=<name of the Stage>,Type=<type of Mbean>, Application=<name of the application>" |
-method methodname
|
Name of the method to be invoked. |
argument
|
Arguments to be passed to the method call. When the argument is a String array, the arguments must be passed in the following format: "String1;String2;. . . " |
The following example invokes the addRule
method of MBean com.bea.wlevs.management.configuration.EPLProcessorMBean
:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs INVOKE -mbean com.bea.wlevs:Name=eplprocessor,Type=EPLProcessor,Application=helloworld -method addRule "SELECT * FROM Withdrawal RETAIN ALL"
Searches for Oracle Event Processing MBeans whose http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html
matches a pattern that you specify.
All MBeans that are created from an Oracle Event Processing MBean type are registered in the MBean Server under a name that conforms to the http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html
conventions. You must know an MBean's ObjectName
if you want to use wlevs.Admin
commands to retrieve or modify specific MBean instances.
The output of the command is as follows:
{MBeanName object-name {property1 value} {property2 value}. . .} . . .
Note that the properties and values are expressed as name-value pairs, each of which is returned within curly brackets. This format facilitates parsing of the output by a script.
If -pretty
is specified, each property-value pair is displayed on a new line and curly brackets are not used to separate the pairs:
MBeanName: object-name property1: value property2: value . . . MBeanName: object-name property1: value abbribute2: value
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] QUERY -pretty -pattern object-name-pattern
Argument | Definition |
---|---|
-pretty |
Places property-value pairs on separate lines. |
-pattern object-name-pattern
|
A partial property-list
where property-list specifies one or more components (property-value pairs) of a You can specify these property-value pairs in any order. Within a given naming property-value pair, there is no pattern matching. Only complete property-value pairs are used in pattern matching. However, you can use the * wildcard character in the place of one or more property-value pairs. For example, If you provide at least one property-value pair in the |
The following example searches for all com.bea.wlevs.management.configuration.EPLProcessorMBean
MBeans:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs QUERY -pattern *:Type=EPLProcessor,*
If the command succeeds, it returns the attributes of the MBeans found (lines broken here for readability):
{MBeanName="com.bea.wlevs:Name=MonitorProcessor,Type=EPLProcessor,Application=com.bea.wlevs.dataservices"{ AllRules=defaultRule = select * from DSMonitorEvent retain 1 event where metric > 10000}{ AllRulesInfo=defaultRule = {RULE_TYPE=RULE, STARTED=true, VALUE=select * from DSMonitorEvent retain 1 event where metric > 10000, ID=defaultRule}}{Databases=}{Name=MonitorProcessor} {NotificationInfo=[Ljavax.management.MBeanNotificationInfo;@20d319} {ObjectName=com.bea.wlevs:Name=MonitorProcessor,Type=EPLProcessor, Application=com.bea.wlevs.dataservices}{PlaybackConfiguration=}{PlayingBack=false} {RecordConfiguration=}{RecordPlayback=com.bea.wlevs:Name=MonitorProcessor, Type=RecordPlayback,Application=com.bea.wlevs.dataservices}{Recording=false} {Type=EPLProcessor}}
All the commands for managing the EPL rules of an Oracle Event Processing application require you know the name of the application, as well the particular processor to which you want to apply the rules. Typically you know these names, but if you do not, you can use the QUERY
command to get the information from the MBean instances that represent applications and their attached processors.
In particular, use the following -pattern argument
to get a list of all applications, processors, and rules for a given Oracle Event Processing instance:
-pattern com.bea.wlevs:*,Type=EPLProcessor
For example:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs QUERY -pretty -pattern com.bea.wlevs:*,Type=EPLProcessor
A sample output of this command is shown below:
Command Output ------------------------------------------------------ MBeanName: "com.bea.wlevs:Name=helloworldProcessor,Type=EPLProcessor,Application=helloworld," AllRules: helloworldRule = select * from HelloWorldEvent retain 1 event --end of command output --------
In the sample output above:
The name of the application is helloworld
.
The helloworld application has a processor called helloworldProcessor
.
The helloworldProcessor
has a rule called helloworldRule
.
Sets the specified property (attribute) values for an MBean.
If the command is successful, it returns OK
and saves the new values to the server configuration.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] SET {-type mbeanType | -mbean objectName} -property property1 property1_value [-property property2 property2_value] . . .
Argument | Definition |
---|---|
-type mbeanType
|
Sets the properties for all MBeans of a specific type. For more information, see Section A.13.1, "Specifying MBean Types." |
-mbean objectName
|
Fully qualified object name of an MBean in the "com.bea.wlevs:Name=<name of the stage>,Type=<MBean type>,Application=<name of the deployed application>" |
-property property
|
The name of the property to be set. |
property _value
|
The value to be set.
|
The following example shows how to set the MaxSize
property of the channel named helloworldOutstream
of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs SET -mbean com.bea.wlevs:Name=helloworldOutstream,Type=Channel,Application=helloworld -property MaxSize 1024
Table A-30 is an overview of commands for managing event record and playback for a particular stage of an Oracle Event Processing application. Subsequent sections describe command syntax and arguments, and provide an example for each command.
Note:
Before you can use commands for controlling event record and playback on a stage, you must first configure the stage with the appropriate event record and playback options. For more information, see:”Configuring Event Record and Playback” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse
Table A-30 Overview of Commands for Controlling Event Record and Playback
Command | Description |
---|---|
Starts the recording of events for a stage in an Oracle Event Processing application. |
|
Stops the recording of events for a stage in an Oracle Event Processing application. |
|
Configures the parameters for the event recording of a stage in an Oracle Event Processing application. |
|
Schedules the recording of events for a stage in an Oracle Event Processing application. |
|
List the event recording configuration for a stage in an Oracle Event Processing application. |
|
Starts playing back events for a stage in an Oracle Event Processing application. |
|
Stops playing back events for a stage in an Oracle Event Processing application. |
|
Configures the parameters for the event playback of a stage in an Oracle Event Processing application. |
|
Schedules the playback of events for a stage in an Oracle Event Processing application. |
|
List the event playback configuration for a stage in an Oracle Event Processing application. |
Starts the recording of events for any particular stage of an Oracle Event Processing application.
Note:
Before you can use commands for controlling event record and playback on a stage, you must first configure the stage with the appropriate event record and playback options. For more information, see:”Configuring Event Record and Playback” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse
If you configured the stage to start recording at a later time, that configuration is ignored and recording starts immediately.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] STARTRECORD -application application -stage stage
Table A-31 STARTRECORD Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
The following example shows how to start the recording of events on the helloworldAdapter
stage of the helloworld
application deployed to the specified Oracle Event Processing instance:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs STARTRECORD -application helloworld -stage helloworldAdapter
Note:
Before you can use commands for controlling event record and playback on a stage, you must first configure the stage with the appropriate event record and playback options. For more information, see:”Configuring Event Record and Playback” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse
Stops the recording of events for a stage of an Oracle Event Processing application in which the recording of events has been previously started.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] STOPRECORD -application application -stage stage
Table A-32 STOPRECORD Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
The following example shows how to stop the recording of events on the helloworldAdapter
stage of the helloworld
application deployed to the specified Oracle Event Processing instance; it is assumed that the recording of events was previously started for the stage:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs STOPRECORD -application helloworld -stage helloworldAdapter
Configures the parameters associated with the recording of events for a stage of an Oracle Event Processing application.
You typically use this command to configure a stage for the first time for event recording or to change the dataset name or provider name. For more information, see ”Configuring Event Record and Playback” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] CONFIGURERECORD -application application -stage stage [-datasetName datasetname] [-storeProvider storeprovidername] [-eventTypes eventtypes] [-scheduleStartTime startime] [-scheduleEndTime endtime | -scheduleDuration duration]
Table A-33 CONFIGURERECORD Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
-datasetName datasetname
|
Specifies the name of the dataset in which events are recorded. |
-storeProvider storeprovidername
|
Specifies a valid To select the default BDB provider, leave this argument empty or specify an argument value of For more information, see ”Configuring an Event Store for Oracle Event Processing Server” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse. |
-eventTypes eventtypes
|
Specifies the comma-separated list of valid event type names to be recorded. Event types must be defined in the event type repository. |
-scheduleStartTime starttime
|
Specifies the time when the recording should start. Express the start time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that recording should start on January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema |
-scheduleEndTime endtime
|
Specifies the actual time when the recording should end. Express the end time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that recording should end on January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema Specify You can specify either |
-scheduleDuration duration
|
Specifies the duration of time after which event recording for this stage ends. Specify The format is You can specify either |
The examples in this section show how to configure the recording of events of the helloworldAdapter
of the helloworld
application deployed to the specified Oracle Event Processing instance.
The following example specifies a start and end time for recording:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs CONFIGURERECORD -application helloworld -stage helloworldAdapter -datasetName myds -storeProvider mysp -scheduleStartTime 2010-01-20T05:00:00 -scheduleEndndTime 2010-01-20T18:00:00
The following example specifies a start time and a duration for recording:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs CONFIGURERECORD -application helloworld -stage helloworldAdapter -datasetName myds -storeProvider mysp -scheduleStartTime 2010-01-20T05:00:00 -scheduleDuration 01:00:00
The following example specifies a start time and a duration of null
, which means recording will run forever:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs CONFIGURERECORD -application helloworld -stage helloworldAdapter -datasetName myds -storeProvider mysp -scheduleStartTime 2010-01-20T05:00:00 -scheduleDuration null
Configures the schedule parameters associated with the recording of events for a stage of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] SCHEDULERECORD -application application -stage stage [-scheduleStartTime startime] [-scheduleEndTime endtime | -scheduleDuration duration]
Table A-34 SCHEDULERECORD Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
-scheduleStartTime starttime
|
Specifies the time when the recording should start. Express the start time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that recording should start on January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema |
-scheduleEndTime endtime
|
Specifies the actual time when the recording should end. Express the end time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that recording should end on January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema Specify You can specify either |
-scheduleDuration duration
|
Specifies the duration of time after which event recording for this stage ends. Specify The format is You can specify either |
The examples in this section show how to configure the scheduling of recording of events of the helloworldAdapter
of the helloworld
application deployed to the specified Oracle Event Processing instance.
The following example specifies a start and end time for recording:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs SCHEDULERECORD -application helloworld -stage helloworldAdapter -scheduleStartTime 2010-01-20T05:00:00 -scheduleEndndTime 2010-01-20T18:00:00
Lists the event recording configuration for any particular stage of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] LISTRECORD -application application -stage stage
Table A-35 LISTRECORD Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
The following example shows how to list the event recording configuration on the helloworldAdapter
stage of the helloworld
application deployed to the specified Oracle Event Processing instance:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs LISTRECORD -application helloworld -stage helloworldAdapter
Starts the playback of events of a particular stage of a Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] STARTPLAYBACK -application application -stage stage [-filterStartTime starttime] [-filterEndTime endtime | -filterDuration duration] [-speed speed] [-repeat true | false]
Table A-36 STARTPLAYBACK Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage |
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
-filterStartTime startime
|
Specifies that only events with record-time greater than or equal to this value will be selected for playback. Express the start time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time greater than or equal to January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema Specify |
-filterEndTime endtime
|
Specifies only events with record-time less than or equal to this value will be selected for playback. Express the end time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time less than or equal to January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema You can specify either |
-filterDuration duration
|
Specifies the filter applied to events in the event store. Only events that were recorded during the filter time will be selected for play back. Specify The format is You can specify either |
-speed speed
|
Specifies the playback speed as a positive float. The default value is 1, which corresponds to normal speed. A value of 2 means that events will be played back 2 times faster than the original record speed. Similarly, a value of 0.5 means that events will be played back 2 times slower than the original record speed. |
-repeat repeat
|
Specifies whether to playback events again after the playback of the specified time interval is over. Valid values are |
The following example shows how to start the playback of events on the helloworldAdapter
stage of the helloworld
application deployed to the specified Oracle Event Processing instance:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs STARTPLAYBACK -application helloworld -stage helloworldAdapter
Stops the playback of events for a stage of an Oracle Event Processing application in which the playback of events has been previously started.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] STOPPLAYBACK -application application -stage stage
Table A-37 STOPPLAYBACK Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage |
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
The following example shows how to stop the playback of events on the helloworldAdapter
stage of the helloworld
application deployed to the specified Oracle Event Processing instance; it is assumed that the playback of events was previously started for the stage:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs STOPPLAYBACK -application helloworld -stage helloworldAdapter
Configures the parameters associated with the playback of events for a stage of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] CONFIGUREPLAYBACK -application application -stage stage [-datasetName datasetname] [-storeProvider storeprovidername] [-eventTypes eventtypes] [-scheduleStartTime sstart] [-scheduleEndTime send | -scheduleDuration sduration] [-filterStartTime fstart] [-filterEndTime fend | -filterDuration fduration] [-speed speed] [-repeat true | false]
Table A-38 CONFIGUREPLAYBACK Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage |
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
-datasetName datasetname
|
Specifies the name of the dataset in which events are recorded. |
-storeProvider storeprovidername
|
Specifies a valid To select the default BDB provider, leave this argument empty or specify an argument value of For more information, see ”Configuring an Event Store for Oracle Event Processing Server” in the Oracle Fusion Middleware Developer's Guide for Oracle Event Processing for Eclipse. |
-eventTypes eventtypes
|
Specifies the comma-separated list of valid event type names for playing back. Event types must be defined in the event type repository. |
-scheduleStartTime sstart
|
Specifies the time when play back should start. Express the start time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that play back should start on January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema |
-scheduleEndTime send
|
Specifies the actual time when the play back should end. Express the end time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that play back should end on January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema Specify You can specify either |
-scheduleDuration sduration
|
Specifies the duration of time after which event playback for this stage ends. Specify The format is You can specify either |
-filterStartTime fstart
|
Specifies that only events with record-time greater than or equal to this value will be selected for playback. Express the start time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time greater than or equal to January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema Specify |
-filterEndTime fend
|
Specifies only events with record-time less than or equal to this value will be selected for playback. Express the end time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time less than or equal to January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema You can specify either |
-filterDuration fduration
|
Specifies the filter applied to events in the event store. Only events that were recorded during the filter time will be selected for play back. Specify The format is You can specify either |
-speed speed
|
Specifies the playback speed as a positive float. The default value is 1, which corresponds to normal speed. A value of 2 means that events will be played back 2 times faster than the original record speed. Similarly, a value of 0.5 means that events will be played back 2 times slower than the original record speed. |
-repeat repeat
|
Specifies whether to playback events again after the playback of the specified time interval is over. Valid values are |
The examples in this section show how to configure the playback of events of the helloworldAdapter
of the helloworld
application deployed to the specified Oracle Event Processing instance.
The following example specifies a start and end time for playback and that the speed of playback should be twice the normal speed and that once the playback of events for the time interval is over, the playback should start again:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs CONFIGUREPLAYBACK -application helloworld -stage helloworldAdapter -scheduleStartTime 2010-01-20T05:00:00 -scheduleEndTime 2010-01-20T18:00:00 -speed 2 -repeat true
The following example specifies a start and a duration for playback, that the speed of playback is 2 times slower than normal, and that the playback of events should occur only once:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs CONFIGUREPLAYBACK -application helloworld -stage helloworldAdapter -scheduleStartTime 2010-01-20T05:00:00 -scheduleEndTime 2010-01-20T18:00:00 -speed 0.5 -repeat false
The following example specifies a start and a duration of null
, which means playback will run forever at normal speed:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs CONFIGUREPLAYBACK -application helloworld -stage helloworldAdapter -scheduleStartTime 2010-01-20T05:00:00 -scheduleDuration null
Configures the schedule parameters associated with playing back of events for a stage of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] SCHEDULEPLAYBACK -application application -stage stage [-scheduleStartTime startime] [-scheduleEndTime endtime | -scheduleDuration duration]
Table A-39 SCHEDULEPLAYBACK Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
-scheduleStartTime starttime
|
Specifies the time when play back should start. Express the start time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that play back should start on January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema |
-scheduleEndTime endtime
|
Specifies the actual time when the play back should end. Express the end time as an XMLSchema yyyy-mm-ddThh:mm:ss For example, to specify that play back should end on January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema Specify You can specify either |
-scheduleDuration duration
|
Specifies the duration of time after which event playback for this stage ends. Specify The format is You can specify either |
The examples in this section show how to configure the schedule of playback of events of the helloworldAdapter
of the helloworld
application deployed to the specified Oracle Event Processing instance.
The following example specifies a start and end time for event playback:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs SCHEDULEPLAYBACK -application helloworld -stage helloworldAdapter -scheduleStartTime 2010-01-20T05:00:00 -scheduleEndndTime 2010-01-20T18:00:00
Lists the event playback configuration for any particular stage of an Oracle Event Processing application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] LISTPLAYBACK -application application -stage stage
Table A-40 LISTPLAYBACK Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose event record and playback you want to manage. To get the exact name of your application, you can:
|
-stage stage
|
Specifies the name of the particular stage, attached to the Oracle Event Processing application specified with the |
The following example shows how to list the event playback configuration on the helloworldAdapter
stage of the helloworld
application deployed to the specified Oracle Event Processing instance:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs LISTPLAYBACK -application helloworld -stage helloworldAdapter
Table A-41 is an overview of commands for monitoring throughput and latency in an Oracle Event Processing application. Subsequent sections describe command syntax and arguments, and provide an example for each command.
Table A-41 Overview of Commands for Monitoring Throughput and Latency
Command | Description |
---|---|
Monitors the average amount of time it takes an event to pass through specified path of the EPN, or latency. |
|
Monitors the maximum amount of time it takes an event to pass through specified path of the EPN, or latency. |
|
Monitors whether the average latency of events flowing through a path of the EPN crosses a specified threshold. |
|
Monitors the number of events flowing through the entry or exit points of a specified stage. |
Monitors the average amount of time, or latency, it takes an event to pass through a specified path of the EPN of the specified application.
You specify the start and end stages of the path, and whether it should start or end at the entry or exit points of each respective stage. If you specify the same stage for the start and end of the path, you can monitor the latency of events flowing through a single stage.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] MONITORAVGLATENCY -application application -startStage startStage -startStagePoint stagePoint -endStage endStage -endStagePoint stagePoint -avgInterval avgInterval -timeUnit timeUnit
Table A-42 MONITORAVGLATENCY Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose throughput and latency you want to monitor. To get the exact name of your application, you can:
|
-startStage startStage |
Specifies the name of the stage that starts the path for which you want to monitor latency. The stage is in the application specified by the |
-startStagePoint startStagePoint |
Specifies the specific starting point for monitoring latency of the specified start stage. You can start monitoring from the entry or exit point of the start stage. Valid values are |
-endStage endStage |
Specifies the name of the stage that ends the path for which you want to monitor latency. The stage is in the application specified by the |
-endStagePoint endStagePoint |
Specifies the specific ending point for monitoring latency of the specified end stage. You can end monitoring from the entry or exit point of the end stage. Valid values are |
-avgInterval avgInterval
|
Specifies the average interval across which average latency is calculated. Specify the units with the Default value is 100. |
-timeUnit timeUnit |
Specifies the time unit for the latency calculation. Valid values are |
The following example shows how to monitor the average latency of events flowing through the eplprocessor
component, from entry point to exit point, of the helloworld
application. Note that because the same stage is specified for both the start and end stages (eplprocessor
), the latency monitoring is happening for just the events flowing through a single stage:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs MONITORAVGLATENCY -application helloworld -startStage eplprocessor -startStagePoint entry -endStage eplprocessor -endStagePoint exit -avgInterval 100 -timeUnit MILLISECONDS
Specifies whether the average latency of events between the start- and end-points of a path crosses a specified threshold.
You specify the start and end stages of the path, and whether it should start or end at the entry or exit points of each respective stage. If you specify the same stage for the start and end of the path, you can monitor the latency threshold of events flowing through a single stage.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] MONITORAVGLATENCYTHRESHOLD -application application -startStage startStage -startStagePoint stagePoint -endStage endStage -endStagePoint stagePoint -avgInterval avgInterval -timeUnit timeUnit -threshold threshold
Table A-43 MONITORAVGLATENCYTHRESHOLD Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose throughput and latency you want to monitor. To get the exact name of your application, you can:
|
-startStage startStage |
Specifies the name of the stage that starts the path for which you want to monitor the latency threshold. The stage is in the application specified by the |
-startStagePoint startStagePoint |
Specifies the specific starting point for monitoring the latency threshold of the specified start stage. You can start monitoring from the entry or exit point of the start stage. Valid values are |
-endStage endStage |
Specifies the name of the stage that ends the path for which you want to monitor the latency threshold. The stage is in the application specified by the |
-endStagePoint endStagePoint |
Specifies the specific ending point for monitoring the latency threshold of the specified end stage. You can end monitoring from the entry or exit point of the end stage. Valid values are |
-avgInterval avgInterval
|
Specifies the average interval across which average the latency threshold is calculated. Default value is 100. Specify the units with the |
-timeUnit timeUnit |
Specifies the time unit for the latency calculation. Valid values are |
-threshold threshold
|
Specifies the threshold value above which the metric event will be outputted at the end of every average interval. Default is 100. Specify the units with the |
The following example shows how to monitor the average latency threshold of events above 10 seconds average latency on the eplprocessor
stage, from entry point to exit point, of the helloworld
application.
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs MONITORAVGLATENCY -application helloworld -startStage eplprocessor -startStagePoint entry -endStage eplprocessor -endStagePoint exit -avgInterval 100 -timeUnit MILLISECONDS -threshold 100
Monitors the maximum latency of events flowing through a specified path of the EPN of the specified application.
You specify the start and end stages of the path, and whether it should start or end at the entry or exit points of each respective stage. If you specify the same stage for the start and end of the path, you can monitor the maximum latency of events flowing through a single stage.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] MONITORMAXLATENCY -application application -startStage startStage -startStagePoint stagePoint -endStage endStage -endStagePoint stagePoint -maxInterval maxInterval -timeUnit timeUnit
Table A-44 MONITORMAXLATENCY Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose throughput and latency you want to monitor. To get the exact name of your application, you can:
|
-startStage startStage |
Specifies the name of the stage that starts the path for which you want to monitor the maximum latency. The stage is in the application specified by the |
-startStagePoint startStagePoint |
Specifies the specific starting point for monitoring the maximum latency of the specified start stage. You can start monitoring from the entry or exit point of the start stage. Valid values are |
-endStage endStage |
Specifies the name of the stage that ends the path for which you want to monitor the maximum latency. The stage is in the application specified by the |
-endStagePoint endStagePoint |
Specifies the specific ending point for monitoring the maximum latency of the specified end stage. You can end monitoring from the entry or exit point of the end stage. Valid values are |
-maxInterval maxInterval
|
Specifies the interval across which maximum latency is calculate. Default value is 100. Specify the units with the |
-timeUnit timeUnit |
Specifies the time unit for the maximum calculation. Valid values are |
The following example shows how to monitor the maximum latency of events flowing through the eplprocessor
stage, from entry point to exit point, of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs MONITORMAXLATENCY -application helloworld -startStage eplprocessor -startStagePoint entry -endStage eplprocessor -endStagePoint exit -maxInterval 100 -timeUnit MILLISECONDS
Monitors the average number of events flowing through the entry or exit point of a stage of the EPN of the specified application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] MONITORAVGTHROUGHPUT -application application -stage stage -StagePoint stagePoint -throughputInterval throughputInterval -avgInterval avgInterval -timeUnit timeUnit
Table A-45 MONITORAVGLATENCY Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose throughput and latency you want to monitor. To get the exact name of your application, you can:
|
-stage stage |
Specifies the name of the stage for which you want to monitor throughput of events. The stage is in the application specified by the |
-stagePoint stagePoint |
Specifies whether you want to monitor throughput at the entry- or exit- point of the specified stage. Valid values are |
-throughputInterval throughputInterval
|
Specifies the throughput interval across which throughput is calculated. Default value is 100. Specify the units with the |
-avgInterval avgInterval
|
Specifies the average interval across which average throughput is calculated. Default value is 100. Specify the units with the |
-timeUnit timeUnit |
Specifies the time unit for the throughput calculation. Valid values are |
The following example shows how to monitor the number of events flowing through the entry point of the eplprocessor
stage of the helloworld
application:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs MONITORMAXLATENCY -application helloworld -stage eplprocessor -stagePoint entry -throughputInterval 100 -avgInterval 100 -timeUnit MILLISECONDS
Table A-46 is an overview of commands that manage the configuration history of Oracle Event Processing components. For more information, see Section 1.3.3, "Configuration History Management".
Subsequent sections describe command syntax and arguments, and provide an example for each command.
Table A-46 Overview of Commands for Managing Configuration History
Command | Description |
---|---|
Returns the list of configuration history management commands. |
|
Removes change records for a specified time period. |
|
Returns a list of the change records of an application. |
|
Returns a list of the configuration resource revisions of an application. |
|
Rolls back a change record specified by change record ID. |
Returns the list of configuration history management commands.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] CONFIGHISTORY
Returns the list of configuration history management commands.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] DELETECONFIGCHANGEHISTORY -application application -startTime starttime -endTime endtime
Table A-47 DELETECONFIGCHANGEHISTORY Arguments
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can:
|
-startTime starttime
|
Specifies the beginning of the time period to delete change records. The format is |
-endTime end-ime
|
Specifies the end of the time period to delete change records. The format is |
Returns a list of the change records of an application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] LISTCHANGERECORDS -application application -startTime starttime -endTime endtime
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose change records you want to browse. To get the exact name of your application, you can:
|
-startTime starttime
|
Specifies the beginning of the time period to filter the display of change records. The format is |
-endTime end-ime
|
Specifies the end of the time period to filter the display of change records. The format is |
The following example shows how to list all the change records created between 11:10:07 and 11:22:07 on 20 November 2007 for the application helloworld
:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs LISTCHANGERECORDS -application helloworld startTime 10-20-2007:11:10:07 -endTime 10-20-2007:11:22:07
Returns a list of the configuration resource revisions of an application.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] LISTRESOURCEREVISIONS -application application -startTime starttime -endTime endtime
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose resource revisions you want to browse. To get the exact name of your application, you can:
|
-startTime starttime
|
Specifies the beginning of the time period to filter the list of resource revisions. The format is |
-endTime end-ime
|
Specifies the end of the time period to filter the list of resource revisions. The format is |
The following example shows how to list all the resource revisions created between 11:10:07 and 11:22:07 on 20 November 2007 for the application helloworld
:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs LISTRESOURCEREVISIONS -application helloworld startTime 10-20-2007:11:10:07 -endTime 10-20-2007:11:22:07
Rolls back the changes defined by the change record specified by change record ID.
java wlevs.Admin [ Connection Arguments ] [ User Credentials Arguments ] [ Common Arguments ] UNDOCONFIGCHANGE -application application -recordId changerecordid
Argument | Definition |
---|---|
-application application
|
Specifies the name of the Oracle Event Processing application whose change records you want to undo. To get the exact name of your application, you can:
|
-recordId changerecordid
|
Specifies the identifier of the change record to undo. To get the change record identifier, you can use: |
The following example shows how to roll back all the resource revisions created between 11:10:07 and 11:22:07 on 20 November 2007 for the application helloworld
:
prompt> java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector -username wlevs -password wlevs UNDOCONFIGCHANGE -application helloworld -recordId tr.1267607521409.10110