Quick Reference

KPI Definitions for Application Monitoring

This document covers the following topics:

General Information

The tables below describe the KPIs (key performance indicators) monitored by the Application Monitoring Data Collector. The following scenarios are supported. Note that Adapter scenarios require the corresponding connection type.

Scenario Supported by
EntireX
Broker 		EntireX
Adapter... 		...and
Connection Type
RPC x x Direct RPC
CICS IPIC   x CICS IPIC
CICS ECI   x CICS ECI
CICS Socket Listener   x CICS Socket Listener
IMS Connect   x IMS Connect
AS/400   x AS/400

Each scenario has a different set of KPIs for successful requests and for failed requests. For a successful request, the KPI "ErrorCode" is always empty. For a failed request this KPI always has a value.

Each KPI is represented as a row in the CSV file produced by the data collector. The KPI name is identical to the row name in the first column of the CSV file. There is only one common layout of the CSV file. Therefore, depending on the scenario, KPIs may have no values. In this case, the column has an empty entry in the corresponding row. This can be changed to the value "0" by setting the parameter entirex.appmondc.usezeroasnullvalue in the configuration file entirex.appmondc.properties (see Configuring the Application Monitoring Data Collector) or by changing the coresponding parameter in the configuration of the EntireX Adapter. See Use "0" as the null value for numeric KPI values in the EntireX Adapter documentation.

If the KPIs are consumed by an Integration Server service then each KPI is represented by an input parameter of the service using the same name. If a KPI has no value, then the corresponding input parameter has no value.

The sequence of the KPIs in the tables below is the same as the sequence of the KPIs in the CSV file.

Detailed Illustration of Response Time KPIs

The following graphic shows the detailed meanings of the response time KPIs that are collected by the Application Monitoring Data Collector. As an example, a remote procedure call (RPC) from a client application to a server program is illustrated. For a Natural server program, database calls can be monitored too; this is illustrated on the left side of the graphic. Note that the database transport time (TimeDBTransport KPI) is only available for a database call against an Adabas server. For other databases, the database transport time is included in the database calls time (TimeDBCalls KPI). The right side illustrates a non-Natural server program where database calls cannot be monitored.

graphics/kpi_detail.png

  1. The client application issues a remote procedure call and the client RPC layer gets control. At the end of a transaction, the client RPC layer gives the control back to the client application. The time spent in the client RPC layer is monitored by the TimeClientLayer KPI.

  2. The client RPC layer calls the EntireX Broker. The transport time between the client RPC layer and the EntireX Broker plus the transport time spent on the way back is monitored by the TimeClientTransport KPI.

  3. The time spent in the EntireX Broker is monitored by the TimeBroker KPI. The KPI value does not include the amount of time that the EntireX Broker spends waiting for an available server.

  4. The amount of time that the EntireX Broker spends waiting for an available server is monitored by the TimeBrokerWaitForServer KPI.

  5. When the EntireX Broker calls the server program, the server RPC layer receives the call first. The transport time between the EntireX Broker and the server RPC layer plus the transport time spent on the way back is monitored by the TimeServerTransport KPI.

  6. The time spent in the server RPC layer is monitored by the TimeServerLayer KPI.

  7. The server RPC layer forwards control to the Natural server program. The time spent in the Natural server program is monitored by the TimeServerProgram KPI. The KPI value does not include the time spent for database calls.

  8. The Natural server program calls a database. The transport time between the Natural server program and the database plus the transport time spent on the way back is monitored by the TimeDBTransport KPI. This KPI is only available for Natural RPC servers issuing database calls against an Adabas server.

  9. The time spent for database calls is monitored by the TimeDBCalls KPI. For non-Adabas databases, the KPI value includes also the transport time required to reach the database server. This KPI is only available for Natural RPC servers.

  • The TimeResponse KPI reflects the complete response time on the round trip from the client to the server. It is therefore the sum of the KPIs mentioned above.

KPIs to Collect Response Time, Statistical Information etc.

Use the following KPIs to collect response times and find bottlenecks in distributed scenarios. Collect statistical information on how often a service is used.

