IBM ACE Global Cache Statistics Test

The global cache is embedded in the integration node of the IBM App Connect Enterprise. This global cache is a repository for data that you want to reuse. For example, you can use a global cache in WebSphere MQ message flows to store correlation information for use beyond a specific message flow node, instance of a message flow, integration server, or integration node. The cache facilitates sharing of data across processes (both in the same integration node, and across integration nodes) and eliminates the need for an alternative solution, such as a database. You can use one message flow node to store data in the global cache, then a second node (in the same message flow or a separate flow), can retrieve that data from the global cache.

You can use a message flow node to interact with the global cache. Interactions with the cache happen outside the message flow transaction, and are committed immediately. If an exception is thrown downstream of the node that interacts with the cache, the cache interactions are not rolled back.

A global cache is said to be effectively utilized only if it is able to service the maximum number of requests to the IBM App Connect Enterprise; this greatly reduces direct data accesses and related overheads, and thus improving the server performance. On the contrary, ineffective cache usage can be the key contributor to a slowdown or degradation in server performance, as it increases direct data accesses.

This test monitors each global cache of the IBM App Connect Enterprise and reports its usage - in terms of its request serving ability. In the process, the test proactively alerts administrators to the under-utilization of the global cache and the failures in connecting to the cache, and helps them quickly initiate corrective measures.

Target of the test : An IBM App Connect Enterprise

Agent deploying the test : An internal/remote agent.

Outputs of the test : One set of results for each Execution group:decision service that is to be monitored

