com.apama.correlator
Event EngineStatus


EPL representation of the correlator status.
Action Summary
 stringgetMostBackedUpInput()

Get the name of the most backed up context.
 integergetMostBackedUpQueueSize()

Get the queue size of the most backed up context.
 integergetNumConsumers()

Get the number of event consumers connected to the engine.
 integergetNumContexts()

Get the number of contexts active in the Engine.
 integergetNumEventTypes()

Get the number of event types defined.
 integergetNumFastTracked()

Get the number of events received on the internal input queue since the Engine started.
 integergetNumJavaApplications()

Get the number of Java (JMon) Applications defined in the Engine.
 integergetNumListeners()

Get the number of active listeners.
 integergetNumMonitors()

Get the number of monitors defined in the Engine.
 integergetNumOutEventsCreated()

Gets the number of output events which have been put onto the output queue. This corresponds to the number of MonitorScript emit commands executed.
 integergetNumOutEventsQueued()

Get the number of events waiting on the output queue.
 integergetNumOutEventsSent()

This is the number of output events sent out by the correlator process. This differs from getNumOutEventsCreated since events can be of interest to a varying number of consumers, and can be dropped by the output queue.
 integergetNumProcessed()

Get the number of events taken off the input queue and processed since the Engine started.
 integergetNumProcesses()

Get the number of monitor processes or active sub-monitors. If a monitor spawns it creates a new process.
 integergetNumQueuedFastTrack()

Get the total number of events waiting on the route queues (value of 'rq' in the correlator status line).
 integergetNumQueuedInput()

Get the total number of events waiting on the input queues (value of 'iq' in the correlator status line).
 integergetNumReceived()

Get the number of events received since the Engine started.
 integergetNumSubListeners()

Get the number of active sub-listeners.
 stringgetSlowestReceiver()

Get the name of the slowest receiver.
 integergetSlowestReceiverQueueSize()

Get the queue size of the slowest receiver.
 integergetUptime()

Get the time in ms that the Engine has been running for.
 booleangetUserBoolean(string key)

Get a user-set status value of type boolean.
 booleangetUserBooleanOr(string key, boolean alt)

Get a user-set status value of type boolean OR the alternative value specified if the key does not exist.
 floatgetUserFloat(string key)

Get a user-set status value of type float.
 floatgetUserFloatOr(string key, float alt)

Get a user-set status value of type float OR the alternative value specified if the key does not exist.
 integergetUserInteger(string key)

Get a user-set status value of type integer.
 integergetUserIntegerOr(string key, integer alt)

Get a user-set status value of type integer OR the alternative value specified if the key does not exist.
 stringgetUserString(string key)

Get a user-set status value of type string.
 stringgetUserStringOr(string key, string alt)

Get a user-set status value of type string OR the alternative value specified if the key does not exist.
 dictionary<string, string >getValues()

Get the full correlator status value dictionary .
 
Action Detail

getMostBackedUpInput

string getMostBackedUpInput()
Get the name of the most backed up context.
Returns:
Name of the slowest context.

getMostBackedUpQueueSize

integer getMostBackedUpQueueSize()
Get the queue size of the most backed up context.
Returns:
The number of events queued.

getNumConsumers

integer getNumConsumers()
Get the number of event consumers connected to the engine.
Returns:
The number of event consumers.

getNumContexts

integer getNumContexts()
Get the number of contexts active in the Engine.
Returns:
The number of contexts active.

getNumEventTypes

integer getNumEventTypes()
Get the number of event types defined.
Returns:
The number of event types.

getNumFastTracked

integer getNumFastTracked()
Get the number of events received on the internal input queue since the Engine started.
Returns:
The number of events received.

getNumJavaApplications

integer getNumJavaApplications()
Get the number of Java (JMon) Applications defined in the Engine.
Returns:
The number of Java Applications.

getNumListeners

integer getNumListeners()
Get the number of active listeners.
Returns:
The number of active listeners.

getNumMonitors

