Configuring CICS TG request exit

To trace transactions through the CICS® Transaction Gateway for z/OS, you must configure each instance of the CICS TG daemon with the applicable implementation of the AGMServerExit request monitoring exit. When you configure the request monitoring exit, it enables the collection of transaction information that it passes through the CICS TG Gateway daemon, and sends this information to the IBM® Z APM Connect Distributed Gateway.

Before you begin

Install and configure the following software before you enable Z APM Connect CICS TG support.

  • Apply the available PTFs to the Z APM Connect z/OS® components. For more information about the fix packs, see tech note.

  • The CICS TG uses IPIC protocol to connect to the relevant CICS Transaction Server.

Procedure

  1. Download the 6.2.0-INSTANA-FP<version_number>-plugins.tar.gz file from the fix pack package that you can download from Fix Central x86 or Fix Central s390x.
  2. Run the following command to extract the 6.2.0-INSTANA-FP<version_number>-plugins.tar.gz file:
    tar -xvf 6.2.0-INSTANA-FP<version_number>-plugins.tar.gz

    The following two files are extracted:

    plugins
    ├── AGM-RequestExit.tar
    └── ibm-agm-tmra-plugin-6.2.0-V.jar
  3. Run the following command to extract the AGM-RequestExit.tar file:
    tar -xvf AGM-RequestExit.tar
    The following files are extracted:
    AGM-RequestExit
    ├── AGM-RequestExit-Plugin.jar (for AppDynamics only)
    └── AGM-RequestExit.jar
    └── agmconfig.properties
    └── log4j2.xml
    • AGM-RequestExit.jar contains the AGMClientExit and AGMServerExit classes.
    • agmconfig.properties, a sample properties file that you can configure for monitoring the flow.
    • log4j2.xml, a sample configuration file for logging.
    Note:

    These files also exist on the host side, in the /usr/lpp/IBM/agm directory. AGMREQE is the .tar file.

  4. Attach the Z APM Connect supplied server-side monitoring exit to your CICS TG.
    1. Move the AGM-RequestExit.jar file to the machine on which you are running CICS TG.
    2. Add the AGM-RequestExit.jar file to the class path.
    3. In the CICS TG .ini file, add com.ibm.zapm.ctg.exit.AGMServerExit to the requestexits property.
    4. Add the following system property to JVM:
      AGM.CONF.LOCATION=
      AGM.CONF.LOCATION specifies a directory that you use for Z APM Connect configuration. If you are using an ENV file, then you can add this property to the CTGSTART_OPTS parameters.
    5. Add a .properties file, for example, agmconfig.properties in the configuration directory that specifies the environment variable AGM_CONF_LOCATION and set the property bootstrap.servers to the address of your Z APM Connect DG in the form of hostname:port.
      Note: A sample agmconfig.properties file is provided with AGM-RequestExit.tar
      • If the Z APM Connect DG standalone Docker distribution is used, the 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 the Z APM Connect DG cluster distribution is used, the hostname is the cluster's kafka ingress/route; if using OpenShift, port must be set to 443 to use OpenShift routes. For example,
        bootstrap.servers=kafka.apps.DGM2.sub.company.ibm.com:443
  5. Check the /etc/hosts file in the z/OS system to confirm the hostname and IP of the DG are defined.
    • If Z APM Connect DG is installed on a Linux Machine with Docker, then specify:
      10.11.12.13 DGM1.sub.company.ibm.com DGM1
    • If Z APM Connect DG is installed in OpenShift clusters, then 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

Results

The Z APM Connect request monitoring exits are installed.

To verify that AGMServerExit is attached to the CICS TG, configure agm.ctg.server.logging.level as INFO and check the log output for the following message: .

AGMG0035I AGMServerExit completed initialization

What to do next

By default, Z APM Connect request monitoring exits log messages at the INFO level. For more information about how to customize it, see Changing the logging level of request monitoring exits from Z APM Connect.