Configurable parameters for the test
Parameters	Description
Test period	How often should the test be executed.
Host	The host for which the test is to be configured.
Port	The port on which the specified host listens. The default is 2414.
QM Host	By default, the eG agent collects the performance metrics from the target IBM App Connect Enterprise and stores the metrics in the queue manager of the IBM WebSphere MQ server that is loosely coupled with the target IBM App Connect Enterprise. To store the performance metrics, the eG agent should be aware of the host name or IP address of the queue manager. For this, specify the host name or the IP address of the queue manager in the QM Host text box.
QM Port	Specify the port number on which the queue manager is listening for client connections. The default is 2414.
QM User	If you want to login as a specific MQ user to execute this test, then specify a valid user name in the User text box. The test will fail if an invalid user name is specified here. If no such authentication is required, then this parameter can be set to 'none'. If the user belongs to an Active Directory group, then, specify the user name in the following format: <username>@<domain name>. For example, if the user belongs to eginnovations/john, then, your specification should be: john@eginnovations.com.
QM Password	If a specific User is entered, then the password of that user has to be specified in the Password text box.
Confirm Password	Confirm the password by retyping it in the Confirm Password text box.
SERVERCONNCHANNEL	The name of the server connection channel for the WebSphere MQ server. The default value is "SYSTEM.DEF.SVRCONN". If you prefer not to use this default server connection channel for monitoring purposes, then you can create a custom channel in the WebSphere MQ server and use it for monitoring. The steps for achieving this have been detailed in Creating a Custom Channel topic.
SSL Cipher Spec	This parameter is applicable only if SSL-enabled channel is used for communication to the target IBM App Connect Enterprise, if not, set this parameter to none. A cipher suite is a set of cryptographic algorithms that are used before a client application and server exchange information over an SSL/TLS connection. It consist of sets of instructions on how to secure a network through SSL (Secure Sockets Layer) or TLS (Transport Layer Security). In this text box, provide the cipher suite that is allowed for SSL/TLS connection to the target server. By default, this parameter is set to none. To know if SSL-enabled channel is used for communication, refer to Enabling One-Way SSL Communication on the Channel topic.
Two Way SSL	This parameter is applicable only if SSL-enabled channel is used for communication to the target IBM App Connect Enterprise, if not, set this flag to No. If two-way SSL authentication is used then set this flag to Yes. Set this flag to No if one-way SSL communication is used.
Truststore	This parameter is applicable only if SSL-enabled channel is used for communication to the target IBM App Connect Enterprise, if not, set this parameter to none. Truststore is used to store certificates from Certified Authorities (CA) that verify and authenticate the certificate presented by the server in an SSL connection. Therefore, the eG agent should have access to the truststore where the certificates are stored to authenticate and connect with the target server and collect metrics. For this, first extract the certificates from the server into the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks. To know how to create and extract the certificate into the truststore, refer to Configuring the eG Agent to Monitor the Queue Manager. Then, provide the truststore file name in this text box. For example: egmqsslstore.jks. However, if you are using a different location to store the certificate then, provide the full path to this file in this text box. By default, none is specified against this text box.
Truststore Password	This parameter is applicable only if SSL-enabled channel is used for communication to the target IBM App Connect Enterprise, if not, set this parameter to none. If a Truststore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Truststore File.
Confirm Password	This parameter is applicable only if SSL-enabled channel is used for communication to the target IBM App Connect Enterprise, if not, set this parameter to none. Confirm the password by retyping it in this text box.
Keystore	This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none. Keystore contains the private keys for the certificates that the client can provide to the server upon request. eG agent requires access to the keystore where client certificate is stored to send that to the server so that the server validates the certificate against the one contained in its trustore. For this purpose, first create the client certificate in the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks. To know how to create the certificate, refer to Configuring the eG Agent to Monitor the Queue Manager. Then, provide the keystore file name in this text box. For example:egmqsslstore.jks. However, if you are using a different location to store the certificate then, provide the full path to this file in this text box. By default, none is specified against this text box. If you are using one-way SSL authentication, this parameter is set to none.
Keystore Password	This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none. If a Keystore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Keystore File.
Confirm Password	This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none. Confirm the password by retyping it in this text box.
Queue Resource Stats	Specify the name of the local queue that you have created for storing the Resource statistics. To know more about how to create a local queue, refer to Creating a Local Queue.
Queue Flow Stats	Specify the name of the local queue that you have created for storing the Message flow statistics. To know more about how to create a local queue, refer to Creating a Local Queue.
Timeout	Specify the duration (in seconds) within which the query executed by this test should Timeout in this text box. The default is 120 seconds.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Successful connects to the cache	Indicates the number of successful attempts that were made from the integration server to this global cache during the last measurement period.	Number
Map reads	Indicates the number of read operations that were completed by message flows in the integration server on this global cache during the last measurement period.	Number	A high value is desired for this measure. A low value or a consistent drop in this value is a cause for concern, as it indicates ineffective cache usage. This means high direct accesses of data, and poor server performance. One of the common reasons for bad cache usage is improper cache size. A cache that does not have sufficient space to accommodate entries will not be able to service requests effectively. You may hence have to allocate more space to the cache or free-up space in the cache to accommodate more entries.
Map writes	Indicates the number of write operations that were completed by message flows in the integration server on this global cache during the last measurement period.	Number	This measure is incremented when adding or updating an entry in the cache. A high value is desired for this measure. A low value or a consistent drop in this value is a cause for concern, as it indicates ineffective cache usage. This means high disk accesses, and poor server performance. One of the common reasons for bad cache usage is improper cache size. A cache that does not have sufficient space to accommodate entries will not be able to service requests effectively. You may hence have to allocate more space to the cache or free-up space in the cache to accommodate more entries.
Map removes	Indicates the number of remove operations that were completed by message flows in the integration server on this global cache during the last measurement period.	Number	This measure is incremented when an entry is removed/updated from the cache.
Message failed operations on the cache map	Indicates the number of failed map operations by message flows in the integration server on this global cache during the last measurement period.	Number
Map used	Indicates the total number of maps used by message flows in the integration server on this global cache during the last measurement period.	Number
Connection failures	Indicates the number of failed attempts to connect from the integration server to the global cache during the last measurement period.	Number	A low value is desired for this measure. A high value or a consistent increase in this value is a cause for concern, as it indicates ineffective cache usage.
Total map actions	Indicates the number of map operations that were completed by message flows in the integration server on the global cache during the last measurement period.	Number	The value of this measure includes reads, writes, removes, and key checks.