Configuring Z APM Connect Interceptor

After you install Z APM Connect interceptor onto Unix System Services on z/OS®, configure Z APM Connect interceptor to audit and track transactions entering IMS Connect or CICS® TS through z/OS Connect Enterprise Edition.

1. Optional: Move the AGMMonitor folder to a location within your z/OS Connect EE installation.
   The suggested location is /var/zosconnect/shared/. The shared directory can be easily located and accessed if multiple z/OS Connect EE servers exist and want to implement it.
2. Edit AGMMonitor.properties.
   Open the AGMMonitor.properties file in a text editor and update com.ibm.websphere.productInstall to point to the AGMMonitor directory.
   For example, if the suggestion from step 1 was used, update com.ibm.websphere.productInstall=_INSTALL_DIR to com.ibm.websphere.productInstall=/var/zosconnect/shared/AGMMonitor.
   Note: This file is in ASCII format.
3. Move AGMMonitor.properties to the /var/zosconnect/v3r0/extensions/ directory.
4. Edit the server.xml file in the directory /var/zosconnect/servers/<Server Name>/.
   Note: This file is in ASCII format.
   1. Open the server.xml file in a text editor.
   2. Within the <featureManager> section, add <feature>AGMMonitor:AGMMonitor</feature>.
      This step defines the AGM monitor feature to z/OS Connect EE.

      <featureManager>
      <feature>AGMMonitor:AGMMonitor</feature>
      </featureManager>

   3. Within the <server> definition section and outside the <featureManager> section, add <AGMMonitor_AGMMonitorInterceptorIbmalias id="AGMInterceptor" sequence="1" />. This step defines the Z APM Connect interceptor, and sets it to have the highest priority (sequence="1") if multiple Z APM Connect interceptors are installed. The sequence may be set to a lower priority if needed. The id specified in this step must match the interceptorRef field in the next step.

      <server>
      <featureManager>
      <feature>AGMMonitor:AGMMonitor</feature>
      </featureManager>
      <AGMMonitor_AGMMonitorInterceptorIbmalias id="AGMInterceptor" sequence="1" />
      </server>

   4. Add AGMInterceptor to the interceptorRef list.
      In the server.xml file, search for the zosconnect_zosConnectInterceptors tag to check whether an interceptor list has already been defined when you configure z/OS Connect EE.

      • If defined, add AGMInterceptor to the interceptorRef list. For example:

        <zosconnect_zosConnectInterceptors id="interceptorList1" interceptorRef="userI1, userI2, AGMInterceptor"/>

      • If not defined, add the <zosconnect_zosConnectInterceptors> interceptor definition like the following:

        <zosconnect_zosConnectInterceptors id="interceptorList1" interceptorRef="AGMInterceptor"/>

        The id specified in this step must match the globalInterceptorsRef field in the next step.
   5. Add globalInterceptorsRef to the zosconnect_zosConnectManager element.
      In the server.xml file, search for the zosconnect_zosConnectManager tag to check whether z/OS Connect EE global configuration settings have already been defined when you configure z/OS Connect EE.

      • If defined, ensure that the globalInterceptorsRef field specifies the id used in defining the interceptor list in the previous step. For example,

        <zosconnect_zosConnectManager
        globalInterceptorsRef="interceptorList1"/> 

      • If not defined, add the <zosconnect_zosConnectManager> definition like the following:

        <zosconnect_zosConnectManager globalInterceptorsRef="interceptorList1"/>

5. Define the configuration location of the Z APM Connect interceptor. Set the environment variable AGM.CONF.LOCATION to point to the location of the config directory under AGMMonitor.
   If you use the suggested location /var/zosconnect/shared/specified in step 1, in the PROC that starts z/OS Connect EE or in your JVM.OPTIONS file, specify

   -DAGM.CONF.LOCATION=/var/zosconnect/shared/AGMMonitor/config

6. Edit the agmconfig.properties file.
   Note: This file is in ASCII format.
   1. Go to the AGMMonitor/config/ directory and open agmconfig.properties file in a text editor.
   2. Set the bootstrap.servers variable to the address of Z APM Connect DG in the form of hostname:port.
      Note:

      • If Z APM Connect DG is installed on a Linux Machine with Docker, hostname must be the fully qualified domain name (FQDN) of Z APM Connect DG; port must be set to 30090 to connect properly.
        For example,

        bootstrap.servers=DGM1.sub.company.ibm.com:30090

      • If Z APM Connect DG is installed in OpenShift clusters, hostname is the OpenShift’s kafka.apps process. The prefix value is configurable, so may be something other than kafka.apps; port must be set to 443 to connect properly.
        For example,

        bootstrap.servers=kafka.apps.DGM2.sub.company.ibm.com:443

   3. Optional: Change the logging level of the Z APM Connect interceptor.
      Set the value of the agm.logging.level variable to the proper logging level. The default value is INFO. Possible options are TRACE, DEBUG, INFO, WARN, and ERROR.
   4. Optional: Check the z/OS system’s /etc/hosts file to be sure the hostname and IP of the DG are defined. For example,
      • If Z APM Connect DG is installed on a Linux Machine with Docker, specify

        10.11.12.13 DGM1.sub.company.ibm.com DGM1

      • If Z APM Connect DG is installed in OpenShift clusters, specify

        10.01.02.03    ingress.apps.DGM2.sub.company.ibm.com DGM2 
        10.01.02.03    kafka.apps.DGM2.sub.company.ibm.com   DGM2

7. Recycle the z/OS Connect EE server.
   Note: The Z APM Connect interceptor is started as part of the z/OS Connect EE server startup.

AGMC0002I [Build Date: yyyy-mm-dd_hh:mm:ss] Interceptor activated.