Adding support for Debug Profile Service and APIs

Debug Profile Service is a REST API that uses the HTTP protocol to provide RESTful access to a set of resources related to debug profiles. It provides POST/GET/ PUT/DELETE methods to handle the creation, retrieval, updating, and deleting of debug profiles.

The Debug Profile Service API is similar to the DTCN API, except that it also handles batch, IMS, Db2® stored procedure profiles stored in EQAUOPTS data sets.

Notes:
  • Debug Profile Service requires Java 8, 11, or Start of change17 (with IBM z/OS Liberty Embedded 23.0.0.12 or later)End of change. After installation, you need to configure z/OS to run Java applications.
  • The Debug Profile Service API 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 API, 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 with Eclipse, you need to install, configure and start z/OS Explorer 3.2.0.13 or later and Debug Profile Service. For CICS, also see the instructions in Activating the TCP/IP Socket Interface for CICS.

The Debug Profile Service API handles accessing profiles differently between CICS® and non-CICS.

For CICS, user debug profiles are stored in a repository that is owned by the region. The repository can either be a CICS temporary storage queue (TSQ), or a VSAM data set allocated to DD:EQADPFMB. In either case, the Debug Profile Service API acts as a client, relaying the HTTP request to the DTCN API to handle. Alternatively, Debug Profile Service can be set up to use external CICS interface (EXCI) to manage debug profiles stored in the region’s repository, without using the DTCN API. For more information, see Adding support for the DTCN profiles API or Defining the CICS EXCI CONNECTION and SESSIONS resources.

For non-CICS, debug profiles are stored in EQAUOPTS data sets. The Debug Profile Service API manipulates the data sets directly, and therefore needs to be running on the z/OS® host. Also, proper RACF® setup is required during the API installation to allow for authentication and data set authorization that use SAF/RACF.

You can also configure Debug Profile Service so that your Eclipse IDE users can use IMS Isolation with Debug Profile Service. For more information, see Configuring the IMS Transaction Isolation API for Debug Profile Service.

For the API documentation, see z/OS Debug Profile Service API.