Using the Microprofile Metrics feature

You can monitor an IBM® z/OS® Connect Server by using Liberty Microprofile Metrics feature.

zosConnect-3.0 Applies to zosConnect-3.0.

The Liberty Microprofile Metrics feature mpMetrics-3.0 is enabled by default in z/OS Connect 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 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 A launch icon to indicate a link opens a new tab or window. MicroProfile Metrics 3.0.

For more information about how to configure server configuration files, see Overview of IBM z/OS Connect configuration files.

Open Liberty metrics

For a list of all REST endpoint-style metrics that are available for Open Liberty, see the A launch icon to indicate a link opens a new tab or window. metrics reference list.

Custom z/OS Connect metrics

For monitoring the performance of individual API operations 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: application_<operation_name><api_operation>Time_total: Example: application_employeesGetTime_total; Description: A simple timer metric tracks the invocation counts.

Metric Prometheus name: application_<operation_name><api_operation>Time_elapsed Time_seconds{method="api_operation"}: Example: application_employeesGetTime_elapsedTime_seconds {method="GET"}; Description: The elapsed time in seconds for a z/OS Connect API operation to respond.

Metric Prometheus name: application_<operation_name><api_operation>Time_maxTimeDuration_seconds {method="api_operation"}: Example: application_employeesGetTime_maxTimeDuration_seconds {method="GET"}; Description: The maximum time in seconds for a z/OS Connect API operation to respond in the last minute.

Metric Prometheus name: application_<operation_name><api_operation>Time_minTimeDuration_seconds {method="api_operation"}: Example: application_employeesGetTime_minTimeDuration_seconds {method="GET"}; Description: The minimum time in seconds for a z/OS Connect API operation to respond in the last minute.

Metric Prometheus name: application_<operation_name><api_operation>Count_total: Example: application_employeesGetCount_total; Description: The total number of calls to a z/OS Connect API operation.

Metric formats

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 A launch icon to indicate a link opens a new tab or window. MicroProfile metrics REST API.