KB-2251 How to use the Appian Diagnostics script

Purpose

Appian is composed of six different components. For the expected functioning of Appian, it is vital that all Appian components are in a healthy state. The health of each component can be checked via separate out-of-the-box scripts which can be cumbersome. Instead, this article explains how to run the Appian Diagnostics script, which is a quick and efficient way to gather key health metrics of the Appian environment and the server hosting Appian.

What is the Appian Diagnostics script?

The Appian Diagnostics script combines the different diagnostic scripts into a single script so that the state of each component in the environment can be understood by running one single script. In addition to the health of the Appian components the script also provides system level details like the RAM, CPU and disk usage of the server used to host Appian.

Note that this script does not interact with log files or retrieves any information that could be deemed sensitive in nature. The script only leverages the existing out-of-the-box diagnostic scripts and prints the output to a new log file. The script only gathers the details of the Appian components which are hosted on the server that the script is run on.

Instructions

Run the following steps to execute the script:

1. Download the script to the server which hosts Appian.
2. Make the appian_health_diagnostics.sh script executable.
   1. chmod +x appian_health_diagnostics.sh
3. Run the following command: appian_health_diagnostics.sh -d *APPIAN_HOME* -p *SERVICE_MANAGER_PASSWORD*
   1. eg: ./appian_health_diagnostics.sh -d /usr/local/appian/ae -p password
4. The script will generate the diagnostic file in the APPIAN_HOME/logs directory.
5. Attach the newly created diagnostic file to the support case.

Affected Versions

This article applies to Appian 17.3 and later.

Last Reviewed: June 2023