Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm’s monitoring feature continuously collects performance metrics from your servers and displays them in a dashboard with historical charts. You can track CPU usage, memory consumption, system uptime, load averages, and running process counts without installing a separate monitoring stack.

​
What metrics are collected

CPU usage

Percentage of CPU time in use, sampled at each monitoring interval.

Memory usage

Percentage of physical memory in use.

Load average

System load averages (typically 1-minute, 5-minute, and 15-minute values).

Uptime

Time in seconds since the last reboot.

Process count

Total number of running processes on the system.
Each data point is stored as a monitoring_data record with a timestamp, so Nexterm can render historical charts in addition to a live status view.

​
How monitoring works

Nexterm uses an SSH-based, agentless approach for regular server entries. No software needs to be installed on your hosts. Nexterm connects to each SSH server on a scheduled interval, runs lightweight remote commands to gather metrics, and stores the results. For Proxmox integrations, monitoring data is collected via the Proxmox API rather than a direct SSH connection.
Monitoring is supported only for entries of type server with the SSH protocol, and for Proxmox integrations. RDP, VNC, and Telnet entries do not appear in the monitoring dashboard.

​
Enabling monitoring for a server

Edit the entry and enable the Monitoring toggle. This sets config.monitoringEnabled to true on the entry. Once enabled, the entry will appear in the monitoring dashboard on its next collection cycle. 
{
  "config": {
    "protocol": "ssh",
    "ip": "10.0.1.10",
    "port": 22,
    "monitoringEnabled": true
  }
}

​
Viewing the monitoring dashboard

Navigate to Monitoring in the main navigation. The dashboard lists all servers and Proxmox nodes for which you have access and monitoring is enabled. Each row shows:
  • Server name, IP address, and port
  • Current online/offline status
  • The latest recorded values for CPU, memory, uptime, load average, and process count
If no monitoring data has been collected yet, the row displays a "No monitoring data available" placeholder.

​
Detailed server view and time ranges

Click any server in the dashboard to open its detailed monitoring view. This view shows a historical chart of all metrics over a configurable time range.
The last 1 hour of data, sampled to up to 60 data points.
If the selected time window contains no data (for example, because the server was offline), Nexterm falls back to the 100 most recent data points regardless of age. The detailed view also shows a latest snapshot that merges the most recent monitoring_data row with any separately stored snapshot record to give you the freshest available reading.

​
Proxmox integration monitoring

If you have a Proxmox integration configured, the Proxmox host itself also appears in the monitoring dashboard alongside your regular SSH servers. To view Proxmox monitoring data:
  • Navigate to Monitoring and look for entries with type proxmox.
  • Click the entry to open the detailed view, which supports the same 1h / 6h / 24h time ranges.
  • The monitoring route for integrations is GET /monitoring/integration/{integrationId}.
The monitoringEnabled flag on the integration’s config controls whether a Proxmox host appears in the monitoring dashboard, just as it does for regular server entries.

​
Global monitoring settings (admin only)

Administrators can configure system-wide monitoring behavior from Settings → Monitoring. These settings apply to all servers and integrations.
The global monitoring settings endpoint (GET /monitoring/settings/global and PATCH /monitoring/settings/global) requires admin access. Non-admin users receive a 403 response.

​
Available settings

SettingDefaultRangeDescription
statusCheckerEnabledtruebooleanEnable or disable the background status checker that polls server reachability.
statusInterval3010–300 sHow often (in seconds) the status checker polls each server.
monitoringEnabledtruebooleanEnable or disable metric collection globally.
monitoringInterval6030–600 sHow often (in seconds) metrics are collected from each server.
dataRetentionHours241–24 hHow many hours of monitoring data to keep. Older records are purged automatically.
connectionTimeout305–120 sTimeout in seconds for monitoring SSH connections.
batchSize101–50Number of servers to collect metrics from concurrently in each polling cycle.

​
Updating monitoring settings

curl -X PATCH https://your-nexterm-instance/monitoring/settings/global \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "monitoringInterval": 120,
    "dataRetentionHours": 12,
    "batchSize": 20
  }'
Lowering dataRetentionHours reduces database size at the cost of shorter historical chart windows. The minimum retention period is 1 hour; the maximum is 24 hours.

Build docs developers (and LLMs) love

Get started for freeTalk to us