KB-1655 How to extract engine infrastructure logs from Linux environments

Purpose

In order to assist with troubleshooting issues, Appian support cases may require the collection of certain log files from a specific Appian environment. This article provides instructions on how to extract these logs on Linux environments. 

Instructions

18.3 and Later

Run the log collection script to auto-generate the required .tar file.

18.2 and Earlier

Run the following command from the <APPIAN_HOME>/logs/ directory in order to generate the required .tar file. This command will create a set of logs in the /tmp/ directory and then create the .tar file.

Note: This is a multi-line command.

tarname=$(hostname -s)-slim-$(date +"%Y-%m-%d"); \
find . \( \
-name engine_status.csv \
-o -name "*_summary.csv*" \
-o -name "service_manager*" \
-o -name "zookeeper*" \
-o -name “server.log” \
-o -name "product_metrics*" \) | tar -cvf /tmp/${tarname}.tar --hard-dereference --files-from -; \
find ./data-metrics/ | tar -rvf /tmp/${tarname}.tar --hard-dereference --files-from -; \
find ./service-manager/metrics/jvm | tar -rvf /tmp/${tarname}.tar --hard-dereference --files-from -; \
find ./service-manager/kafka | tar -rvf /tmp/${tarname}.tar --hard-dereference --files-from -; \
gzip -f /tmp/${tarname}.tar

After running the command, upload the .tar file to the support case as requested by Appian Support. These logs do not contain any personally identifiable information (PII).

Affected Versions

This article applies to all versions of Appian running 17.3 or later using Linux as the operating system.

Last Reviewed: April 2020