JMX attributes
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.
| 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. |
| LastExecutionDuration | The number of milliseconds the contact and response history module took to perform the last 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.
| 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.
| 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.
| 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.
| Attribute | Description |
|---|---|
| locale | Locale setting for JMX client. |
Logger Configuration attributes
Logger Configuration attributes are part of the runtime environment.
| 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.
| 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.
| 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.
| 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.
| Attribute | Description |
|---|---|
| endSessionCount | The number of endSession API calls since last reset or system start. |
| endSessionDuration | Time that is elapsed for the last endSession API call. |
| executeBatchCount | The number of executeBatch API calls since last reset or system start. |
| executeBatchDuration | Time that is elapsed for the last executeBatch API call. |
| getOffersCount | The number of getOffers API calls since last reset or system start. |
| getOffersDuration | Time that is elapsed for the last getOffer API call. |
| getProfileCount | The number of getProfile API calls since last reset or system start. |
| getProfileDuration | Time that is elapsed for the last getProfileDuration API call. |
| getVersionCount | The number of getVersion API calls since last reset or system start. |
| getVersionDuration | Time that is elapsed for the last getVersion API call. |
| loadOfferSuppressionDuration | Time that is elapsed for the last loadOfferSuppression API call. |
| LoadOffersBySQLCount | The number of LoadOffersBySQL API calls since last reset or system start. |
| LoadOffersBySQLDuration | Time that is elapsed for the last LoadOffersBySQL API call. |
| loadProfileDuration | Time that is elapsed for the last loadProfile API call. |
| loadScoreOverrideDuration | Time that is elapsed for the last loadScoreOverride API call. |
| postEventCount | The number of postEvent API calls since last reset or system start. |
| postEventDuration | Time that is elapsed for the last postEvent API call. |
| runSegmentationDuration | Time that is elapsed for the last runSegmentation API call. |
| setAudienceCount | The number of setAudience API calls since last reset or system start. |
| setAudienceDuration | Time that is elapsed for the last setAudience API call. |
| setDebugCount | The number of setDebug API calls since last reset or system start. |
| setDebugDuration | Time that is elapsed for the last setDebug API call. |
| startSessionCount | The number of startSession API calls since last reset or system start. |
| startSessionAverage | Average time that is elapsed for the last startSession API call. |
Learning Optimizer Statistics attributes
Learning Optimizer Statistics attributes are part of the runtime environment.
| Attribute | Description |
|---|---|
| LearningOptimizerAcceptCalls | The number of accept events that are passed into the learning module. |
| LearningOptimizerAcceptTrackingDuration | 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 ContactTrackingDuration | The total number of milliseconds spent logging the contact events in the learning module. |
| LearningOptimizer LogOtherCalls | The number of non-contact and non-accept events that are passed into the learning module. |
| LearningOptimizerLog OtherTrackingDuration | The duration in milliseconds spent in logging other events (non-contact and non-accept) in the learning module. |
| LearningOptimizerNonRandomCalls | 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 RecommendDuration | 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.
| Attribute | Description |
|---|---|
| LoadDefaultOffersDuration | Time that is elapsed on the default offers loading. |
| DefaultOffersCalls | The number of times the default offers loading. |