7.5 Aggregation Monitoring

Owned by Jenni Wallin
Last updated: May 08, 2023 by Former user (Deleted)
7 min read

There are two MBeans available to gather counter statistics about Aggregation, one for file storage and one for Couchbase storage.

File Storage

When file storage is selected in an Aggregation profile, you can use JMX beans to view attributes matching similar MIM parameters published by the Aggregation agent. There is also an operation that you can use to reset all counters.

The MBean is registered under the com.digitalroute.profile domain, with the key type set to "Aggregation" and the key name set to the Aggregation profile's name.

For information about MIM values published by the Aggregation agent, see 9.3.4 Aggregation Profile

To monitor the Aggregation MIM parameter values, do the following:

  1.  Select the picostart process when starting the JMX client, see 7.1 Starting the Jconsole Client for further information.
    The Java Monitoring & Management Console will open and display the Overview tab.
     
  2.  Click on the MBeans tab to display the different beans.
     
  3.  Expand the tree in the left section by clicking on the plus sign for com.digitalroute.profile, then on the plus sign for Aggregation and then on the plus sign for the Aggregation profile you want to monitor.

Attributes

 Click on  Attributes in the tree to display the different attribute values in the right section of the JConsole window.

 JConsole displaying the attributes for Aggregation with file storage


AttributeDescription

AggregationTime

This attribute value shows the time (in milliseconds) that has been spent on aggregation on the last batch.

CacheHits

This attribute value shows the number of cache hits counted by the Aggregation profile each time session information is read from the cache.

CacheHits is reset each time the Execution Context is started, or after using resetCounters, as described in the section below, Operations.

CacheMisses

This attribute value shows the number of cache misses counted by the Aggregation profile each time session information cannot be read from the cache and is instead read from disk. Note that if a non-existing session is requested, this will not be counted as a cache miss.

CacheMisses is reset each time the Execution Context is started, or after using resetCounters, as described in the section below, Operations.

CommitTime

This attribute value shows the time (in milliseconds) that has been spent on the last commit.

CreatedSessions

This attribute value shows the total number of sessions created by the Aggregation profile since the  was started, or after using resetCounters, as described in the section below, Operations.

DefragmentationTime

This attribute value shows the time (in milliseconds) that has been spent on the last defragmentation.

OnlineSessionCount

This attribute value shows the number of Aggregation sessions cached in memory.

SessionCount

This attribute value shows the number of Aggregation sessions in storage on the file system.

Operations

Click on Operations in the tree to display the operation alternatives for the Aggregation profile in the right section of the JConsole window.

JConsole displaying the operations for Aggregation with file storage

OperationDescription

resetCounters

Click on the resetCounters operation in the tree to the left and then click this button to reset the values for CacheHits, CacheMisses and CreatedSessions.

Couchbase Storage

When Couchbase storage is selected in an Aggregation profile, you can use JMX beans to view attributes matching similar MIM parameters published by the Aggregation agent.

The MBean is registered under the com.digitalroute.workflow domain, with the key type set to "Workflow" and the key workflow set to the name of the Aggregation workflow.

For information about MIM values published by the Aggregation agent, see 9.3.4 Aggregation Profile

To monitor the Aggregation MIM parameter values, do the following:

  1. Select the picostart process when starting the JMX client, see 7.1 Starting the Jconsole Client for further information.
     
  2. The Java Monitoring & Management Console will open and display the Overview tab.
     
  3. Click on the MBeans tab to display the different beans.

Expand the tree in the left section by clicking on the plus sign for com.digitalroute.workflow, then on the plus sign for Workflow and then on the plus sign for the workflow you want to monitor.

JConsole displaying the operations for Aggregation with Couchbase storage

Attributes

Click on MIM Tree and then Attributes in the tree to display the different attribute values in the right section of the JConsole window.

The values of the attributes listed below are reset when the workflow is restarted.

AttributeDescription

<agent name>.Agent Name

This attribute value shows the name of the Aggregation agent.

<agent name>.Created Session CountThis attribute value shows the number of created aggregation sessions.
<agent name>.Inbound UDRs

This attribute value shows the number of UDRs routed to the agent.

<agent name>.Mirror Attempt Count

This attribute value shows the total number of attempts to retrieve a stored mirror session.

<agent name>.Mirror Error Count

This attribute value shows the number of failed attempts to retrieve a stored mirror session, where the failure was caused by one or more errors.

<agent name>.Mirror Found Count

This attribute value shows the number of successful attempts to retrieve a stored mirror session.

<agent name>.Mirror Latency

This attribute value shows comma separated counters that each contains the number of mirror session retrieval attempts for a specific latency interval. Attempts that failed due to errors are not counted.

