Parent page: Altium NEXUS Server
The Altium NEXUS Server includes a comprehensive server health monitoring system that allows Administrators to quickly ascertain and analyze the condition, or ‘health’ of a NEXUS Server. The health monitor is available from the Admin section of the server browser interface (the Server Health page), or as a standalone executable tool that is included in the NEXUS Server installation on its host PC (the Server Health Monitor tool).
The server health feature delivers a visual summary of the state the NEXUS Server's configuration and services, information on the host machine's system resources, and also provides access to server status reports and log files. This provides an immediate overview of the server's status, which allows administrators to preemptively detect and resolve any issues that may affect NEXUS Server users.
Each approach to monitoring the server's health and status has its own distinct advantage:
avhealth.exe) is accessible regardless of the state of the server, and will therefore provide crucial data and information in the unlikely event that the server is not fully functioning.
Within the NEXUS Server's browser interface, select Admin » Health in the main menu to access the Server Health reporter page, which will indicate the overall status of the server installation at the time stamp reference shown in the top Status section of the page (
Updated at: <timestamp>).
The Server Health page information is periodically updated (as indicated by the Status time stamp), but an update may be triggered on demand with the associated refresh status link.
As a highlighted overview of the server status, the Server Health page provides distinct warning/error icons and associated descriptions for status entries of concern. Common alerts include overdue data backups, pending license expiries, an active admin/admin user account or detected error entries in a log file:
While any Performance and System issues are likely to be addressed by improving the server host PC's available resources and infrastructure, problems in the Environment and configuration section of the Server Health page can generally be resolved using the features and tools available to server administrators:
LogLevel=entry in the General section of the
LocalVault.inifile, located in the server's installation folder on the host PC.
avbackup.exetool, available in the
Tools\BackupToolfolder within the server installation on the host PC.
The performance of both the server and host PC are tested and summarized (in the Performance and System sections), and report logs made available for generation and download:
The Altium NEXUS Server installation includes the comprehensive NEXUS Server Health Monitor tool that allows Administrators to quickly ascertain and analyze the condition, or ‘health’ of the NEXUS Server at a local level. Provided as a stand-alone, independent application with the server's installation, the Health Monitor delivers a visual summary of the state of the host machine, and the NEXUS Server's configuration and Services. Its interface also includes context related hints, plus information and paths to important locations and log files.
The Health Monitor presents NEXUS Server status information via a simple GUI, and in general terms, covers the following critical areas:
In a default installation of the Altium NEXUS Server, the Health Monitor tool can be found in the
\Program Files (x86)\Altium\
Altium NEXUS Server\Tools\HealthMonitor folder as the
avhealth.exe executable. Note that the folder also includes a simplified command-line tool:
When the GUI Health Monitor tool (
avhealth.exe) is run, the program immediately interrogates the NEXUS Server and its hosting systems to populate the main Health Monitor Dashboard screen – as selected (by default) in the upper tabs. Click the Refresh button () to retrigger the process and update the screen.
The status of each item in the Dashboard is indicated by a message and associated icon:
Hover the mouse over an item’s status for more information. For an Error or Warning that is shown in the Dashboard, further details are (in most cases) available by clicking the status entry for that item. The following image demonstrates a failure of the server's NIS service, while all other services are OK.
Many of the Error/Warning conditions detected by the NEXUS Server Health Monitor offer links intended to help resolve the situation. These are included in the item’s detailed information, available when clicking on its status entry.
In the above example screen on the left, the Health Monitor has detected that the NEXUS Server has not been backed up. The associated information provides a link to documentation that will help to resolve the situation.
The example screen on the right (above) indicates that the server's default
admin/admin sign in credentials still exist, which poses a significant security risk. The Fix It link in the associated information directly accesses the server's sign-in page through the browser interface, where the Administrator User profiles can be corrected.
The Health Monitor’s Log Browser screen, accessed by the Log Browser tab, presents Error and Warning entries from all of the server’s available Log files – normally located in the
C:\ProgramData\Altium\NEXUSServerData\logs folder. To view the log file that contains the event entry, select the associated Open file link or simply double-click on the entry itself.
The cumulative event entries in the list are sectioned by date and will include all available Error/Warning events that are available from all log files. To find specific events, choose a time period from the Show logs drop down menu, and/or use the dynamic filter field () to search for key words within the Subsystem and Message columns.
Select the button to remove the accumulated log entries from the Log Browser list – this will archive then delete all existing log files.
The Health Monitor’s Status Report screen, accessed by the Status Report tab, is used to create and display NEXUS Server status report files. The generated reports collate all the event debug information in a single Zip archive (
*.zip) that can be sent, when necessary, to Altium Developers.
To create a report, select an appropriate event time period from the Include Logs drop down menu, enter your contact details and select the sharing agreement, and then initiate the process with the button.