Debug Profile Service diagnostics

  • Debug Profile Service exposes an internal Swagger API endpoint, which is available and enabled by default. To verify this and obtain the full URL, check the server’s JES standard output (STDOUT) stream. Liberty logs the URL with message ID CWWKT0016I, and it ends with /explorer. If the explorer endpoint is not logged, contact your system programmer to ensure Debug Profile Service is the latest version. You can paste this URL into your browser to view a friendly user interface to test the supported API endpoints.

  • Liberty is currently configured to bind to all host names (*), which means it will use all available network interfaces. If multiple TCP/IP stacks are active, Liberty will bind to all network interfaces across all active stacks. For diagnostic purposes, Liberty logs only the first hostname it detects. If you want to restrict Liberty to a specific TCP/IP stack, set the following environment variable:

    _BPXK_SETIBMOPT_TRANSPORT=stack_name

    To apply this setting, add the environment variable to the job that starts the Liberty server, replacing stack_name with the name of the desired TCP/IP stack on your system. You can determine the available TCP/IP stacks by issuing the MVS console command:

    D TCPIP.

    For example, you can define the environment variable in EQAW.SEQASAMP(EQAPROF).

  • Debug Profile Service uses standard HTTP status codes to indicate the success or failure of the API call. If a failure occurs, the response contains a JSON body with an IBM message ID, which can be used to look-up more information about the error in Debug Profile Service messages.
  • The following logging indicators are used to verify whether Debug Profile Service has started or stopped. Logs that are prefixed with CWWKZ are generated by the IBM z/OS Liberty Embedded server framework.
    • Server Started:
      • Server’s JES Job Standard Output (STDOUT)
        Debug Profile Service API started with context path  [<context_path>/profile]      
IMS Transaction Isolation Service API started with context path  [<context_path>/imsiso]
Authentication Service API started with context path [<context_path>/auth]
      • JES System Log
        +CWWKZ0001I: Application profile-management started in <time> seconds
+CWWKZ0001I: Application ProfileService started in <time> seconds
    • Server Stopped:
      • JES System Log
        +CWWKZ0009l: The application ProfileService has stopped successfully.
+CWWKZ0009l: The application profile-management has stopped successfully.