KB-2329 How to use the Appian Support Logs Collector Script

The Appian Logs Collector Script is a quick and efficient way to collect data required for a investigation. To use the tool, please follow these steps.

Table of Contents:

• Instructions
• Video Instructions
• Further Considerations

Instructions

1. Download the script package on the server which hosts the Appian installation 
   1. Guide on how to use the tool: README.md
   2. The tool itself: appian_support_logs_collector.py
2. Run the command below, modifying the placeholders "<placeholder>" according to your environment requirements:
   

   python appian_support_logs_collector.py --appian_home <APPIAN_HOME> --days 7 --output_dir </path/to/where/to/save/result>

3. Upload the resulting .tar files from all servers on the case.

Video Instructions

Further Considerations

• The tool requires Python 3.6 or greater. 
• The tool should be run individually on each server that the logs should be fetched from.
• If the application server logs do not use the standard naming convention (tomcat-stdOut, tomcat-access), please add --include_files <custom_named_stdout.log>,<custom_named_access.log> as an argument to the tool so these are also collected. 
• For any questions or doubts on the usage of the tool access the tool help menu by providing '-h' as in: python appian_support_logs_collector.py -h
• Please review the guide provided along with the package downloaded: README.md
• For anything else, feel free to raise questions over the support case.
  
  

Disclaimer

IMPORTANT: Please read this disclaimer carefully before using the tool provided by Appian Support.

• This tool runs a Python script to collect Appian platform logs to assist in investigating issues for our customers. The tool only includes standard Python libraries tailored to collect logs for your specific installation of the Appian software. The tool does not delete or move files from your system, it creates copies and compresses them for ease of sharability with Appian Support through MyAppian Support Cases.
• Using this tool is entirely at your own risk, and Appian shall not be held responsible for any damage, data loss, or other adverse consequences that may result from usage. This tool is offered “as is” without any warranties, either express or implied. Appian does not make any representations or warranties regarding the accuracy, reliability, or suitability of this tool for any particular purpose.
• By using this tool, you acknowledge that you have read and understood the terms and conditions outlined above.

Affected Versions

This article applies to all versions of Appian.

Last Reviewed: January 2025