The following snippet from a config.xml files shows a JMX configuration.

<config>
  <netio>
    <name>JettyNetio</name>
    <port>12345</port>
  </netio>
  <work-manager>
    <name>WM</name>
    <fairshare>5</fairshare>
    <min-threads-constraint>1</min-threads-constraint>
    <max-threads-constraint>4</max-threads-constraint>
  </work-manager>
  <jetty>
    <name>TestJetty</name>
    <work-manager-name>WM</work-manager-name>
    <network-io-name>JettyNetio</network-io-name>
  </jetty>
  <rmi>
    <name>RMI</name>
    <http-service-name>TestJetty</http-service-name>
  </rmi>
  <jndi-context>
    <name>JNDI</name>
  </jndi-context>
  <exported-jndi-context>
    <name>exportedJNDI</name>
    <rmi-service-name>RMI</rmi-service-name>
  </exported-jndi-context>
  <jmx>
    <jndi-service-name>JNDI</jndi-service-name>
    <rmi-service-name>RMI</rmi-service-name>
  </jmx>
</config>

You configure the Oracle Stream Analytics JMX service with the following elements in the config.xml file that describes your Oracle Stream Analytics server:

• jmx

• rmi

• jndi-context

• exported-jndi-context

For information on security configuration tasks that affect JMX, see Configure JMX Security.

jmx

Table 11-3 lists the jmx element child elements in the config.xml file that you must configure.

rmi

The Oracle Stream Analytics RMI service provides the following:

• Ability to register a POJO interface in a server for remote method invocation from a client.

• Ability to register for any context propagation from the client to the server on a remote method invocation, intercept, and act on this propagated context in the server.

Table 11-4 lists the rmi element child elements in the config.xml file that you use to export server-side objects to remote clients.

jndi-context

The JNDI Factory Manager is responsible for supporting JNDI in an OSGi environment. It allows JNDI providers to be supplied as OSGi bundles, and for code running inside OSGi bundles to have full access to the JNDI environment.

The Factory Manager consists of two components:

• An OSGi bundle, which provides the OSGi-specific factory management code, to look up JNDI objects using the appropriate OSGi classloader.

• JNDI glue code, internal to Oracle Stream Analytics, that initializes the JNDI environment to support the factory manager bundle.

Table 11-5 lists the jndi-context element child elements in the config.xml file that you must configure.

exported-jndi-context

Requires a configured jndi-context.

Use this configuration object to export a remote JNDI service to a client using RMI. A JNDI context is registered with the RMI service to provide remote access to clients that pass a provider URL parameter in their InitialContext object.

Table 11-6 lists the exported-jndi-context element child elements in the config.xml file that you must configure.

This section describes how to write Java code using the JMX API (http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement) to connect to the Oracle Stream Analytics JMX server from a non-Oracle Stream Analytics client. This is the first step to all programmatic JMX management.

For information on connecting to the Oracle Stream Analytics JMX server from another Oracle Stream Analytics server, see Connect with APIs to a JMX Server From an Oracle Stream Analytics Client.

Use APIs to connect to a JMX server from a non-Oracle Stream Analytics client:

This section describes how to write Java code using the JMX API (http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement) to connect to the Oracle Stream Analytics JMX server from another Oracle Stream Analytics server. This is the first step to all programmatic JMX management.

For information on connecting to the Oracle Stream Analytics JMX server from a non-Oracle Stream Analytics client, see Connect with APIs to a JMX Server from a Non-Oracle Stream Analytics Client.

Use APIs to connect to the JMX server from an Oracle Stream Analytics client:

This section describes how to write Java code using the JMX API (http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement) to access Oracle Stream Analytics MBeans.

Configure an Oracle Stream Analytics component with JMX APIs:

This section describes how to write Java code using the JMX API (http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement) to access Oracle Stream Analytics MBeans and dynamically monitor the throughput and latency of an Oracle Stream Analytics component.

Dynamically configure an Oracle Stream Analytics component with JMX APIs:

1. Acquire a connection to the Oracle Stream Analytics JMX server.

   For details see Connect with APIs to a JMX Server from a Non-Oracle Stream Analytics Client.

2. Acquire an instance of a MonitorRuntimeMBean for the component you want to monitor as shown below.

   ObjectName processorInbound = ObjectName.getInstance(
       "com.bea.wlevs:Name=myprocessor," +
       "Type=CQLProcessor," +
       "Application=myapplication," +
       "Direction=INBOUND"
   );
   

   Be sure you specify whether you want to monitor incoming events (INBOUND) or outgoing events (OUTBOUND).

3. Use the MonitorRuntimeMBean to acquire an instance of ProbeRuntimeMBean for the type of statistic you want as shown below.

   ObjectName monitorName =
       ObjectName.getInstance(
           "com.bea.wlevs:ServerRuntime=localhost," +
           "Name=MonitorRuntime," +
           "Type=MonitorRuntime");
   
   MonitorRuntimeMBean monitorMBean = (MonitorRuntimeMBean)MBeanServerInvocationHandler.newProxyInstance( 
           connection,
           monitorName,
           MonitorRuntimeMBean.class,
           false);
   
   ObjectName probeName = monitorMBean.monitorAvgThroughput(
       processorInbound,
       1000,
       1000
   );
   
   ProbeRuntimeMBean probeOn = (ProveRuntimeMBean)MBeanServerInvocationHandler.newProxyInstance(
       connection,
       probeName,
       ProbeRuntimeMBean.class,
       false
   );
   

   The MonitorRuntimeMBean has methods for each type of statistic you can gather. For example, you execute monitorAvgLatency() if you want to monitor the average latency, monitorAvgThroughput() to monitor the average throughput, and so on. These methods all return ProbeRuntimeMBean.

