This document will guide you on how to get the logs Appsmith on self-hosted deployments (such as Docker). These logs are frequently requested by members of the Appsmith Support team to properly troubleshoot bugs.
A few words on logs and privacy:
- Appsmith's logs usually don't contain information that should be considered "risky" to share. But if you want/are required to remove any PII, please refer to the section bellow called "Procedure: Removing PII from logs".
- It is best to share your logs directly to the Appsmith Support Team via the official support channels.
Look for the folder from where you deployed Appsmith. On this example we will assume that Appsmith was deployed using the official docker-compose.yaml and that file is located on a folder called Appsmith on the Desktop.
Locate the stacks folder.
Go to the logs folder.
In this case move to the backend folder.
There you will find one or many .log files. If you want to remove any PII from the logs follow the section below called Procedure: Removing PII from log files. If that's not a concer please bundle those files on a .zip file and share it with the Appsmith Team.
- Copy the below Python file to a folder maskdata.
- Install the dependencies.
pip install scrubadub- Execute the script with the command.
python3 -u maskemail.py-
The script requested the name of the file, type the name with the file extension and the program will replace the sensitive data.
-
This script was built from the following library.
Note: The script and log file must be in the same folder.
scrubadub currently supports removing:
- Names
- Email addresses
- Addresses/Postal codes (US, GB, CA)
- Credit card numbers
- Dates of birth
- URLs
- Phone numbers
- Username and password combinations
- Skype/twitter usernames
- Social security numbers (US and GB national insurance numbers)
- Tax numbers (GB)
- Driving licence numbers (GB)