EngineStatus

com.apama.correlator
Event EngineStatus

EPL representation of the correlator status.

Since:: 9.10

See Also:: com.apama.correlator.Component.getStatus() - To get an instance of this event representing the current status.; com.apama.correlator.UserStatusChanged - To receive notifications about changes to a specified user status.; com.apama.correlator.EngineStatus.getValues() - This event has built-in actions for some of the most frequently-used built-in status keys, but a full list is available from getValues().

Action summary
`string`	`getMostBackedUpInput()` The name of the slowest context.
`integer`	`getMostBackedUpQueueSize()` The number of events on the slowest context's queue, as identified by the name of the slowest context.
`integer`	`getNumConsumers()` The number of external consumers/receivers connected to receive emitted events.
`integer`	`getNumContexts()` The number of contexts in the correlator, including the main context.
`integer`	`getNumEventTypes()` The number of event types defined within the correlator.
`integer`	`getNumFastTracked()` The number of events that have been routed across all contexts since the correlator was started.
`integer`	`getNumJavaApplications()` The number of Java applications and Java EPL plug-ins loaded in the correlator.
`integer`	`getNumListeners()` The number of listeners in all contexts.
`integer`	`getNumMonitors()` The number of EPL monitor definitions injected into the correlator.
`integer`	`getNumOutEventsCreated()` The number of events that have been sent or emitted to channels which have at least one external consumer/receiver subscribed.
`integer`	`getNumOutEventsQueued()` The number of events waiting on output queues to be dispatched to any connected external consumers/receivers.
`integer`	`getNumOutEventsSent()` The number of events that have been delivered to external consumers/receivers. This counts for each external consumer/receiver an event is sent to.
`integer`	`getNumProcessed()` The number of events processed by the correlator in all contexts.
`integer`	`getNumProcesses()` The number of monitor instances, also known as sub-monitors.
`integer`	`getNumQueuedFastTrack()` The sum of routed events on the route queues of all contexts.
`integer`	`getNumQueuedInput()` The number of executors on the input queues of all contexts. As well as events, this can include clock ticks, spawns, injections and other operations.
`integer`	`getNumReceived()` The number of events that the correlator has received from external sources since the correlator started.
`integer`	`getNumSubListeners()` The number of sub-event-listeners that are active across all contexts.
`string`	`getSlowestReceiver()` The name of the consumer/receiver with the largest number of incoming events waiting to be processed.
`integer`	`getSlowestReceiverQueueSize()` The number of events on the slowest consumer's/receiver's queue, as identified by the name of the slowest consumer/receiver.
`integer`	`getUptime()` The time in milliseconds since the correlator was started.
`boolean`	`getUserBoolean(string key)` Get a user-set status value of type boolean.
`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.
`float`	`getUserFloat(string key)` Get a user-set status value of type float.
`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.
`integer`	`getUserInteger(string key)` Get a user-set status value of type integer.
`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.
`string`	`getUserString(string key)` Get a user-set status value of type string.
`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.
`dictionary<string, string>`	`getValues()` Get a dictionary containing all correlator status values, including both built-in and user-defined values.

Action detail

getMostBackedUpInput

string getMostBackedUpInput()

The name of the slowest context.

getMostBackedUpQueueSize

integer getMostBackedUpQueueSize()

The number of events on the slowest context's queue, as identified by the name of the slowest context.

getNumConsumers

integer getNumConsumers()

The number of external consumers/receivers connected to receive emitted events.

getNumContexts

integer getNumContexts()

The number of contexts in the correlator, including the main context.

getNumEventTypes

integer getNumEventTypes()

The number of event types defined within the correlator.

getNumFastTracked

integer getNumFastTracked()

The number of events that have been routed across all contexts since the correlator was started.

getNumJavaApplications

integer getNumJavaApplications()

The number of Java applications and Java EPL plug-ins loaded in the correlator.

getNumListeners

integer getNumListeners()

The number of listeners in all contexts.

getNumMonitors

integer getNumMonitors()

The number of EPL monitor definitions injected into the correlator.

getNumOutEventsCreated

integer getNumOutEventsCreated()

The number of events that have been sent or emitted to channels which have at least one external consumer/receiver subscribed.

getNumOutEventsQueued

integer getNumOutEventsQueued()

The number of events waiting on output queues to be dispatched to any connected external consumers/receivers.

getNumOutEventsSent

integer getNumOutEventsSent()

The number of events that have been delivered to external consumers/receivers. This counts for each external consumer/receiver an event is sent to.

getNumProcessed

integer getNumProcessed()

The number of events processed by the correlator in all contexts.

getNumProcesses

integer getNumProcesses()

The number of monitor instances, also known as sub-monitors.

getNumQueuedFastTrack

integer getNumQueuedFastTrack()

The sum of routed events on the route queues of all contexts.

getNumQueuedInput

integer getNumQueuedInput()

The number of executors on the input queues of all contexts. As well as events, this can include clock ticks, spawns, injections and other operations.

getNumReceived

integer getNumReceived()

The number of events that the correlator has received from external sources since the correlator started.

getNumSubListeners

integer getNumSubListeners()

The number of sub-event-listeners that are active across all contexts.

getSlowestReceiver

string getSlowestReceiver()

The name of the consumer/receiver with the largest number of incoming events waiting to be processed.

getSlowestReceiverQueueSize

integer getSlowestReceiverQueueSize()

The number of events on the slowest consumer's/receiver's queue, as identified by the name of the slowest consumer/receiver.

getUptime

integer getUptime()

The time in milliseconds since the correlator was started.

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.

Since:: 9.10

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.

Since:: 9.10

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.

Since:: 9.10

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.

Since:: 9.10

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.

Since:: 9.10

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.

Since:: 9.10

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.

Since:: 9.10

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.

Since:: 9.10

getValues

dictionary<string, string> getValues()

Get a dictionary containing all correlator status values, including both built-in and user-defined values.

This is the same set of keys that are exposed by the /correlator/status REST endpoint.

Returns:: The full correlator status value dictionary.

Since:: 9.10

com.apama.correlatorEvent EngineStatus