Check ArcGIS Data Pipelines Server diagnostics

This topic is not relevant for ArcGIS Data Pipelines on Windows.

ArcGIS Data Pipelines 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 lists possible causes and solutions to any problems. This tool is available for Linux only.

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 again to help you identify and diagnose problems.

Run the diagnostics tool

Run the diagnostics tool from the command line on the machine hosting ArcGIS Data Pipelines Server as follows:

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

   Note:

   For the tool to execute, the installation owner must have read and write permissions to the /tmp directory on the machine hosting ArcGIS Data Pipelines Server.

2. Browse to the <ArcGIS Data Pipelines Server installation directory>/tools/datapipelinesserverdiag directory.

3. Run datapipelinesserverdiag.

Interpret diagnostic results

After running the tool, a report is generated that contains a summary of all the server diagnostic checks performed. It also indicates whether the checks display a warning and whether 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 diagnostic check, see the table below. You can use this information to analyze the current state of the machine hosting ArcGIS Data Pipelines Server.

Column1	Column2	Column3
DIAG000	Check for installation as root	Running ArcGIS Data Pipelines Server as root is a security risk and is not supported. This check returns a failure if ArcGIS Data Pipelines Server is detected to be installed as root.
DIAG001	Check for 64-bit architecture	ArcGIS Data Pipelines Server is supported on 64-bit architecture only. If the machine is 32-bit, 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 host name for invalid characters	Valid characters for the host name of the ArcGIS Data Pipelines 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.
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 Data Pipelines Server site.
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 Data Pipelines 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 Data Pipelines 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 Data Pipelines Server uses port 14443 for HTTPS. This check determines whether these ports are in use by another user or process. If this check returns a warning, ArcGIS Data Pipelines Server will not run properly. To correct this issue, ensure port 14443 is available and restart ArcGIS Data Pipelines 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 Data Pipelines Server to function improperly. To correct this issue, fix the host name entry and restart ArcGIS Data Pipelines Server.
DIAG026	Check processes for ArcGIS Data Pipelines Server core services	The check verifies that all the core services are started after ArcGIS Data Pipelines Server is started. It returns a warning if one or more core services do not start. To correct this issue, start ArcGIS Data Pipelines Server by running the startdatapipelinesserver.sh script, or restart ArcGIS Data Pipelines Server if it is already running.