There are multiple attributes available for JMX monitoring.
Design environment attributes include contact response history ETL
monitoring. Runtime environment attributes include exceptions, several
different flowchart attributes, locale, logger, and thread pool statistics.
Several service statistics attributes are also available. All data
that is provided by JMX monitoring is since the last reset or system
start. For example, a count is of the number of items since last reset
or system start, not since installation.
Contact Response History ETL Monitor attributes
The
Contact Response History ETL Monitor attributes are part of the design
environment. All of the following attributes are part of the runtime
environment.
Table 1. Contact Response History ETL Monitor
| Attribute |
Description |
| AvgCHExecutionTime |
The average number of milliseconds it takes for the contact
and response history module to write to the contact history table.
This average is calculated only for the operations that were successful
and for which there was at least one record that was written to the
contact history table. |
| AvgETLExecutionTime |
The average number of milliseconds it takes for the contact
and response history module to read data from the runtime environment.
The average includes the time for successful as well as failed operations. |
| AvgRHExecutionTime |
The average number of milliseconds it takes for the contact
and response history module to write to the response history table.
This average is calculated only for the operations that were successful
and for which there was at least one record that was written to the
response history table. |
| ErrorCount |
The number of error messages that were logged since last reset
or system start, if any. |
| HighWaterMarkCHExecutionTime |
The maximum number of milliseconds it took for the contact
and response history module to write to the contact history table.
This value is calculated only for the operations that were successful
and for which there was at least one record that was written to the
contact history table. |
| HighWaterMarkETLExecutionTime |
The maximum number of milliseconds it took for the contact
and response history module to read data from the runtime environment.
The calculation includes both successful as well as failed operations. |
| HighWaterMarkRHExecutionTime |
The maximum number of milliseconds it took for the contact
and response history module to write to the response history table.
This value is calculated only for the operations that were successful
and for which there was at least one record that was written to the
response history table. |
| LastExecutionAverage |
The number of milliseconds the contact and response history
module took to perform each copy. |
| NumberOfExecutions |
The number of times the contact and response history module has run
since initialization. |
| LastExecutionStart |
The time the last run of the contact and response history module
started. |
| LastExecutionSuccessful |
If true, the last run of the contact and response history module
was successful. If false, an error occurred. |
| NumberOfContactHistoryRecordsMarked |
The number of contact history records in the UACI_CHStaging table that
are being moved during the current run of the contact and response
history module. This value is greater than zero only if the contact
and response history module is running. |
| NumberOfResponseHistoryRecordsMarked |
The number of response history records in the UACI_RHStaging table that
are being moved during the current run of the contact and response
history module. This value is greater than zero only if the contact
and response history module is running. |
Exception attributes
Exception attributes
are part of the runtime environment.
Table 2. Exceptions
| Attribute |
Description |
| errorCount |
The number of error messages that were logged since last reset
or system start. |
| warningCount |
The number of warning messages that were logged since last
reset or system start. |
Flowchart Engine Statistics attributes
Flowchart
Engine Statistics attributes are part of the runtime environment.
Table 3. Flowchart Engine Statistics
| Attribute |
Description |
| activeProcessBoxThreads |
Active count of flowchart process threads (shared between all
executions) that are currently running. |
| activeSchedulerThreads |
Active count of Flowchart Scheduler threads that are currently
running. |
| avgExecutionTimeMillis |
Average flowchart execution time in milliseconds. |
| CurrentJobsInProcessBoxQueue |
The number of jobs that are waiting to be run by flowchart
process threads. |
| CurrentJobsInSchedulerQueue |
The number of jobs that are waiting to be run by Flowchart
Scheduler threads. |
| maximumProcessBoxThreads |
Maximum number of flowchart process threads (shared between
all executions) that can be run. |
| maximumSchedulerThreads |
Maximum number of Flowchart Scheduler threads (one thread per
execution) that can be run. |
| numExecutionsCompleted |
Total number of flowchart executions that completed. |
| numExecutionsStarted |
Total number of flowchart executions started. |
Specific flowcharts by interactive channel attributes
Specific
flowcharts by interactive channel attributes are part of the runtime
environment.
Table 4. Specific flowcharts by interactive channel
| Attribute |
Description |
| AvgExecutionTimeMillis |
Average execution time in milliseconds for this flowchart in
this interactive channel. |
| HighWaterMarkForExecutionTime |
Maximum execution time in milliseconds for this flowchart in
this interactive channel. |
| LastCompletedExecutionTimeMillis |
Execution time in milliseconds for the last completion of this
flowchart in this interactive channel. |
| NumExecutionsCompleted |
Total number of executions that have completed for this flowchart
in this interactive channel. |
| NumExecutionsStarted |
Total number of executions that are started for this flowchart
in this interactive channel. |
Locale attributes
Locale attributes are
part of the runtime environment.
Table 5. Locale
| Attribute |
Description |
| locale |
Locale setting for JMX client. |
Logger Configuration attributes
Logger Configuration
attributes are part of the runtime environment.
Table 6. Logger
Configuration
| Attribute |
Description |
| category |
Change the log category on which the log level can be manipulated. |
Services Thread Pool Statistics attributes
Services
Thread Pool Statistics attributes are part of the runtime environment.
Table 7. Services Thread Pool Statistics
| Attribute |
Description |
| activeContactHistThreads |
The approximate number of threads that are actively running
tasks for Contact History and Response History. |
| activeFlushCacheToDBThreads |
The approximate number of threads that are actively running
tasks to flush cached statistics to the data store. |
| activeOtherStatsThreads |
The approximate number of threads that are actively running
tasks for Eligible Stats, Event Activities, and Default Stats. |
| CurrentHighWaterMarkInContactHistQueue |
Greatest number of entries queued to be logged by the service
that collects the contact and response history data. |
| CurrentHighWaterMark InFlushCachetoDBQueue |
Greatest number of entries queued to be logged by the service
that writes the data in the cache to the database tables. |
| CurrentHighWaterMarkInOtherStatsQueue |
Greatest number of entries queued to be logged by the service
that collects the offer eligibility statistics, default string usage
statistics, event activity statistics, and the custom log to table data. |
| currentMsgsInContactHistQueue |
The number of jobs in the queue for the thread pool that is
used for Contact History and Response History. |
| currentMsgsInFlushCacheToDBQueue |
The number of jobs in the queue for the thread pool that is
used to flush cached statistics to the data store. |
| currentMsgsInOtherStatsQueue |
The number of jobs in the queue for the thread pool that is
used for Eligible Stats, Event Activities, and Default Stats. |
| maximumContactHistThreads |
The largest number of threads that have ever simultaneously been
in the pool that is used for Contact History and Response History. |
| maximumFlushCacheToDBThreads |
The largest number of threads that have ever simultaneously been
in the pool that is used for flushing cached statistics to the data
store. |
| maximumOtherStatsThreads |
The largest number of threads that have ever simultaneously been
in the pool that is used for Eligible Stats, Event Activities, and
Default Stats. |
Service Statistics attributes
The
Service Statistics consist of a set of attributes for each service.
- ContactHistoryMemoryCacheStatistics - The service that collects
data for the contact history staging tables.
- CustomLoggerStatistics - The service that collects custom data
to write to a table (an event that uses the UACICustomLoggerTableName event
parameter).
- Default Statistics - The service that collects the statistics regarding
the number of times the default string for the interaction point was
used.
- Eligibility Statistics - The service that writes the statistics
for eligible offers.
- Event Activity Statistics - The service that collects the event
statistics, both system events such as getOffer or startSession and
user events that are triggered by postEvent.
- Response History Memory Cache Statistics - The service that writes
to the response history staging tables.
- Cross-session Response Statistics - The service that collects
the cross-session response tracking data.
Table 8. Service Statistics
| Attribute |
Description |
| Count |
The number of messages processed. |
| ExecTimeInsideMutex |
The amount of time spent processing messages for this service,
excluding time spent waiting for other threads, in milliseconds. If
there is a great difference between ExecTimeInsidMutex and ExecTimeMillis,
you might need to change the thread pool size for the service. |
| ExecTimeMillis |
The amount of time spent processing messages for this service,
including time spent waiting for other threads, in milliseconds. |
| ExecTimeOfDBInsertOnly |
The amount of time in milliseconds spent processing the batch
insert portion only. |
| HighWaterMark |
The maximum number of messages that are processed for this
service. |
| NumberOfDBInserts |
The total number of batch inserts run. |
| TotalRowsInserted |
The total number of rows that are inserted into the database. |
Service Statistics - Database Load Utility attributes
Service
Statistics - Database Load Utility attributes are part of the runtime
environment.
Table 9. Service Statistics - Database Load Utility
| Attribute |
Description |
| ExecTimeOfWriteToCache |
The amount of time in milliseconds spent writing to file cache,
including writing to files and getting the primary key from database
when necessary. |
| ExecTimeOfLoaderDBAccessOnly |
The amount of time in milliseconds spent running database loader
portion only. |
| ExecTimeOfLoaderThreads |
The amount of time in milliseconds spent by database loader
threads. |
| ExecTimeOfFlushCacheFiles |
The amount of time in milliseconds spent flushing the cache
and re-creating new ones. |
| ExecTimeOfRetrievePKDBAccess |
The amount of time in milliseconds spent retrieving the primary
key database access. |
| NumberOfDBLoaderRuns |
The total number of database loader runs. |
| NumberOfLoaderStagingDirCreated |
The total number of staging directories that are created. |
| NumberOfLoaderStagingDirRemoved |
The total number of staging directories that are removed. |
| NumberOfLoaderStaging DirMovedToAttention |
The total number of staging directories that are renamed to
attention. |
| NumberOfLoaderStagingDirMovedToError |
The total number of staging directories that are renamed to
error. |
| NumberOfLoaderStagingDirRecovered |
The total number of staging directories recovered, including
at startup time and rerun by background threads. |
| NumberOfTimesRetrievePKFromDB |
The total number of times the primary key was retrieved from
database. |
| NumberOfLoaderThreadsRuns |
The total number of database loader threads runs. |
| NumberOfFlushCacheFiles |
The total number of times the file cache was flushed. |
API Statistics attributes
API Statistics
attributes are part of the runtime environment.
Table 10. API
Statistics
| Attribute |
Description |
| endSessionCount |
The number of endSession API calls since
last reset or system start. |
| endSessionAverage |
Time that is elapsed for the each endSession API call in
milliseconds. |
| executeBatchCount |
The number of executeBatch API calls
since last reset or system start. |
| executeBatchAverage |
Time that is elapsed for the each executeBatch API call in
milliseconds. |
| getOffersCount |
The number of getOffers API calls since
last reset or system start. |
| getOffersAverage |
Time that is elapsed for the each getOffer API call in
milliseconds. |
| getProfileCount |
The number of getProfile API calls since
last reset or system start. |
| getProfileAverage |
Time that is elapsed for the each getProfileAverage API call in
milliseconds. |
| getVersionCount |
The number of getVersion API calls since
last reset or system start. |
| getVersionAverage |
Time that is elapsed for the each getVersion API call in
milliseconds. |
| loadOfferSuppressionAverage |
Time that is elapsed for the each loadOfferSuppression API
call. |
| LoadOffersBySQLCount |
The number of LoadOffersBySQL API calls
since last reset or system start. |
| LoadOffersBySQLAverage |
Time that is elapsed for the each LoadOffersBySQL API call in
milliseconds. |
| loadProfileAverage |
Time that is elapsed for the each loadProfile API call in
milliseconds. |
| loadScoreOverrideAverage |
Time that is elapsed for the each loadScoreOverride API call in
milliseconds. |
| postEventCount |
The number of postEvent API calls since
last reset or system start. |
| postEventAverage |
Time that is elapsed for the each postEvent API call in
milliseconds. |
| runSegmentationAverage |
Time that is elapsed for the each runSegmentation API call in
milliseconds. |
| setAudienceCount |
The number of setAudience API calls
since last reset or system start. |
| setAudienceAverage |
Time that is elapsed for the each setAudience API call in
milliseconds. |
| setDebugCount |
The number of setDebug API calls since
last reset or system start. |
| setDebugAverage |
Time that is elapsed for the each setDebug API call in
milliseconds. |
| startSessionCount |
The number of startSession API calls
since last reset or system start. |
| startSessionAverage |
Average time that is elapsed for each startSession API call in
milliseconds. |
| ActiveSessionCount |
The number of sessions that are currently active in the interact run time instance. Note: The
ActiveSessionCount in JMX MBean com.unicacorp.interact:type=api, group=Statistics does not consider
timed out events and hence it could show incorrect active count. |
Learning Optimizer Statistics attributes
Learning
Optimizer Statistics attributes are part of the runtime environment.
Table 11. Learning Optimizer Statistics
| Attribute |
Description |
| LearningOptimizerAcceptCalls |
The number of accept events that are passed into the learning
module. |
| LearningOptimizer AcceptTrackingAverage |
The total number of milliseconds spent logging the accept events
in the learning module. |
| LearningOptimizerContactCalls |
The number of contact events that are passed into the learning
module. |
| LearningOptimizer ContactTrackingAverage |
The total number of milliseconds spent logging the contact
events in the learning module. |
| LearningOptimizerLogOtherCalls |
The number of non-contact and non-accept events that are passed
into the learning module. |
| LearningOptimizer LogOtherTrackingAverage |
The average in milliseconds spent in logging other events
(non-contact and non-accept) in the learning module. |
| LearningOptimizer NonRandomCalls |
The number of times the configured learning implementation
was applied. |
| LearningOptimizer RandomCalls |
The number of times the configured learning implementation
was bypassed and random selection was applied. |
| LearningOptimizer RecommendCalls |
The number of recommend requests that are passed into the learning
module. |
| LearningOptimizer RecommendAverage |
The total number of milliseconds spent in the learning recommend
logic. |
Default Offer Statistics attributes
Default
Offer Statistics attributes are part of the runtime environment.
Table 12. Default Offer Statistics
| Attribute |
Description |
| LoadDefaultOffersAverage |
Time that is elapsed on the default offers loading. |
| DefaultOffersCalls |
The number of times the default offers loading. |
Triggered Message Dispatchers attributes
Triggered Message Dispatchers attributes are part of the runtime environment.
Table 13. Triggered Message Dispatchers
| Attribute |
Description |
| NumRequested |
The total number of offers that were requested for dispatching using this dispatcher. |
| NumDispatched |
The total number of offers this dispatcher successfully dispatched. |
| AvgExecutionTime |
The average time in milliseconds this dispatcher uses for dispatching an offer. Only the
offers that were successfully dispatched to gateways are counted in the calculation. |
| CurrentQueueSize |
The number of offers currently waiting to be dispatched. |
| GatewayInvocation |
The number of offers and average dispatching time in milliseconds dispatched to each gateway
by this dispatcher. The format of its value is {gateway name=[number of offers, average
dispatching time]}. |
Triggered Message Gateways attributes
Triggered Message Gateways attributes are part of the runtime environment.
Table 14. Triggered Message Gateways
| Attribute |
Description |
| NumValidationRequested |
The total number of offers this gateway requested for validation. |
| NumValidated |
The total number of offers this gateway successfully validated. |
| AvgValidationTime |
The average time in milliseconds this gateway uses for validating an offer. Only the offers
that were successfully validated are counted in the calculation. |
| NumDeliveryRequested |
The total number of offers this gateway requested for delivery. |
| NumDelivered |
The total number of offers this gateway successfully delivered. |
| AvgDeliveryTime |
The average time in milliseconds this gateway uses for delivering an offer. Only the offers
that were successfully delivered are counted in the calculation. |
Triggered Message Messages attributes
Triggered Message Messages attributes are part of the runtime environment.
Table 15. Triggered Message Messages
| Attribute |
Description |
| ProcessSuccessCount |
The total number of times this triggered message successfully executed. |
| AvgSuccessProcessTime |
The average time in milliseconds this triggered message spends for each successful execution.
|
| ProcessErrorCount |
The total number of times this triggered message unsuccessfully executed. |
| AvgErrorProcessTime |
The average time in milliseconds this triggered message spends for each unsuccessful
execution. |
| SelectBranchCount |
The total number of times branch selection was executed while processing triggered
messages. |
| AvgSelectBranchTime |
The average time in milliseconds branch selection execution uses while processing triggered
messages. |
| SelectOfferCount |
The total number of times offer selection was executed while processing triggered
messages. |
| AvgSelectOfferTime |
The average time in milliseconds offer selection execution uses while processing triggered
messages. |
| SelectChannelCount |
The total number of times channel selection was executed while processing triggered
messages. |
| AvgSelectChannelTime |
The average time in milliseconds channel selection execution uses while processing triggered
messages. |
| FlowchartWaitCount |
The total number of times this triggered message waited for segmentation to complete. |
| AvgFlowchartWaitTime |
The average time in milliseconds this triggered message waited for segmentation to complete
in each execution. |
| WaitFlowchartTimeoutCount |
The total number of times this triggered message timed out while waiting for segmentation to
complete. |
Table 16. Activity Orchestrator Gateways information
| Attribute |
Description |
| NumReceived |
The number of messages received by Activity Orchestrator Receiver. |
| NumProcessed |
The number of messages processed for Activity Orchestrator Receiver. |
| AvgProcessTime |
The average processing time of the number of messages processed for Activity
Orchestrator Receiver. |
Table 17. Kafka Statistics Information
| Attributes |
Description |
| NumMessagesInTopic |
The number of messages recorded in topic along with topic name. |
| Running |
The running status of Kafka server. |
| TopicDetails |
The details of topics along with leader and followers. |
| ListOfTopics |
The list of topics of Kafka server, except the default topic. |
Table 18. Zookeeper Statistics Information
| Attribute |
Description |
| Running |
The running status of Zookeeper server. |