Monitor Subsystems
Appsmith uses Supervisor to manage and monitor key subsystems, including the Appsmith server, Caddy, and MongoDB. If a subsystem becomes unresponsive, Supervisor attempts to restart it automatically. If the Health Check API fails, you can use Supervisor to diagnose and manage subsystems.
You can monitor and manage processes using either the Web Interface or the Command Line Interface (CLI).
- Web Interface
- Command Line Interface
The Supervisor Web Interface provides an easy-to-use, graphical way to monitor and manage Appsmith processes. Follow the steps below to configure and access the web interface.
- Go to the
docker.env
file located in thestacks/configuration
folder. - Add the following environment variables to set the Supervisor credentials:
APPSMITH_SUPERVISOR_USER=<SUPERVISOR-USER>
APPSMITH_SUPERVISOR_PASSWORD=<SUPERVISOR-PASSWORD>
If these variables are not set, you must create a new Supervisor user by manually defining a username and password in the docker.env file. Supervisor uses these credentials for authentication when accessing the web interface.
-
Save the file and restart your Appsmith instance for the changes to take effect.
-
You can access the Supervisor web interface at
http://[your-domain]/supervisor
. For example, if your Appsmith instance is available athttp://localhost
, the Supervisor web interface can be accessed athttp://localhost/supervisor
.All managed processes listed in the web interface
The Supervisor Command Line Interface (CLI) provides a way to interact with and manage processes directly from the terminal. Follow the steps below to monitor the processes using the CLI.
- To check the status of all running processes, use the following command:
docker-compose exec appsmith supervisorctl status
This lists all managed processes along with their current state (e.g., RUNNING
, STOPPED
, FATAL
).
- To view the last few lines of the
stderr
output of a specific process, use:
docker-compose exec appsmith supervisorctl tail <process_name> stderr
Replace <process_name>
with the name of the process you want to check. You can get the process name from the supervisorctl
status command output.
For a complete list of supervisorctl
commands, refer to the Supervisor official documentation.
Troubleshooting
If resource usage exceeds defined thresholds or you face deployment issues, capture relevant monitoring screenshots. Refer to the troubleshooting guide for common errors. If the issue persists, contact Appsmith Support using the chat widget at the bottom right and provide the screenshots for further diagnostics.