AppCheck private scan hubs' local web GUIs contain a Maintenance page which can be used to investigate and diagnose issues affect the hub.
Before accessing these tools it is crucial to ensure that the hub has the necessary network access as detailed in Section 5 of the Private Scan Hub Setup Guide.
How To Access The Maintenance Tools
Navigate to the private hub's GUI (https://[hub's IP address]:8080) and on the left pane choose the "Maintenance" option:
Alternatively, you can navigate to it by adding "/maintenance/tools/" to the hub's GUI URL.
When To Use Each Tool And What Each One Does
You will usually only need to access each tool when asked to do so by AppCheck Support to help us diagnose an issues on your hub (since the hubs reside in your infrastructure AppCheck do not have direct access themselves). For your reference a description of what each tool does is below.
Salt is the service responsible for communicating with AppCheck's update management servers. Problems with Salt can result in hubs not receiving updates, or even updates failing and leaving the hub in an unusable state.
Restart Salt Minion
This restarts the local salt service. This does not return any output if successful, but
0 return code indicates success. It's a cliche, but restarting a service is an important part of troubleshooting problems.
Enable Salt Minion
Starts the local salt service if for some reason it has not already started.
Read Salt Logs
Outputs the most recent 1000 lines of the local salt logs. While there's a chance these will contain something meaningful for the end user (such as an error indicating your firewall is blocking requests) the most likely reason you would access these is to send them over to AppCheck Support when asked.
Update this hub
Instructs Salt to check for and install updates.
Read logs of the last update attempt
Similar to Read Salt Logs but finds logs specific to the last request to update the hub. Again the most likely scenario would be AppCheck Support asking for a copy of these.
Components of the scan hub are within Docker containers. These tools help confirm the state and version of those containers.
Show Present Docker Images
This will list all the current docker images on the hub.
Show Running Docker Containers
This will allow you to see the current running Docker containers.
Show Logs For A Docker Container
Shows the last 1000 lines from the logs from a running container, selectable from a drop down list of running containers. The list of containers is refreshed on reload. AppCheck Support may need logs for a specific container to help diagnose an issue on your hub.
These tools are used to test connections to AppCheck services.
Test service names resolve correctly
Tests name resolution for the necessary AppCheck services. There may not be obvious failures in the resolution but it may help AppCheck Support locate the root of an issue.
Test Connection To Salt-master
Checks the connection to AppCheck's salt servers (see section on Sale above). This returns positive if the salt minion on the VM can talk to AppCheck's Salt Master service.
Note: This isn't just checking that a port is visible. It checks that the salt services have a connection.
Show Stats On Hub Resources
An output of various resource check commands for storage, memory and processes.