KB-2283 How to run the Sizing Script

Purpose

Appian Technical Support may request a report generated by the Sizing Script to investigate issues with the Process Execution engines. This guide provides steps to enable users to generate reports with meaningful data.

Instructions

1. Identify port usage

Windows

Open up command prompt (cmd.exe) with the appropriate privileges for your Appian installation.
Navigate to the logs directory:
cd <APPIAN_HOME>/logs
Run the following command to identify the port used by each execution engine gateway:
findstr /I /c:"opened gateway" service_manager.log | findstr "execution"
1. Note: The numbers shown in the bottom lines of the output of the command correspond to the engine gateways (the number of lines varies based on the number of execution engines in your environment)
Add 1 to each port number to identify the port used by each process execution engine database

Linux

Run the following command from a Linux terminal:
ps aux | grep "/[a]db pe" | awk '{printf("%-1s %-1s\n","Execution Engine: "$22," | Port: "$16) }'
Analyze the output for the corresponding engine-port pairs.

2. Run the Sizing Script

To run the Sizing Script, follow the steps in the Appian documentation. Below are three example use cases for generating a sizing report.

Generating a summary report for a single execution engine

This report provides an overview of the size of process data in a given execution engine. This is useful for quickly determining whether an engine is encountering problems due to excessive process sizing.

<APPIAN_HOME>/server/_scripts/tools/sizing.sh(.bat) summary -path "<Path to report>" -host <Engine hostname from appian-topology.xml> -port <Port from Step 1>

Generating a process model breakdown

This report summarizes the size of each process model in a given execution engine. This is useful for determining specific process models that are causing engine contention.

<APPIAN_HOME>/server/_scripts/tools/sizing.sh(.bat) processmodel -all -path "<Path to report>" -host <Engine hostname from appian-topology.xml> -port <Port from Step 1>

Generating a process size summary for instances of a given process model

This report is useful for isolating excessively large process instances after identifying process models of concern with the processmodel report.

<APPIAN_HOME>/server/_scripts/tools/sizing.sh(.bat) process -path "<Path to report>" -host <Engine hostname from appian-topology.xml> -port <Port from Step 1> -uuid <UUID(s) of large process model(s)>

Points to consider

When the Sizing Script is run on a port belonging to a non-execution engine, the generated report will be an empty CSV file. It will not throw any errors.
When the script is run on the port corresponding to an engine gateway instead of the engine itself, it will throw the following message:
```
An error occurred:
close
Run "sizing.sh help" to view help file.
```

Affected Versions

This article applies to all versions of Appian.

Last Reviewed: December 2023