Introduction
In many VPS environments, it is often the case that you will have a number of small programs that you want to run persistently, whether these are small shell scripts, Node.js apps, or any large-sized packages.
Usually, external packages are supplied with a unit file that allows them to be managed by an init system such as systemd, or packaged as docker images which can be managed by a container engine. However, for software that isn’t well-packaged, or for users who would prefer not to interact with a low-level init system on their server, it is helpful to have a lightweight alternative.
Supervisor is a process manager which provides a singular interface for managing and monitoring a number of long-running programs. In this tutorial, you will install Supervisor on a Linux server and learn how to manage Supervisor configurations for multiple applications.
Prerequisites
To complete this guide, you will need:
An Linux server and a non-root user with sudo privileges. You can learn more about how to set up a user with these privileges in our Initial Server Setup with Ubuntu 20.04 guide.
Step 1 – Installation
Begin by updating your package sources and installing Supervisor:
sudo apt update && sudo apt install supervisor
The supervisor service runs automatically after installation. You can check its status:
sudo systemctl status supervisor
You should receive the following output:
● supervisor.service - Supervisor process control system for UNIX
Loaded: loaded (/lib/systemd/system/supervisor.service; enabled; vendor preset: enabled)
Active: active (running) since Wed 2021-11-17 22:56:48 UTC; 5min ago
Now that we have Supervisor installed, we can look at adding our first programs.
Step 2 – Adding a Program
A best practice for working with Supervisor is to write a configuration file for every program it will handle.
All programs run under Supervisor must be run in a non-daemonising mode (sometimes also called ‘foreground mode’). If, by default, your program automatically returns to the shell after running, then you may need to consult the program’s manual to find the option to enable this mode, or Supervisor will not be able to properly determine the status of the program.
In order to demonstrate Supervisor’s functionality, we’ll create a shell script that does nothing other than produce some predictable output once a second, but will run continuously in the background until it is manually stopped. Using nano or your favorite text editor, open a file called idle.sh in your home directory:
nano ~/idle.sh
Add the following contents:
~/idle.sh
#!/bin/bash
while true
do
# Echo current date to stdout
echo `date`
# Echo 'error!' to stderr
echo 'error!' >&2
sleep 1
done
Save and close the file. If you are using nano, press Ctrl+X, then when prompted, Y and Enter.
Next, make your script executable:
chmod +x ~/idle.sh
The per-program configuration files for Supervisor programs are located in the /etc/supervisor/conf.d directory, typically running one program per file and ending in .conf. We’ll create a configuration file for this script, as`/etc/supervisor/conf.d/idle.conf:
sudo nano /etc/supervisor/conf.d/idle.conf
Add these contents:
/etc/supervisor/conf.d/idle.conf
command=/home/ubuntu/idle.sh
autostart=true
autorestart=true
stderr_logfile=/var/log/idle.err.log
stdout_logfile=/var/log/idle.out.log
We’ll review this line by line:
command=/home/ubuntu/idle.sh
The configuration begins by defining a program with the name idle and the full path to the program:
autostart=true
autorestart=true
The next two lines define the automatic behavior of the script under certain conditions.
The autostart option tells Supervisor that this program should be started when the system boots. Setting this to false will require a manual start following any system shutdown.
autorestart defines how Supervisor should manage the program in the event that it exits:
false tells Supervisor not to ever restart the program after it exits.
true tells Supervisor to always restart the program after it exits.
unexpected tells Supervisor to only restart the program if it exits with an unexpected error code (by default anything other than codes 0 or 2). To learn more about error codes, look into the errno command.
stderr_logfile=/var/log/idle.err.log
stdout_logfile=/var/log/idle.out.log
The final two lines define the locations of the two main log files for the program. As suggested by the option names, stdout and stderr will be directed to the stdout_logfile and stderr_logfile locations respectively. The specified directories must already exist, as Supervisor will not attempt to create any missing directories.
The configuration we have created here is a minimal template for a Supervisor program. The Supervisor documentation lists many more optional configuration options that are available to tune how programs are run.
Once our configuration file is created and saved, we can inform Supervisor of our new program through the supervisorctl command. First we tell Supervisor to look for any new or changed program configurations in the /etc/supervisor/conf.d directory with:
sudo supervisorctl reread
idle: available
Followed by telling it to enact any changes with:
sudo supervisorctl update
idle: added process group
Any time you make a change to any program configuration file, running the two previous commands will bring the changes into effect.
At this point our program should now be running. We can check its output by looking at the output log file:
sudo tail /var/log/idle.out.log
Sat Nov 20 22:21:22 UTC 2021
Sat Nov 20 22:21:23 UTC 2021
Sat Nov 20 22:21:24 UTC 2021
Sat Nov 20 22:21:25 UTC 2021
Sat Nov 20 22:21:26 UTC 2021
Sat Nov 20 22:21:27 UTC 2021
Sat Nov 20 22:21:28 UTC 2021
Sat Nov 20 22:21:29 UTC 2021
Sat Nov 20 22:21:30 UTC 2021
Sat Nov 20 22:21:31 UTC 2021
Next, we’ll cover some other usage of Supervisor.
Step 3 – Managing Programs
Beyond running programs, you will want to stop, restart, or see their status. The supervisorctl program, which we used in Step 2, also has an interactive mode which we can use to control our programs.
To enter the interactive mode, run supervisorctl with no arguments:
sudo supervisorctl
idle RUNNING pid 12614, uptime 1:49:37
supervisor>
supervisorctl will initially print the status and uptime of all configured programs, followed by its command prompt. Entering help will reveal all of its available commands:
supervisor> help
default commands (type help <topic>):
=====================================
add clear fg open quit remove restart start stop update
avail exit maintail pid reload reread shutdown status tail version
You can start or stop a program with the associated commands followed by the program name:
supervisor> stop idle
idle: stopped
supervisor> start idle
idle: started
Using the tail command, you can view the most recent entries in the stdout and stderr logs for your program:
supervisor> tail idle
Sun Nov 21 00:36:10 UTC 2021
Sun Nov 21 00:36:11 UTC 2021
Sun Nov 21 00:36:12 UTC 2021
Sun Nov 21 00:36:13 UTC 2021
Sun Nov 21 00:36:14 UTC 2021
Sun Nov 21 00:36:15 UTC 2021
Sun Nov 21 00:36:17 UTC 2021
supervisor> tail idle stderr
error!
error!
error!
error!
error!
error!
error!
Using status you can view again the current execution state of each program after making any changes:
supervisor> status
idle STOPPED Nov 21 01:07 AM
Finally, you can exit supervisorctl with Ctrl+C or by entering quit into the prompt:
supervisor> quit
Conclusion
In this tutorial, you learned how to install and manage Supervisor. As mentioned, Supervisor is very lightweight by modern standards, but it continues to be well-maintained, and it can be a useful tool for smaller deployments. It is also a low-maintenance and self-contained way of generating logs as a component part of a larger deployment.
If you’re running multiple small apps that need to be web accessible, you may also want to read about configuring Nginx as a reverse proxy, which is another fundamental component of small, reusable deployments.
