Deploying and Managing Apama Applications > Correlator Utilities Reference > Inspecting correlator state
Inspecting correlator state
The engine_inspect tool lets you inspect the state of a running event correlator. This means you can review the applications loaded and running on a correlator. The executable for this tool is located in the bin directory of the Apama installation. Running the tool in the Apama command prompt ensures that the environment variables are set correctly.
Synopsis
To inspect applications on a running event correlator:
*On Windows, run engine_inspect.exe.
*On UNIX, run engine_inspect.
To obtain the following usage message, run the command without any options or with the –h option:
Usage: engine_inspect [ options ]
To list names of monitors and events in a correlator.
Where options include:
-m | --monitors List monitor types
-j | --java List Java applications
-e | --events List event types
-t | --timers List timers
-x | --contexts List contexts
-a | --aggregates List aggregate functions
-P | --pluginReceivers List plugin receivers
-R | --receivers List connected receivers
-r | --raw Raw (i.e. parser friendly) output
-h | --help This message
-n | --hostname <host> Connect to an engine on <host>
-p | --port <port> Engine is listening on <port>
-v | --verbose Be more verbose
-V | --version Print program version info
Description
The engine_inspect tool retrieves state information from a running event correlator and sends it to stdout. By default, the tool outputs information on the monitors, JMon applications, event types and container types currently injected in an event correlator.
You can filter this list by specifying command-line options. When you specify one or more of the -m, -j, -e, -t, -x, -P, or -R options, the engine_inspect tool displays only the information indicated by the option(s) you specify. See the Options table below for a description of these options.
Options
The engine_inspect tool takes the following options.:
Option
Description
 
-m
Displays the names of all EPL monitors in the event correlator and the number of sub-monitors each monitor has spawned.
 
-j
Displays the names of all JMon applications in the event correlator and the number of event listeners each JMon application has created.
 
-e
Displays the names of all event types in the correlator and the number of templates of each type, as defined in listener specifications. This includes each event template in an on statement and each stream source template, for example, stream<A> := all A().
For more information about event types and listeners, see Introduction to Apama Event Processing Language.
 
-t
Displays the current EPL timers active within the system. The four types of timers which may be displayed here are wait, within, at, and stream. The stream timers are those set up to support the operation of a stream network.
 
-x
Displays the names of any user-defined contexts, how many monitor instances are running in each context, what channels each context is subscribed to, and how many entries are on each context’s input queue.
 
-a
Displays a list of the custom (user-defined) aggregate functions that have been injected. You use aggregate functions in stream queries. Apama built-in aggregate functions are not listed.

-P
Displays the names of any plug-in receivers, the channels the plug-in is subscribed to, and the number of items on the plug-in's input queue. A plug-in receiver is a correlator plug-in that is subscribed to one or more channels.
 
-R
Displays the names of any external receivers, each receiver's address, the channels each receiver is subscribed to, and the number of entries on each receiver's output queue.
 
-r
Indicates that you want raw output, which is more suitable for machine parsing. Raw output provides the name of each entity in the correlator followed by the number of instances associated with that entity. For a monitor, you get the number of its monitor instances. For a JMon application, you get the number of its listeners. For an event type, you get the number of its templates. For example:
com.apama.samples.stockwatch.StockWatch 1
Tick 1
 
-h
Displays usage information.
 
-n host
Name of the host on which the event correlator is running. The default is localhost.
Note: Non-ASCII characters in host names are not supported.
 
-p port
Port on which the event correlator is listening. The default is 15903.
 
-v
Displays process names and versions in addition to application information. Optional. The default is to display only application information.
 
-V
Displays version information for the engine_inspect tool.
Exit status
The engine_inspect tool returns the following values:
Status
Description
 
0
All status requests were processed successfully.
 
1
No connection to the event correlator was possible or the connection failed.
 
2
Other error(s) occurred while requesting/processing status.
Copyright © 2013-2015 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.