Adding support for Debug Profile Service
Debug Profile Service consists of a server and REST APIs that use the HTTP protocol to provide RESTful services to manage debug profiles, IMS Isolation, and user authentication.
The server runs on z/OS, and uses IBM z/OS Liberty Embedded as the web server.
The following REST APIs are provided with Debug Profile Service:
- Debug Profile Service API (DPS API) is a REST API that runs on z/OS to manage debug profiles in both CICS and non-CICS environments (handles batch, IMS, Db2® stored procedure profiles stored in EQAUOPTS data sets).
- IMS Transaction Isolation Service API (IMS ISO API) is a REST API that runs on z/OS that allows users to isolate IMS transactions for debugging. It is similar to the Batch Interface of IMS Transaction Isolation Facility of z/OS Debugger, which invokes the program EQANIPSB to perform IMS Transaction Isolation functions.
- Authentication Service API (AUTH API) is a REST API that runs on z/OS to authenticate mainframe user credentials. The following authentication methods are supported: Internally, all Debug Profile Service REST APIs use the same authentication method to perform authentication functions.
- Data Collector Service API is a REST API that runs on z/OS to allow access to data accumulated by Data Collector to be used with Test Accelerator for Z. For more information, refer to Adding Support for Data Collector Rest Service API and Adding support for Data Collector and Data Collector Service.
To enable the RESTful services, you need to configure the server and APIs, and then restart the server.
Notes:
- Debug Profile Service requires a 64-bit Java 11, 17 or 21 (with IBM z/OS Liberty Embedded 23.0.0.12 or later). After installation, you need to configure z/OS to run Java applications.
- Debug Profile Service is
hosted on the IBM z/OS Liberty Embedded application
server and is compatible with the default IBM z/OS Liberty Embedded
installation on your z/OS system. You do not need to install or modify the existing IBM z/OS Liberty Embedded application
server to accommodate the Debug Profile Service, but
you need to refresh the eqaprof.env to include environment variable
liberty_dir. - To enable all the features in the z/OS Debugger Profiles view within
Eclipse, you need to install, configure, and start z/OS Explorer Daemon (RSED), along with
the Debug Profile Service
(DPS). Eclipse clients use RSED to automatically retrieve the connection details of the active
DPS instance.
- The minimum required version of z/OS Explorer is 3.2.0.13.
- For z/OS Explorer version 3.4 or later, z/OS Debugger must be registered with RSED. For more information, see the RSED integration. This step is required to allow RSED to automatically detect and retrieve DPS connection details.