integer getNumMonitors()
Get the number of monitors defined in the Engine.
Returns:
The number of monitors defined.

getNumOutEventsCreated

integer getNumOutEventsCreated()
Gets the number of output events which have been put onto the output queue. This corresponds to the number of MonitorScript emit commands executed.
Returns:
The number of events emitted.

getNumOutEventsQueued

integer getNumOutEventsQueued()
Get the number of events waiting on the output queue.
Returns:
The number of events waiting.

getNumOutEventsSent

integer getNumOutEventsSent()
This is the number of output events sent out by the correlator process. This differs from getNumOutEventsCreated since events can be of interest to a varying number of consumers, and can be dropped by the output queue.
Returns:
The number of events sent.

getNumProcessed

integer getNumProcessed()
Get the number of events taken off the input queue and processed since the Engine started.
Returns:
The number of events processed.

getNumProcesses

integer getNumProcesses()
Get the number of monitor processes or active sub-monitors. If a monitor spawns it creates a new process.
Returns:
The number of monitor processes.

getNumQueuedFastTrack

integer getNumQueuedFastTrack()
Get the total number of events waiting on the route queues (value of 'rq' in the correlator status line).
Returns:
The number of waiting events.

getNumQueuedInput

integer getNumQueuedInput()
Get the total number of events waiting on the input queues (value of 'iq' in the correlator status line).
Returns:
The number of waiting events.

getNumReceived

integer getNumReceived()
Get the number of events received since the Engine started.
Returns:
The number of events received.

getNumSubListeners

integer getNumSubListeners()
Get the number of active sub-listeners.
Returns:
The number of sub-listeners.

getSlowestReceiver

string getSlowestReceiver()
Get the name of the slowest receiver.
Returns:
The slowest receiver.

getSlowestReceiverQueueSize

integer getSlowestReceiverQueueSize()
Get the queue size of the slowest receiver.
Returns:
The queue size of the slowest receiver.

getUptime

integer getUptime()
Get the time in ms that the Engine has been running for.
Returns:
The uptime of the Engine.

getUserBoolean

boolean getUserBoolean(string key)
Get a user-set status value of type boolean.
Parameters:
key - The name of the value to get.
Returns:
The user status of type boolean.

getUserBooleanOr

boolean getUserBooleanOr(string key, boolean alt)
Get a user-set status value of type boolean OR the alternative value specified if the key does not exist.
Parameters:
key - The name of the value to get.
alt - The alternative value to return if the key does not exist.
Returns:
The user status of type boolean or the alternate value if the key does not exist.

getUserFloat

float getUserFloat(string key)
Get a user-set status value of type float.
Parameters:
key - The name of the value to get.
Returns:
The user status of type float.

getUserFloatOr

float getUserFloatOr(string key, float alt)
Get a user-set status value of type float OR the alternative value specified if the key does not exist.
Parameters:
key - The name of the value to get.
alt - The alternative value to return if the key does not exist.
Returns:
The user status of type float or the alternate value if the key does not exist.

getUserInteger

integer getUserInteger(string key)
Get a user-set status value of type integer.
Parameters:
key - The name of the value to get.
Returns:
The user status of type integer.

getUserIntegerOr

integer getUserIntegerOr(string key, integer alt)
Get a user-set status value of type integer OR the alternative value specified if the key does not exist.
Parameters:
key - The name of the value to get.
alt - The alternative value to return if the key does not exist.
Returns:
The user status of type integer or the alternate value if the key does not exist.

getUserString

string getUserString(string key)
Get a user-set status value of type string.
Parameters:
key - The name of the value to get.
Returns:
The user status of type string.

getUserStringOr

string getUserStringOr(string key, string alt)
Get a user-set status value of type string OR the alternative value specified if the key does not exist.
Parameters:
key - The name of the value to get.
alt - The alternative value to return if the key does not exist.
Returns:
The user status of type string or the alternate value if the key does not exist.

getValues

dictionary<string, string > getValues()
Get the full correlator status value dictionary .
Returns:
The full correlator status value dictionary.