This section contains the list of metrics that Monitoring Suite reports.
| Metric Name | Node where the metric is checked | Description | Associated script parameter |
|---|---|---|---|
| oa.check_apsapi | Management node | REST API availability | check_apsapi
|
| oa.check_azurecsp | Azure CSP endpoint availability | check_azurecsp
|
|
| oa.check_bssapi | BSS XML-RPC availability | check_bssapi
|
|
| oa.check_bsspgsql | BSS database availability | check_bsspgsql
|
|
| oa.check_failed_orders[ST_ID] | Absence of failed orders for subscriptions based on a specific service template | check_failed_orders
|
|
| oa.check_oa.check_idp | Identity Service availability | check_idp
|
|
| oa.check_o365 | Microsoft 365 endpoint availability | check_o365
|
|
| oa.check_ordermanagement | Order Management service availability | check_ordermanagement
|
|
| oa.check_ossapi | OSS XML-RPC availability | check_ossapi
|
|
| oa.check_osspgsql | OSS database availability | check_osspgsql
|
|
| oa.check_rde | Reporting and Data Export availability | check_rde
|
|
| oa.check_stuck_orders[OA_STID] | Absence of stuck orders for subscriptions based on a specific service template | check_stuck_orders
|
|
| oa.check_ux1marketplace | UX1 Marketplace availability | check_ux1marketplace
|
|
| oa.check_dbr | UI node | Database replica availability | check_dbr
|
| oa.check_pcplogin | Possibility to log in to the Provider Control Panel | check_pcplogin
|
|
| oa.check_ux1login | Possibility to log in to UX1 | check_ux1login
|
|
| oa.jmx.login_through_api | Both management and UI nodes | Performance of logging in using API | jmx
|
| oa.jmx.login_through_page | Performance of logging in through a login page | ||
| oa.jmx.oss_change_subscription_limits | Performance of changing subscription limits | ||
| oa.jmx.oss_provide_subscription | Performance of subscription provisioning | ||
| oa.jmx.pcp_customers | Performance of the Customers screen in the Provider Control Panel | ||
| oa.jmx.pcp_resellers | Performance of the Resellers screen in the Provider Control Panel | ||
| oa.jmx.rest_get_notifications | Performance of notification retrieval using REST API (also used by UX1) | ||
| oa.jmx.rest_get_plans | Performance of plan retrieval using REST API (also used by UX1) | ||
| oa.jmx.rest_get_plan_deals | Performance of getting deal pricing using REST API (also used by UX1) | ||
| oa.jmx.ux1_dashboard | Performance of the home UX1 screen | ||
| oa.jmx.ux1_users | Performance of the Users screen in UX1 | ||
| oa.jmx.rest_estimate_order | Order estimation operation latency | ||
| oa.jmx.rest_place_order | Order placement operation latency | ||
| oa.jmx.xnio_worker_pui | The number of threads which are currently processing requests in the UI | ||
| oa.jmx.xnio_worker_remoting | The number of threads which are currently processing requests in the OSS XML-RPC engine | ||
| oa.jmx.xnio_worker_apscontroller | The number of threads which are currently processing requests in the APS controller |
How to check metrics manually
Each of these metrics is monitored by Zabbix after you deploy and configure CloudBlue Commerce Monitoring Suite. You can also check any of these metrics manually from a UI or management node. Consult the table above to choose the node from which to check the metric.
For example, to check whether the Microsoft 365 endpoint is available, connect to the management node using SSH and run the following command:
python /usr/local/pem/monitoring/zabbix_oa_metrics.py check_o365The output of the command will be:
1, if the endpoint is operational,0, if there is an issue, for example, the endpoint node is down or there is a connectivity issue between the management and the endpoint nodes.
Run the command in debug mode to get more details on the issue if the output is 0. In this example, we will check whether logging to UX1 is possible:
python /usr/local/pem/monitoring/zabbix_oa_metrics.py --debug check_ux1loginExample of the output that indicates an incorrect response was received on running the check:
ERROR:root:metric check_ux1login failed: Response does not contain pattern '<div id="ccp-content"': <html><head><script>top.location.href='/?reason=invalid_data';</script></head><body></body></html>
...
Exception: Response does not contain pattern '<div id="ccp-content"': <html><head><script>top.location.href='/?reason=invalid_data';</script></head><body></body></html>
0The most likely reason for this issue is that incorrect credentials for the UX1 panel availability check were specified in the /usr/local/pem/monitoring/monitoring.ini file. After correcting the credentials, the response in debug mode changes to:
INFO:root:launching metric: check_ux1login
INFO:root:metric 'check_ux1login' result: 1
1