KPIs for RPC - Successful Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "RPC".
ApplicationName "application-name" as defined by the broker attribute APPMON-NAME. If the broker attribute is not specified, the server address is used; for example RPC/SRV/CALLNAT.
Address The broker ID and the server address of the RPC request.
TimeResponse The complete response time (roundtrip from client to server and back) in microseconds.
TimeClientLayer The time spent in the client RPC layer in microseconds.
TimeClientTransport The transport time from the client to the broker and back in microseconds.
TimeBroker The time spent in the broker (active processing) in microseconds.
TimeBrokerWaitForServer The time spent in the broker waiting for an available server in microseconds.
TimeServerTransport The transport time from the broker to the server and back in microseconds.
TimeServerLayer The time spent in the server RPC layer (runtime and stub) in microseconds.
TimeServerProgram The time spent in the user program (called by the RPC server) in microseconds. For Natural programs on a mainframe, this time does not include the database times. For other programs, the database times are included.
TimeDBCalls The time spent for database calls in microseconds. For an Adabas database, this is the time the Adabas server needs to process the database call ("client wait time"). For other databases, the DB calls time includes also the DB transport time. 1
TimeDBTransport The transport time from the Natural user program to the Adabas router and back including the client receiving time in microseconds. 1, 2
Program The program name.
ClientApplication The client application name as defined in the broker control block.
ClientHost The client host name.
ClientUser The client user ID.
LengthRequest The length of the RPC request in bytes.
LengthReply The length of the RPC reply in bytes.
LengthTotal The total length of the RPC call (request plus reply) in bytes.
DBCalls The number of database calls (including system file calls, without Natural Security calls). 1
ErrorCode Always empty.
MessageID The message ID of the RPC request (if available).
CorrelationID The message ID of the RPC reply (if available).

Notes:

1 This KPI is only available if the call is issued by a Natural RPC server on a mainframe.

2 This KPI is only available for a database call against an Adabas server.

KPIs for CICS IPIC - Successful Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "CICS IPIC".
ApplicationName "host-name:port-number" of the CICS IPIC installation.
Address The name of the Integration Server adapter service which calls CICS IPIC.
TimeResponse The complete response time of the CICS IPIC request in microseconds.
TimeClientLayer The time spent in the EntireX Adapter in microseconds.
TimeServerLayer The sum of the transport time to CICS IPIC and the time spent in the CICS user program in microseconds.
Program The CICS program name.
ClientHost The client host name.
ClientUser The client user ID.
LengthRequest The length of the CICS request in bytes.
LengthReply The length of the CICS reply in bytes.
LengthTotal The total length of the CICS call (request plus reply) in bytes.
ErrorCode Always empty.
MessageID The message ID of the CICS request (if available).

KPIs for CICS ECI - Successful Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "CICS ECI".
ApplicationName "host-name:port-number" of the CICS ECI installation.
Address The name of the Integration Server adapter service which calls CICS ECI.
TimeResponse The complete response time of the CICS ECI request in microseconds.
TimeClientLayer The time spent in the EntireX Adapter in microseconds.
TimeServerLayer The sum of the transport time to CICS ECI and the time spent in the CICS user program in microseconds.
Program The CICS program name.
ClientHost The client host name.
ClientUser The client user ID.
LengthRequest The length of the CICS request in bytes.
LengthReply The length of the CICS reply in bytes.
LengthTotal The total length of the CICS call (request plus reply) in bytes.
ErrorCode Always empty.
MessageID The message ID of the CICS request (if available).

KPIs for CICS Socket Listener - Successful Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "CICS Socket Listener ".
ApplicationName "host-name:port-number" of the CICS Socket Listener.
Address The name of the Integration Server adapter service which calls the CICS Socket Listener.
TimeResponse The complete response time of the CICS Socket Listener request in microseconds.
TimeClientLayer The time spent in the EntireX Adapter in microseconds.
TimeServerTransport The transport time from the adapter to the CICS Socket Listener and back in microseconds.
TimeServerLayer The time spent in the CICS Socket Listener layer in microseconds.
TimeServerProgram The time spent in the CICS user program (called by the CICS Socket Listener) in microseconds.
Program The CICS program name.
ClientHost The client host name.
ClientUser The client user ID.
LengthRequest The length of the CICS request in bytes.
LengthReply The length of the CICS reply in bytes.
LengthTotal The total length of the CICS call (request plus reply) in bytes.
ErrorCode Always empty.
MessageID The message ID of the CICS request (if available).

KPIs for IMS Connect - Successful Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "IMS Connect".
ApplicationName "host-name:port-number/datastore" of the IMS Connect installation.
Address The name of the Integration Server adapter service which calls IMS Connect.
TimeResponse The complete response time of the IMS request in microseconds.
TimeClientLayer The time spent in the EntireX Adapter in microseconds.
TimeServerLayer The sum of the transport time to IMS Connect and the time spent in IMS Connect, IMS and the IMS user program in microseconds.
Program The IMS transaction name.
ClientHost The client host name.
ClientUser The client user ID.
LengthRequest The length of the IMS request in bytes.
LengthReply The length of the IMS reply in bytes.
LengthTotal The total length of the IMS call (request plus reply) in bytes.
ErrorCode Always empty.
MessageID The message ID of the IMS request (if available).

