Monitoring a containerized z/OS Connect server
Learn how to monitor the containerized IBM® z/OS Connect server with Liberty Microprofile Metrics.
IBM z/OS Connect provides metrics so you can monitor the performance of your API running in a container. These metrics are provided by Liberty Microprofile Metrics feature that is enabled by default and can be accessed via the following REST endpoint:
For example, where 9443 is the HTTPS port number for your z/OS Connect Designer, the following
endpoint is used.
Authorize access to the metrics endpoint
/metrics endpoint is configured in the IBM z/OS Connect server by default. To access the endpoint, you must
configure or disable authentication in the server configuration file. For more information, see
Monitoring with MicroProfile metrics.
For more information about how to configure server configuration files, see Overview of IBM z/OS Connect server configuration.
Open Liberty metrics
For a list of all REST endpoint-style metrics that are available for Open Liberty, see the metrics reference list.
Custom IBM z/OS Connect metrics
- Count of operation calls.
- Time taken for the operation calls.
These metrics are generated automatically for each of the operations that are defined in your OpenAPI.
|Metric Prometheus name||Example||Description|
||A simple timer metric tracks the invocation counts.|
||The elapsed time in seconds for a z/OS Connect API operation to respond.|
||The maximum time in seconds for a z/OS Connect API operation to respond in the last minute.|
||The minimum time in seconds for a z/OS Connect API operation to respond in the last minute.|
||The total number of calls to a z/OS Connect API operation.|
By default, metric data is emitted in Prometheus format. Metric data can be retrieved in JSON
format by configuring the
Accept header of your request to the
application/json value. For more information, see MicroProfile metrics REST API.