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:

https://<container-host>:<port>/metrics

For example, where 9443 is the HTTPS port number for your z/OS Connect Designer, the following https endpoint is used.

https://localhost:9443/metrics

Authorize access to the metrics endpoint

The /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

For monitoring the performance of individual API operations IBM z/OS Connect collections date on the following custom 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
`application_<operation_name> <api_operation>Time_total`	`application_employeesGetTime_total`	A simple timer metric tracks the invocation counts.
`application_<operation_name><api_operation> Time_elapsedTime_seconds {method="api_operation"}`	`application_employeesGetTime_ elapsedTime_seconds {method="GET"}`	The elapsed time in seconds for a z/OS Connect API operation to respond.
`application_<operation_name><api_operation> Time_maxTimeDuration_seconds {method="api_operation"}`	`application_employeesGetTime _maxTimeDuration_seconds {method="GET"}`	The maximum time in seconds for a z/OS Connect API operation to respond in the last minute.
`application_<operation_name><api_operation> Time_minTimeDuration_seconds {method="api_operation"}`	`application_employeesGetTime _minTimeDuration_seconds {method="GET"}`	The minimum time in seconds for a z/OS Connect API operation to respond in the last minute.
`application_<operation_name><api_operation> Count_total`	`application_employeesGetCount _total`	The total number of calls to a z/OS Connect API operation.

Metric format

Two output formats are supported:

Prometheus format, which is a compatible with the Prometheus monitoring tool.
JSON format, which is a JSON representation of the metrics.

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.