Check ArcGIS Notebook Server diagnostics

This topic is not relevant to Windows deployments.

This topic is not relevant to Linux deployments.

ArcGIS Notebook Server includes a diagnostics tool you can use to confirm that your machine meets the minimum system requirements and the software is working as expected. If any issues are encountered when running the tool, it will list a possible cause and solution to the problem.

When you start the software installation, the tool runs automatically to confirm that your machine meets the minimum system requirements. Address any issues noted by the tool before proceeding with the installation. If you experience issues after installation, run the tool to help you identify and diagnose problems.

Run the tool

You'll run the diagnostics tool from the command line on the machine hosting ArcGIS Notebook Server.

1. Open a terminal as the user who owns the ArcGIS Notebook Server installation directory.

   Note:

   For the tool to run, the installation owner needs at least read and write permissions to the /tmp directory on the machine hosting ArcGIS Notebook Server.

2. Browse to the directory at <ArcGIS Notebook Server installation directory>/arcgis/notebookserver/tools/.

3. Run notebookserverdiag.

Interpret diagnostics results

After running the tool, a report is generated that contains a summary of all the server diagnostic checks performed. It also indicates if the checks display a warning, or if they passed, failed, or are not applicable to the system.

Each check is identified with a code formatted DIAG<number> followed by the status of the check performed. For an explanation of each diagnostics check, see the table below. You can use this information to analyze the current state of the machine hosting ArcGIS Notebook Server.

Check number	Check title	Description
DIAG000	Check for installation as root	Running ArcGIS Notebook Server as root is a security risk and is not supported. This check returns a failure if ArcGIS Notebook Server is detected to be installed as root.
DIAG001	Check for 64-bit architecture	ArcGIS Notebook Server is supported on 64-bit architecture only. If the machine is 32-bit architecture, this check fails. Consult the system requirements for supported operating systems.
DIAG002	Check OS version	A warning appears if the operating system is not a supported Linux distribution or version. Consult the system requirements for supported Linux platforms and OS versions. If the operating system is not a supported Linux distribution, the other checks will not be performed.
DIAG003	Check hostname for invalid characters	Valid characters for the host name of the ArcGIS Notebook Server machine include alphanumeric a–z, 0–9, and minus (-) and dot (.) characters, as outlined in the RFC 952 specification. The check fails if the host name contains one or more invalid characters.
DIAG004	Check installed packages	Depending on the Linux distribution used, this check confirms that the required operating system packages are installed for the proper support of ArcGIS Notebook Server. It the check fails, it returns a warning with the missing packages needed for the machine. Consult the system requirements for details.
DIAG005	Check system limits	For ArcGIS Notebook Server to run properly, the minimum file handle limits for the installation user are required to be set to 65535 and the minimum number of processes limits set to 25059. This check confirms whether these limits are set properly in the /etc/security/limits.conf file. If the limits are set too low, this check fails. To verify, run the following: ulimit -Hn -Hu ulimit -Sn -Su
DIAG009	Check HTTPS port	ArcGIS Notebook Server uses port 11443 by default. This check verifies if the HTTPS port 11443 is in use by another user or process. If this check returns a warning, ArcGIS Notebook Server will not run properly. To correct this issue, open port 11443 and restart ArcGIS Notebook Server.
DIAG020	Check host name IP address mismatches	If the host name entry is present for the machine in the /etc/hosts file and it does not match the IP address of the machine, this check returns a warning. This will cause ArcGIS Notebook Server to function improperly. To correct this issue, fix the host name entry and restart ArcGIS Notebook Server.
DIAG024	Check /etc/hosts for host name entry	The host name entry for the machine in the /etc/hosts file must be formatted as <IP> <FQDN> <Machine_name>. Update the host name entry before creating your ArcGIS Notebook Server site.
DIAG026	Check processes for ArcGIS Notebook Server core services	The check verifies if all the core services are started after ArcGIS Notebook Server is started. It returns a warning if one or more core services are not started. To correct this issue, start ArcGIS Notebook Server by running the startnotebookserver.sh script, or restart ArcGIS Notebook Server if it is already running.
DIAG028	Check for valid Docker install	The check verifies that the version of Docker installed on the machine meets the ArcGIS Notebook Server system requirements. It also verifies if the ArcGIS Notebook Server install user account is added to the Docker group to run Docker commands. If this check fails, make sure that the supported version of Docker is installed on the machine and the ArcGIS Notebook Server install user account is added to the Docker group before configuring your ArcGIS Notebook Server site.
DIAG029 (introduced at 10.7.1)	Check disk space for /var	This check verifies that the /var directory on your machine has at least 50 GB of disk space. Docker uses the /var directory as its local registry for container images. During the upgrade process for subsequent releases, new images will be copied to the /var directory as well. The requirement for at least 50 GB of available disk space ensures these operations will run smoothly. To change the default directory Docker uses to store container images, refer to this workflow in the install guide.