Supervisor - QLGQ/learning-python GitHub Wiki

Introduction

Supervisor是一个用Python写的进程管理工具，可以很方便的用来启动、重启、关闭进程（不仅仅是Python进程）。除了对单个进程的控制，还可以同时启动、关闭多个进程。

Installtion

Supervisor是Python编写的，所以安装起来也很方便：

• ubuntu系统：sudo apt-get install supervisor
• pip安装：sudo pip install supervisor
• 源码安装：
  • 从官网下载安装包(https://pypi.python.org/packages/7b/17/88adf8cb25f80e2bc0d18e094fcd7ab300632ea00b601cbbbb84c2419eae/supervisor-3.3.2.tar.gz)
  • tar zxf supervisor-3.3.2.tar.gz
  • cd supervisor
  • python setup.py install

检验是否安装成功，可以登录Python控制台输入import supervisor查看是否能成功加载。

Configuration

安装完成之后，可以编写配置文件，来满足自己的需求。为了方便，我们把配置分成两部分：supervisord（supervisor是一个C/S模型的程序，这个是server端，对应的还有client端：supervisorctl）和应用程序（即我们要管理的程序）。

supervisord

首先来看supervisord的配置文件。安装完supervisor之后，可以运行echo_supervisord_conf命令输出默认的配置项，也可以重定向到一个配置文件里：ehco_supervisord_conf > /etc/supervisord.conf（enoc-web项目中重定向到了/etc/supervisor/supervisord.conf中）

我们把上面这部分配置保存到/etc/supervisord.conf（或者其他任意有权限访问的文件），然后启动supervisord（通过-c选项指定配置文件路径，如果不指定会按照这个顺序查找配置文件：$CWD/supervisord.conf，$CWD/etc/supervisord.conf，$/etc/supervisord.conf）：supervisord -c /etc/supervisord.conf

program

上面我们已经把supervisord运行起来了，现在可以添加我们要管理的进程的配置文件。可以把所有配置项都写到supervisord.conf文件里，但并不推荐这样做，而是通过include的方式把不同的程序（组）写到不同的配置文件里。

为了举例，我们新建一个目录/etc/supervisor/用于存放这些配置文件，相应的，把/etc/supervisord.conf里include部分的配置修改一下：files = /etc/supervisor/*.conf

假设有个用Python和Flask框架编写的用户中心系统，取名usercenter，用gunicorn (http://gunicorn.org/) 做web服务器。项目代码位于/home/leon/projects/usercenter，gunicorn配置文件为gunicorn.py，WSGI callable是wsgi.py里的appshuxing。所以直接在命令行启动的方式可能是这样的：cd /home/leon/projects/usercenter，gunicorn -c gunicorn.py wsgi:app。

现在编写一份配置文件来管理这个进程（需要注意：用supervisord管理时，gunicorn的daemon选项需要设置为False）：

[program:usercenter]
directory = /home/leon/projects/usercenter ; 程序的启动目录
command = gunicorn -c gunicorn.py wsgi:app  ; 启动命令，可以看出与手动在命令行启动的命令是一样的
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 5        ; 启动 5 秒后没有异常退出，就当作已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数，默认是 3
user = leon          ; 用哪个用户启动
redirect_stderr = true  ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 20     ; stdout 日志文件备份数
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile = /data/logs/usercenter_stdout.log
 
; 可以通过 environment 来添加需要的环境变量，一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

一份配置文件至少需要一个[program:x]部分的配置，来告诉supervisord需要管理那个进程。[program:x]语法中的x表示program name，会在客户端（supervisorctl或web界面）显示，在supervisorctl中通过这个值对程序进行start、restart、stop等操作。

Supervisorctl

Supervisorctl是supervisord的一个命令行客户端工具，启动时需要指定与supervisord使用一份配置文件，否则与supervisord一样按照顺序查找配置文件。
supervisorctl -c /etc/supervisord.conf

上面这个命令会进入supervisorctl的shell界面，然后可以执行不同的命令了：

> status    # 查看程序状态
> stop usercenter   # 关闭 usercenter 程序
> start usercenter  # 启动 usercenter 程序
> restart usercenter    # 重启 usercenter 程序
> reread    ＃ 读取有更新（增加）的配置文件，不会启动新添加的程序
> update    ＃ 重启配置文件修改过的程序

上面这些命令都有相应的输出，除了进入supervisorctl的shell界面，也可以直接在bash终端运行：

$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update

Others

• 除了supervisorctl之外，还可以配置supervisord启动web管理界面，这个web后台使用Basic Auth的方式进行身份认证。
• 除了单个进程的控制，还可以配置group，进行分组管理。
• 经常查看日志文件，包括supervisord的日志和各个program的日志文件，程序crash或抛出异常的信息一般会输出到stderr，可以查看相应的日志文件来查找问题。

如果修改了/etc/supervisord.conf，需要执行supervisorctl reload来重新加载配置文件，否则不会生效。

若采用sudo apt-get install supervisor安装supervisor的话，另外一种启动supervisor的方式为：sudo /etc/init.d/supervisor start，再运行sudo supervisorctl status即可查看管理的进程的运行状态；停止supervisor的方式为：sudo /etc/init.d/supervisor stop。

FAQ

1. ERROR (abnormal termination)：
   解决方法： supervisorctl tail programname，查看programname的具体日志信息。得到Error: Another program is already listening on a port that one of our HTTP servers is configured to use. Shut this program down first before starting supervisord.。接着执行：sudo unlink /var/run/supervisor.sock or sudo unlink /tmp/supervisor.sock即可。
2. enoc-uwsgi FATAL Exited too quickly (process log may have details) or enoc-uwsgi BACKOFF Exited too quickly (process log may have details)：
   解决方法：supervisor监控的进程不断在执行，即使干掉还是会生成，可能是使用了两种不同的方法开启了supervisor这个服务，导致它没有完全关掉，可以通过命令ps -aux |grep python查看supervisor这个服务是否彻底关掉，彻底关掉supervisor这个服务即可解决该问题。

开启进程supervisor的方法有两种：sudo supervisord -c /etc/supervisord.conf or sudo /etc/init.d/supervisor start(sudo service supervisor start)。进入supeovisorctl的shell界面也有两种方法：sudo supervisorctl -c /etc/supervisord.conf or sudo service supervisor。但是这两种方法最好不要交叉用，因为有可能你会启动两次supervisor，导致关闭一个supervisor后，你以为关闭彻底，其实没有，supervisor监控的服务仍然会开启。

Reference

使用supervisor管理进程