Configuring z/OS Connect for API monitoring

OMEGAMON® AI for JVM, 6.1.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 UJ94007 for IBM Z OMEGAMON AI for JVM.

API monitoring is implemented using a z/OS Connect interceptor provided by IBM® Z OMEGAMON AI for JVM. The z/OS Connect interceptor supports z/OS Connect V3.0.39 and above.

The configuration process is as follows:

Configure the server for OMEGAMON AI for JVM resource monitoring.
Install the OMEGAMON AI interceptor product extension by running the supplied script.
Define z/OS log stream(s) using one of the supplied JCL job samples. Each server requires a separate log stream.
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 Monitoring for z/OS Connect OpenAPI V2.0 APIs.