Health Monitoring collects and aggregates performance metrics across your VMS. Use it to check system stability, identify active errors, and troubleshoot hardware and software issues across large deployments.

Each Media Servers collect health metrics independently. The Site then aggregates these metrics into a unified view accessible through the Media Server REST API.

Key components of Health Monitoring

Health Monitoring relies on three main concepts: manifests, metrics, and alerts.

Manifests

A manifest defines the available parameters and attributes collected by the Site. It specifies which fields you can view and dictates what information the VMS collects from your Media Servers. Manifest parameters can change between software versions to accommodate new features and updates.

Metrics

Metrics are parameters that track the state of specific entities in your Site. The Site groups metrics into five categories:

• Site-level: Aggregated counts including total servers, camera channels, storage locations, active users, and the Nx Witness software version.

• Media Server-level: Hardware and system performance, including CPU/RAM usage, server uptime, public IP address, operating system, active plugins, and event activations.

• Camera-level: Device performance, including camera status, stream resolutions, actual FPS vs. target FPS, offline events, and archive storage analytics.

• Storage-level: Storage health and usage, including directory paths, total and used storage space (GB), read/write speeds, and error events in the last 24 hours.

• Network-level: Network interface performance, including interface status, IP addresses, and input/output (I/O) data transfer rates in KB per second.

Alerts

When a metric exceeds a preconfigured threshold, the Site changes its state and raises an alert. Alerts fall into two severity levels:

• Warning: Raised when a metric crosses the warning threshold but has not reached the error threshold.

• Error: Raised when a metric crosses the critical error threshold.

Site alerts correspond to their component category. For example, high CPU usage generates a Server alert, while a disconnected drive generates a Storage alert.

Retrieve Health Monitoring metrics with the Server API

To make Health Monitoring API calls, your user account must belong to one of the following user groups:

• Cloud Administrators

• Administrators

• Owners (Cloud and local)

You can query Site metrics and active alarms directly through the REST API.

1. Open your browser and navigate to the built-in API documentation tool: https://localhost:7001/#/api-tool/metrics-1

2. Send GET requests to any of the following endpoints to retrieve health data:

   • GET /rest/v4/metrics/manifest: Retrieves the current manifest definition for metric values and alarms.

   • GET /rest/v4/metrics/values: Retrieves the current state and values of all system metrics.

   • GET /rest/v4/metrics/rules: Retrieves the threshold rules used to calculate manifest outputs and trigger alarms.

   • GET /rest/v4/metrics/alarms: Retrieves all currently active metric alarms and errors.