4. Use the ProbeRuntimeMbean instance to get the actual run time metrics in one of the following ways:

   1. Use the ProbeRuntimeMBean method getMetric() to pull the information.

   2. Use javax.management.NotificationBroadcaster.addNotificationListener() to have the information pushed to you every time there is a change in the metrics.

5. When you are finished gathering monitoring information, unregister the MBean from the MBean server as shown below.

   probON.terminate();
   

   For additional details about these MBean interfaces and how to use them to monitor throughput and latency, see the com.bea.wlevs.monitor.management package in the Java API Reference for Oracle Stream Analytics.

You can use the wlevsjconsole script to connect to an Oracle Stream Analytics JMX server running on your local host or on a remote host to browse and manage Oracle Stream Analytics MBeans with the JDK jconsole.

This procedure describes how to use JConsole when the Oracle Stream Analytics server has security enabled. This is the default configuration and is recommended for production servers. Alternatively, you can connect to the JMX server with security disabled (see Connect to Local or Remote JMX Server Using JConsole with Security Disabled).

For more information, see Access the Oracle Stream Analytics JMX Server.

Connect to a local or remote JMX server using JConsole with security enabled:

1. Ensure that the local or remote Oracle Stream Analytics server is running.

2. Launch jconsole using the wlevsjconsole.cmd or wlevsjconsole.sh script located in the /Oracle/Middleware/my_oep/oep/bin directory.

   1. To connect to a local Oracle Stream Analytics server, enter:

      prompt> wlevsjconsole.cmd
      

   2. To connect to a remote Oracle Stream Analytics server, enter:

      prompt> wlevsjconsole.cmd HOST-NAME:PORT
      

      Where HOST-NAME is the name of the remote host and PORT is the Net IO port as configured in the remote host's /Oracle/Middleware/my_oep/user_projects/domains/myDomain/defaultserver/config/config.xml file.

   The jconsole browser attempts to log into the JMX server and initially fails as Figure 11-2 shows.

   Figure 11-2 Jconsole Initial Login Attempt

   
   Description of "Figure 11-2 Jconsole Initial Login Attempt"

3. Click Cancel.

   The Jconsole New Connection dialog appears as shown in Figure 11-3.

   Figure 11-3 JConsole New Connection Dialog

   
   Description of "Figure 11-3 JConsole New Connection Dialog"

4. Configure the New Connection dialog as described in the following table.

   Table 11-7 JConsole New Connection Attributes

   Attribute	Description
   Remote Process	Enter the following URL: service:jmx:msarmi://HOST-NAME:PORT/jndi/jmxconnector Where HOST-NAME is the name of the local or remote host and PORT is the Net IO port as configured in the remote host's /Oracle/Middleware/my_oep/user_projects/domains/myDomain/defaultserver/config/config.xml file (default: 9002).
   Username	Enter the Oracle Stream Analytics administration user name: oepadmin.
   Password	Enter the Oracle Stream Analytics administration password: welcome1.

5. Click Connect.

   The jconsole browser opens and provides access to Oracle Stream Analytics MBeans as Figure 11-4 shows.

   Figure 11-4 JConsole Browser

   
   Description of "Figure 11-4 JConsole Browser"

You can use the wlevsjconsole script to connect to an Oracle Stream Analytics JMX server running on your local host or on a remote host to browse and manage Oracle Stream Analytics MBeans with the JDK jconsole.

This procedure describes how to use JConsole when the Oracle Stream Analytics server has security disabled. This is a common development configuration and is not recommended for production servers. Alternatively, you can connect to the JMX server with security enabled (see Connect to a Local or Remote JMX Server using JConsole with Security).

For more information, see Access the Oracle Stream Analytics JMX Server.

Connect to a local or remote JMX server using JConsole with security disabled:

1. Ensure that the local or remote Oracle Stream Analytics server is running with security disabled.

   For more information, see Disable Security.

2. Launch jconsole using the wlevsjconsole.cmd or wlevsjconsole.sh script located in the /Oracle/Middleware/my_oep/oep/bin directory.

   1. To connect to a local Oracle Stream Analytics server, enter:

      prompt> wlevsjconsole.cmd
      

   2. To connect to a remote Oracle Stream Analytics server, enter:

      prompt> wlevsjconsole.cmd HOST-NAME:PORT
      

      Where HOST-NAME is the name of the remote host and PORT is the Net IO port as configured in the remote host's /Oracle/Middleware/my_oep/user_projects/domains/myDomain/defaultserver/config/ config.xml file.

   The script automatically connects to the JMX server and the jconsole browser opens and provides access to Oracle Stream Analytics MBeans as Figure 11-5 shows.

   Figure 11-5 JConsole Browser

   
   Description of "Figure 11-5 JConsole Browser"