Troubleshooting Z APM Connect z/OS components
Learn how to identify and correct the errors that can occur when you install and configure Z APM Connect z/OS components.
Problems that are encountered with IBM Z APM Connect on z/OS® can be from several sources.
- Operation based – for example an error occurred in the Z APM Connect Base
- Transaction Tracking API based – an event was not sent.
- Application instrumentation - singularity header was not sent.
Operation-based errors
IBM Z® APM Connect produces error messages for most operational error conditions:
- Z APM Connect Base – to the JES message log
- Z APM Connect Dispatcher – to the JES message log
- Courier – to separate dynamic JES data sets.
For message descriptions, see Messages generated by IBM Z APM Connect.
The Z APM Connect Dispatcher also provides AGMA STATUS
ALL
operator commands to help problem determination. This command displays:
- Z APM Connect Dispatcher status
- Status of every Courier currently running
- Number of events that are processed by each Courier
- Status of
SEND
- Number of address spaces that are currently connected to the Z APM Connect Dispatcher
Use the Z APM Connect Dispatcher command AGMA DEBUG
EVENTS
to list the contents of all events that are received by each Courier process running
within the Z APM Connect Dispatcher. Turn this off using the
AGMA DEBUG OFF
command.
API-based errors
API callers send an event to an IBM Z APM Connect Queue running in the Z APM Connect Dispatcher. This event is validated and will not be placed on the Queue if:
- Z APM Connect Base subsystem is not up and available
- Z APM Connect Dispatcher is not up and available
- Neither the Courier or the Queue is active and available
- The structure of the event is invalid
- An internal error occurred
In all of these situations, a relevant return code is passed back to the Transaction Tracking API function caller. See Reference Return codes for a list of return codes.
Application Instrumentation errors
To track application response time on z/OS®, the application must first be instrumented with an Instana agent and the application must be defined to the Instana backend. A properly instrumented application passes a correlator, called a singularity header to applications that run on z/OS. When the correlator is not created, the application is typically not seen in the Instana UI. Refer to Instana Support when this correlator is not being created.