简介
Supervisor是一个C/S系统,允许用户控制类UNIX系统上的多个进程。Supervisord将进程作为其子进程启动,并且可以配置为在崩溃时自动重新启动它们。也可以将其自动配置为自行调用启动进程。通过简单易懂的INI样式配置文件配置Supervisor。它提供了许多选项,例如重启失败的进程和自动日志轮换。
安装方式
- pip install supervisor
- conda install supervisor
- ubuntu还可以使用apt-get
配置文件
supervisor配置文件通常命名为supervisor.conf。supervisord
和supervisorctl
都会用到这个配置文件。若supervisord
和supervisorctl
没有使用-c
参数指定配置文件。则这两个程序会按如下列出的顺序自上而下的在这些位置寻找名为supervisord.conf的配置文件。
- $CWD/supervisord.conf
- $CWD/etc/supervisord.conf
- /etc/supervisord.conf
- /etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
- ../etc/supervisord.conf (Relative to the executable)
- ../supervisord.conf (Relative to the executable)
Debian和Ubuntu版本的Supervisor都包含/etc/supervisor/supervisord.conf搜索路径。
执行echo_supervisord_conf > supervisord.conf
可生成完整配置文件,并含有详尽注释。示例配置如下所示:
01. [unix_http_server]
02. file=/tmp/supervisor.sock ; socket文件路径
03.
04. [supervisord]
05. logfile=/tmp/supervisord.log ; 主日志文件,默认位置:$CWD/supervisord.log
06. logfile_maxbytes=50MB ; 日志大小,超出后轮转,默认50MB
07. logfile_backups=10 ; 日志备份数量,0表示不备份,默认10
08. loglevel=info ; 日志记录级别,默认info,其他级别debug、warn、trace
09. pidfile=/tmp/supervisord.pid ; pid文件,默认supervisord.pid
10. nodaemon=false ; false表示后台运行,默认false
11. minfds=1024 ; 启动时最少可用文件描述符数,默认1024
12. minprocs=200 ; 最少可用进程描述符数,默认200
13.
14. [rpcinterface:supervisor]
15. supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
16.
17. [supervisorctl]
18. serverurl=unix:///tmp/supervisor.sock ; 使用unix:// URL格式指定socekt文件位置
19.
20. [program:demo]
21. command=/bin/cat ; 运行的程序,使用相对路径可使用参数
22. directory=/tmp ; 执行程序前进入的目录
23. autostart=true ; 是否随supervisor同时启动,默认true
24. startretries=3 ; 失败后重试次数,默认3
25. user=flask ; 启动程序用户的uid
26.
27. [include]
28. files = relative/directory/*.ini ; 其它配置文件路径
program配置
上面的示例中的配置文件已经包含program
配置。若需要配置很多program
,则应在[include]
中引用各程序的配置文件。下面是flask的配置示例:
1. [program:flask]
2. command=/home/flask/miniconda3/envs/flask/bin/uwsgi /home/flask/FlaskTest/uwsgi.ini
3. directory=/home/flask/FlaskTest
4. autostart=true
5. startretries=3
6. user=flask
运行supervisord
执行supervisord -c /path_to_conf_file/supervisord.conf
使用指定配置文件启动。
执行ps -elf | grep supervisor
检查是否启动
启动supervisor时,将在默认位置(包括当前工作目录)中搜索其配置文件。若注重安全性,则可能需要在supervisor命令之使用
-c
参数,该命令指定配置文件的绝对路径,以确保不会从含有恶意配置文件的目录中启动supervisor。当supervisor以root用户身份启动而没有使用此-c
参数时,将发出警告。
运行supervisorctl
supervisorctl将启动一个shell,该shell用来管理由supervisord运行的程序。supervisorctl启动时,需要使用-c
参数指定与supervisord同样的配置文件。否则使用supervisord同样的查找方式查找配置文件。supervisorctl无参数启动时,进入交互shell。若带有参数,例如supervisor -c /path_to_conf_file/supervisord.conf stop all
,则不会进入交互式界面了。
supervisorctl常用命令如下:
supervisor> update # 重载新增和修改的配置文件,并重启受影响的程序
supervisor> update all # 重载新增和修改的配置文件,并重启受影响的程序
supervisor> reload # 重启supervisord
supervisor> reread # 重新加载守护程序的配置文件,而无需添加/删除(不重新启动)
supervisor> restart <name> # 重启指定程序,该命令不会reread配置文件
supervisor> restart all # 重启所有程序,该命令不会reread配置文件
supervisor> start <name> # 启动指定程序
supervisor> start all # 启动所有程序
supervisor> status # 获得所有程序状态
supervisor> stop <name> # 停止指定程序
supervisor> stop all # 停止所有程序