The attribute contains 20 counters for a series of 100 ms intervals. The first interval is from 0 to 99 ms and the last interval is from 1900 ms and up.

Example.

The value 1000,100,0,0,0,0,0,0,0,0,0,0,0,0,1 should be interpreted as follows:                                       

  • There are 1000 mirror session retrieval attempts with a latency of 99 ms or less.
  • There are 100 mirror session retrieval attempts with a latency of 100 ms to 199 ms.
  • There is one mirror session retrieval attempt with a latency of 1999 ms or more.
<agent name>.Mirror Not Found Count

This attribute value shows the number of attempts to retrieve a stored mirror session that did not exist.

<agent name>.Outbound UDRs

This attribute value shows the number of UDRs routed from the agent.

<agent name>.Session Remove Count

This attribute value shows the number of sessions removed.

<agent name>.Session Timeout Attempt

Multiple timeout threads may read the same session data from Couchbase but only one of them will perform an update. If a thread reads a session that has already been updated, it will be counted as an attempt. This attribute shows the number of attempts.

<agent name>.Session Timeout Count

This attribute value shows the number sessions that has timed out.

<agent name>.Session Timeout Latency

This attribute value shows comma separated counters that each contains the number of sessions for a specific timeout latency interval i e the difference between the actual timeout time and the expected timeout time.

The attribute contains 15 counters for a series of one-minute intervals. The first interval is from 0 to 1 minutes and the last interval is from 14 minutes and up.

Example.

The value 1000,100,0,0,0,0,0,0,0,0,0,0,0,0,1 should be interpreted as follows:                                        

  • There are 1000 sessions with a timeout latency that is less than one minute.
  • There are 100 sessions with a timeout latency of one to two minutes.
  • There is one session with a timeout latency of 14 minutes or more.

<agent name>.Slowest Create

This attribute value shows the duration of the slowest create operation in Couchbase. The duration is counted in milliseconds and the initial value is -1.

<agent name>.Slowest Delete

This attribute value shows the duration of the slowest delete operation in Couchbase. The duration is counted in milliseconds and the initial value is -1.

<agent name>.Slowest Read

This attribute value shows the duration of the slowest read operation in Couchbase. The duration is counted in milliseconds and the initial value is -1.

<agent name>.Slowest Update

This attribute value shows the duration of the slowest update operation in Couchbase. The duration is counted in milliseconds and the initial value is -1.

<agent name>.Total Number Of CAS MismatchThis MIM parameter contains the number of unsuccessful update operations in Couchbase that failed due to CAS mismatch errors. It is only applicable in asynchronous mode.

<agent name>.Total Number Of Create Count

This attribute value shows the number of successful create operations in Couchbase. A create operation is considered successful if it can be performed without errors.

<agent name>.Total Number Of Delete Count

This attribute value shows the number of successful delete operations in Couchbase. A delete operation is considered successful even if Couchbase returns certain types of errors, i e if data is locked. A delete operation is considered failed if an exception occurs in the internal Couchbase client, if there are concurrent edits (due to optimistic locking), or if a key cannot be found. 

<agent name>.Total Number Of Read Count

This attribute value shows the number of successful read operations in Couchbase. A read operation is considered successful even if Couchbase returns certain types of errors, i e if data is locked or a key cannot be found.

<agent name>.Total Number Of Status Locked Read CountThis MIM parameter contains the number of successful read operations that resulted in errors related to locked data.
<agent name>.Total Number Of Status Read CountThis MIM parameter contains the number of successful read operations in Couchbase that resulted in errors. Errors related to locked data and non-existent keys are not accounted for.
<agent name>.Total Number Of Status Update CountThis MIM parameter contains the number of successful update operations in Couchbase that resulted in errors. Errors related to locked data are not accounted for. 

<agent name>.Total Number Of Update Count

This attribute value shows the number of successful update operations in Couchbase that did not result in errors.

<agent name>.Total Number Of Failed Create Count

This attribute value shows the number of unsuccessful create operations in Couchbase. A create operation is considered failed if it cannot be performed without errors.

<agent name>.Total Number Of Failed Delete Count

This attribute value shows the number of unsuccessful delete operations in Couchbase. A delete operation is considered failed if an exception occurs in the internal Couchbase client, if there are concurrent edits (due to optimistic locking), or if a key cannot be found.

<agent name>.Total Number Of Failed Read Count

This attribute value shows the number of unsuccessful read operations in Couchbase. A read operation is considered failed if an exception occurs in the internal Couchbase client.

<agent name>.Total Number Of Failed Update Count

This attribute value shows the number of unsuccessful update operations in Couchbase. An update operation is considered failed if an exception occurs in the internal Couchbase client, there are concurrent edits (due to optimistic locking), or a key cannot be found.


Next:

8. Appendix 1 - Profiles