Enabling z/OS Connect EE response time analysis

To enable the JVM monitoring to provide response time metrics for z/OS® Connect services, use a z/OS Connect Interceptor.

Before you begin

The steps in the following example assume that the configuration directory for z/OS Connect is /var/zosconnect/, which might be different in your environment. The configuration directory should contain the servers/ subdirectory and the v2r0/ subdirectory. If the servers/ directory is missing, consider configuring the z/OS Connect EE before you continue. For more information, see IBM z/OS Connect Enterprise Edition: Defining interceptors.

Note: z/OS Connect EE provides a service during a server setup, which lists all of the defined services which a particular user has access to. This service is called through the <host>:<port>/zosConnect/services URL, where host is the host name which the server resides on, and port is the HTTP or HTTPS port that is configured for communication in the server.xml. This service has a predefined value in the OMEGAMON enhanced 3270 user interface or Tivoli Enterprise Portal. When this service is called, it is displayed in either user interface with the zOSConnectServices service name.

About this task

You can find the files that are necessary for the z/OS Connect Interceptor code in the /usr/lpp/kan/bin/IBM directory, which is the OMEGAMON® for JVM SMP/E TKANJAR z/OS UNIX System Services target directory.

When you locate the server.xml file for configurations, if you use the default server, the server.xml file can be found in the /var/zosconnect/servers/defaultServer/ directory.

With JVM resource monitoring configured, the JVM option for the boot class path reads as follows:

-Xbootclasspath/p:/RTE_USS_RTEDIR/RTE_NAME/kan/hca_64/lib/ext/healthcenter.jar

However, if response time monitoring is required, you must update the preceding line as follows:


-Xbootclasspath/p:/RTE_USS_RTEDIR/RTE_NAME/kan/hca_64/lib/ext/healthcenter.jar
 :/RTE_USS_RTEDIR/RTE_NAME/kan/bin/IBM/kjjboot.jar

Important: If you configure response time monitoring without this step, no response time data is displayed in the OMEGAMON enhanced 3270 user interface or in the TEPS user interface, and you might receive the KJJTX0002E error message followed by a stack trace for each request that is sent to the server.

Procedure

Complete the following steps to enable z/OS Connect EE response time analysis:

Place the files for the z/OS Connect Interceptor code in the following directories:
- kjjtxmon.jar:
  - To use the kjjtxmon.jar file for only one server, put the file in the /var/zosconnect/servers/serverName/KJJ/lib/ directory.
  - To use the kjjtxmon.jar file for multiple servers, put the file in the /var/zosconnect/shared/KJJ/lib directory.
- kjjtxmon.mf: Put the file in the /var/zosconnect/servers/serverName/KJJ/lib/features/ or /var/zosconnect/shared/KJJ/lib/features directory and ensure that the file path matches the kjjtxmon.jar path up to features.
- kjj.properties: Put the file in the /var/zosconnect/v2r0/extensions/ directory. Then, edit the com.ibm.websphere.productInstall field to point to the directory that lib resides above, but not including lib.
Open the server.xml file, and then make the following configurations:
1. Add the kjjtxmon feature in the featureManager tag:
```
<feature>kjj:kjjServiceMonitor</feature>
```
  where kjj is the name of the kjj.properties file, and kjjServiceMonitor is the product ID within that kjj.properties file.
  Note: If you cannot find the <featureManager> tag, create one.
2. Define the interceptor to be added to the interceptor list for z/OS Connect.
3. Outside the featureManager tag, add the following feature in the server tag:
```
<kjj_kjjServiceMonitorIbmalias
              id="kjjServiceMonitorInterceptor" sequence="100" />
```
  where kjj_ is the name of the properties file and sequence sets the priority for the interceptor, which determines the order in which each interceptor runs when there are multiple interceptors.
4. Configure z/OS Connect Interceptor Manager by using the <zosconnect_zosConnectManager> tag that has the zosConnectGlobals id, for example,
```
<zosconnect_zosConnectManager requireAuth="false"
    reqireSecure="false" id="zosConnectGlobals"
    globalInterceptorsRef="interceptorList1" />
```
  Note: If you cannot find the zosconnect_zosConnectManger tag, create one.
5. Add the KJJ Interceptor to the interceptor list by using the zosconnect_zosConnectInterceptors tag whose ID matches the globalInterceptorsRef in Step d, for example,
```
<zosconnect_zosConnectInterceptors id="interceptorList1"
  interceptorRef="kjjServiceMonitorInterceptor" />
```
  where kjjServiceMonitorInterceptor must match the id value that is defined in Step b. If there are existing values for interceptorRef, these values must be comma-separated.
  Note: If you cannot find the zosconnect_zosConnectInterceptors tag, create one.
Restart the JVM server within the application.

Important: You must restart the JVM server for each JVM that you want to monitor.