Configuring z/OS Connect for API monitoring

IBM® OMEGAMON® for JVM V5.5.0 includes support for monitoring API calls made using z/OS Connect V3.0. This support provides information about every API call made through z/OS Connect. Workspaces in the TEP and enhanced 3270 UI provide summary reports by API name, method, System of Record, Service Provider, and more. Detail reports display statistics for individual API calls.

Note: OpenAPI Specification V3.0 (OpenAPI3) provider and requester APIs monitoring is available beginning with z/OS Connect version 3.0.74 after applying PTF UJ93890 for IBM Z OMEGAMON for JVM.

API monitoring is implemented using a z/OS Connect interceptor provided by IBM Z OMEGAMON for JVM. There is now a choice between two interceptors provided, depending on the Version of z/OS Connect you have installed and the types of requests you wish to monitor.

The interceptors are packaged as OSGi features.
  • For z/OS Connect V3.0.20 and above, you can use the omegamonRequestMonitor-2.0 feature
  • For z/OS Connect V3.0.39 and above, you can alternatively use the omegamonRequestMonitor-3.0 feature
Note: You can only install one version of an OMEGAMON interceptor feature on a z/OS Connect server.
The configuration process is very similar for both versions:
  1. Configure the server for OMEGAMON for JVM resource monitoring.
  2. Install the OMEGAMON interceptor product extension by running one of the supplied scripts.
  3. Define z/OS log stream(s) using one of the supplied JCL job samples. Each server requires a separate log stream.
  4. Configure the z/OS Connect server.xml to activate interceptor on the server.
These steps are described in detail below.
  • Beginning with z/OS Connect version 3.0.74, you can monitor OpenAPI Specification V3.0 (OpenAPI 3) provider and requester APIs, inflight APIs, and so-called “early failure” requests. See Configuring Monitoring for z/OS Connect OpenAPI V3.0 APIs.
  • If you have z/OS Connect V3.0.39 or higher, you can use the “omegamon-3” interceptor, which provides outbound API requester support, inflight APIs, and includes so-called “early failure” requests. See Configuring API Monitoring for z/OS Connect V3.0.39 or higher.
  • If your z/OS Connect server version is 3.0.20 or higher, it is eligible for API monitoring by IBM Z OMEGAMON for JVM. See Configuring API Monitoring for z/OS Connect V3.0.20 or higher.
  • With version 5.5.0 Fix Pack 7 (PTF UJ09673, APAR OA63859), you no longer need to run a batch job to create the log streams required for z/OS Connect API monitoring. This can be a time consuming and potentially error prone process, especially if you have a large number of servers to configure. The log streams are now automatically created on first startup using a template when monitoring is enabled. See Automatically defining log streams.
Note: The legacy monitoring solution (V1) is now deprecated, and customers with z/OS Connect V3.0.20 or higher are encouraged to use the V2 or V3 interceptor.