KPIs for AS/400 - Successful Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "AS400".
ApplicationName "host-name" of the AS/400 host.
Address The name of the Integration Server adapter service which calls AS/400.
TimeResponse The complete response time of the AS/400 request in microseconds.
TimeClientLayer The time spent in the EntireX Adapter in microseconds.
TimeServerLayer The sum of the transport time to AS/400 and the time spent in AS/400 and the AS/400 user program in microseconds.
Program The AS/400 prorgam name.
ClientHost The client host name.
ClientUser The client user ID.
LengthRequest The length of the AS/400 request in bytes.
LengthReply The length of the AS/400 reply in bytes.
LengthTotal The total length of the AS/400 call (request plus reply) in bytes.
ErrorCode Always empty.
MessageID The message ID of the AS/400 request (if available).

KPIs to Collect Error Situations

Use the following KPIs to analyze error situations. Find out which problems occur most often and need to be solved first to reach maximum stability.

KPIs for RPC - Failed Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "RPC".
ApplicationName "application-name" as defined by the broker attribute APPMON-NAME. If the broker attribute is not specified, the server address is used; for example RPC/SRV/CALLNAT.
Address The broker ID and the server address of the RPC request.
TimeResponse The response time of the failed RPC request in microseconds.
Program The program name.
ClientApplication The client application name as defined in the broker control block.
ClientHost The client host name.
ClientUser The client user ID.
ErrorCode The 8-digit error code (error class and number).
ErrorMessage The error message.
MessageID The message ID of the RPC request (if available).
CorrelationID The message ID of the RPC reply (if available).

KPIs for CICS IPIC - Failed Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "CICS IPIC".
ApplicationName "host-name:port-number" of the CICS IPIC installation.
Address The name of the Integration Server adapter service which calls CICS IPIC.
TimeResponse The response time of the failed CICS IPIC request in microseconds.
Program The CICS transaction name.
ClientHost The client host name.
ClientUser The client user ID.
ErrorCode The 8-digit error code (error class and number).
ErrorMessage The error message.
MessageID The message ID of the CICS request (if available).

KPIs for CICS ECI - Failed Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "CICS ECI".
ApplicationName "host-name:port-number" of the CICS ECI installation.
Address The name of the Integration Server adapter service which calls CICS ECI.
TimeResponse The response time of the failed CICS ECI request in microseconds.
Program The CICS transaction name.
ClientHost The client host name.
ClientUser The client user ID.
ErrorCode The 8-digit error code (error class and number).
ErrorMessage The error message.
MessageID The message ID of the CICS request (if available).

KPIs for CICS Socket Listener - Failed Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "CICS Socket Listener ".
ApplicationName "host-name:port-number" of the CICS Socket Listener.
Address The name of the Integration Server adapter service which calls the CICS Socket Listener.
TimeResponse The response time of the failed CICS Socket Listener request in microseconds.
Program The CICS program name.
ClientHost The client host name.
ClientUser The client user ID.
ErrorCode The 8-digit error code (error class and number).
ErrorMessage The error message.
MessageID The message ID of the CICS request (if available).

KPIs for IMS Connect - Failed Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "IMS Connect".
ApplicationName "host-name:port-number/datastore" of the IMS Connect installation.
Address The name of the Integration Server adapter service which calls IMS Connect.
TimeResponse The response time of the failed IMS request in microseconds.
Program The IMS transaction name.
ClientHost The client host name.
ClientUser The client user ID.
ErrorCode The 8-digit error code (error class and number).
ErrorMessage The error message.
MessageID The message ID of the IMS Connect request (if available).

KPIs for AS/400 - Failed Requests

KPI Name Description
Time The time the event has been processed by the data collector in the format "YYYY-MM-DD HH:MM:SS.SSS" using the current time zone.
Timestamp The time the event has been processed by the data collector as a number. The number is the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
Scenario The scenario identifier "AS400".
ApplicationName "host-name" of the IMS Connect installation.
Address The name of the Integration Server adapter service which calls AS/400.
TimeResponse The response time of the failed AS/400 request in microseconds.
Program The AS/400 transaction name.
ClientHost The client host name.
ClientUser The client user ID.
ErrorCode The 8-digit error code (error class and number).
ErrorMessage The error message.
MessageID The message ID of the AS/400 request (if available).