使用 supervisor 管理进程

原文链接：http://blog.csdn.net/xyang81/article/details/51555473

Supervisor（http://supervisord.org/）是用Python开发的一个client/server服务，是Linux/Unix系统下的一个进程管理工具，不支持Windows系统。它可以很方便的监听、启动、停止、重启一个或多个进程。用Supervisor管理的进程，当一个进程意外被杀死，supervisort监听到进程死后，会自动将它重新拉起，很方便的做到进程自动恢复的功能，不再需要自己写shell脚本来控制。

因为Supervisor是Python开发的，安装前先检查一下系统否安装了Python2.4以上版本。下面以CentOS7，Python2.7版本环境下，介绍Supervisor的安装与配置步聚：

1、安装Python包管理工具（easy_install）

easy_install是setuptools包里带的一个命令，使用easy_install实际上是在调用setuptools来完成安装模块的工作,所以安装setuptools即可。

wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python

2、安装supervisor

easy_install supervisor

supervisor安装完成后会生成三个执行程序：supervisortd、supervisorctl、echo_supervisord_conf，分别是supervisor的守护进程服务（用于接收进程管理命令）、客户端（用于和守护进程通信，发送管理进程的指令）、生成初始配置文件程序。

3、配置

运行supervisord服务的时候，需要指定supervisor配置文件，如果没有显示指定，默认在以下目录查找：

  1. $CWD/supervisord.conf
  2. $CWD/etc/supervisord.conf
  3. /etc/supervisord.conf
  4. /etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
  5. ../etc/supervisord.conf (Relative to the executable)
  6. ../supervisord.conf (Relative to the executable)

$CWD表示运行supervisord程序的目录。

可以通过运行echo_supervisord_conf程序生成supervisor的初始化配置文件，如下所示：

  1. mkdir /etc/supervisor
  2. echo_supervisord_conf > /etc/supervisor/supervisord.conf

4、配置文件参数说明

supervisor的配置参数较多，下面介绍一下常用的参数配置，详细的配置及说明，请参考官方文档介绍。 
注：分号（;）开头的配置表示注释

  1. [unix_http_server]
  2. file=/tmp/supervisor.sock ;UNIX socket 文件，supervisorctl 会使用
  3. ;chmod=0700 ;socket文件的mode，默认是0700
  4. ;chown=nobody:nogroup ;socket文件的owner，格式：uid:gid
  5.  
  6. ;[inet_http_server] ;HTTP服务器，提供web管理界面
  7. ;port=127.0.0.1:9001 ;Web管理后台运行的IP和端口，如果开放到公网，需要注意安全性
  8. ;username=user ;登录管理后台的用户名
  9. ;password=123 ;登录管理后台的密码
  10.  
  11. [supervisord]
  12. logfile=/tmp/supervisord.log ;日志文件，默认是 $CWD/supervisord.log
  13. logfile_maxbytes=50MB ;日志文件大小，超出会rotate，默认 50MB，如果设成0，表示不限制大小
  14. logfile_backups=10 ;日志文件保留备份数量默认10，设为0表示不备份
  15. loglevel=info ;日志级别，默认info，其它: debug,warn,trace
  16. pidfile=/tmp/supervisord.pid ;pid 文件
  17. nodaemon=false ;是否在前台启动，默认是false，即以 daemon 的方式启动
  18. minfds=1024 ;可以打开的文件描述符的最小值，默认 1024
  19. minprocs=200 ;可以打开的进程数的最小值，默认 200
  20.  
  21. [supervisorctl]
  22. serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
  23. ;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
  24.  
  25. ; [program:xx]是被管理的进程配置参数，xx是进程的名称
  26. [program:xx]
  27. command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run ; 程序启动命令
  28. autostart=true ; 在supervisord启动的时候也自动启动
  29. startsecs=10 ; 启动10秒后没有异常退出，就表示进程正常启动了，默认为1秒
  30. autorestart=true ; 程序退出后自动重启,可选值：[unexpected,true,false]，默认为unexpected，表示进程意外杀死后才重启
  31. startretries=3 ; 启动失败自动重试次数，默认是3
  32. user=tomcat ; 用哪个用户启动进程，默认是root
  33. priority=999 ; 进程启动优先级，默认999，值小的优先启动
  34. redirect_stderr=true ; 把stderr重定向到stdout，默认false
  35. stdout_logfile_maxbytes=20MB ; stdout 日志文件大小，默认50MB
  36. stdout_logfile_backups = 20 ; stdout 日志文件备份数，默认是10
  37. ; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
  38. stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
  39. stopasgroup=false ;默认为false,进程被杀死时，是否向这个进程组发送stop信号，包括子进程
  40. killasgroup=false ;默认为false，向进程组发送kill信号，包括子进程
  41.  
  42. ;包含其它配置文件
  43. [include]
  44. files = relative/directory/*.ini ;可以指定一个或多个以.ini结束的配置文件

include示例：

  1. [include]
  2. files = /opt/absolute/filename.ini /opt/absolute/*.ini foo.conf config??.ini

5、配置管理进程

进程管理配置参数，不建议全都写在supervisord.conf文件中，应该每个进程写一个配置文件放在include指定的目录下包含进supervisord.conf文件中。 
1> 创建/etc/supervisor/config.d目录，用于存放进程管理的配置文件 
2> 修改/etc/supervisor/supervisord.conf中的include参数，将/etc/supervisor/conf.d目录添加到include中

  1. [include]
  2. files = /etc/supervisor/config.d/*.ini

supervisor配置文件目录结构

下面是配置Tomcat进程的一个例子：

  1. [program:tomcat]
  2. command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run
  3. stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
  4. autostart=true
  5. autorestart=true
  6. startsecs=5
  7. priority=1
  8. stopasgroup=true
  9. killasgroup=true

5、启动Supervisor服务

supervisord -c /etc/supervisor/supervisord.conf

6、控制进程

6.1 交互终端

supervisord启动成功后，可以通过supervisorctl客户端控制进程，启动、停止、重启。运行supervisorctl命令，不加参数，会进入supervisor客户端的交互终端，并会列出当前所管理的所有进程。 
supervisorctl

上图中的tomcat就是我们在配置文件中[program:tomcat]指定的名字。

输入help可以查看可以执行的命令列表，如果想看某个命令的作用，运行help 命令名称，如：help stop

  1. stop tomcat // 表示停止tomcat进程
  2. stop all // 表示停止所有进程
  3. // ...

6.2 bash终端

  1. supervisorctl status
  2. supervisorctl stop tomcat
  3. supervisorctl start tomcat
  4. supervisorctl restart tomcat
  5. supervisorctl reread
  6. supervisorctl update

6.3 Web管理界面

Supervisor Web管理界面 
出于安全考虑，默认配置是没有开启web管理界面，需要修改supervisord.conf配置文件打开http访权限，将下面的配置：

  1. ;[inet_http_server] ; inet (TCP) server disabled by default
  2. ;port=127.0.0.1:9001 ; (ip_address:port specifier, *:port for all iface)
  3. ;username=user ; (default is no username (open server))
  4. ;password=123 ; (default is no password (open server))

修改成：

  1. [inet_http_server] ; inet (TCP) server disabled by default
  2. port=0.0.0.0:9001 ; (ip_address:port specifier, *:port for all iface)
  3. username=user ; (default is no username (open server))
  4. password=123 ; (default is no password (open server))

port：绑定访问IP和端口，这里是绑定的是本地IP和9001端口 
username：登录管理后台的用户名 
password：登录管理后台的密码

7、开机启动Supervisor服务

7.1 配置systemctl服务

1> 进入/lib/systemd/system目录，并创建supervisor.service文件

  1. [Unit]
  2. Description=supervisor
  3. After=network.target
  4.  
  5. [Service]
  6. Type=forking
  7. ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
  8. ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown
  9. ExecReload=/usr/bin/supervisorctl $OPTIONS reload
  10. KillMode=process
  11. Restart=on-failure
  12. RestartSec=42s
  13.  
  14. [Install]
  15. WantedBy=multi-user.target

2> 设置开机启动

  1. systemctl enable supervisor.service
  2. systemctl daemon-reload

3、修改文件权限为766

chmod 766 supervisor.service

7.2 配置service类型服务

  1. #!/bin/bash
  2. #
  3. # supervisord This scripts turns supervisord on
  4. #
  5. # Author: Mike McGrath <mmcgrath@redhat.com> (based off yumupdatesd)
  6. #
  7. # chkconfig: - 95 04
  8. #
  9. # description: supervisor is a process control utility. It has a web based
  10. # xmlrpc interface as well as a few other nifty features.
  11. # processname: supervisord
  12. # config: /etc/supervisor/supervisord.conf
  13. # pidfile: /var/run/supervisord.pid
  14. #
  15.  
  16. # source function library
  17. . /etc/rc.d/init.d/functions
  18.  
  19. RETVAL=0
  20.  
  21. start() {
  22. echo -n $"Starting supervisord: "
  23. daemon "supervisord -c /etc/supervisor/supervisord.conf "
  24. RETVAL=$?
  25. echo
  26. [ $RETVAL -eq 0 ] && touch /var/lock/subsys/supervisord
  27. }
  28.  
  29. stop() {
  30. echo -n $"Stopping supervisord: "
  31. killproc supervisord
  32. echo
  33. [ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/supervisord
  34. }
  35.  
  36. restart() {
  37. stop
  38. start
  39. }
  40.  
  41. case "$1" in
  42. start)
  43. start
  44. ;;
  45. stop)
  46. stop
  47. ;;
  48. restart|force-reload|reload)
  49. restart
  50. ;;
  51. condrestart)
  52. [ -f /var/lock/subsys/supervisord ] && restart
  53. ;;
  54. status)
  55. status supervisord
  56. RETVAL=$?
  57. ;;
  58. *)
  59. echo $"Usage: $0 {start|stop|status|restart|reload|force-reload|condrestart}"
  60. exit 1
  61. esac
  62.  
  63. exit $RETVAL

将上述脚本内容保存到/etc/rc.d/init.d/supervisor文件中，修改文件权限为755，并设置开机启动

  1. chmod 755 /etc/rc.d/init.d/supervisor
  2. chkconfig supervisor on

注意：修改脚本中supervisor配置文件路径为你的supervisor的配置文件路径

其它Linux发行版开机启动脚本：https://github.com/Supervisor/initscripts

注意：

Supervisor只能管理非daemon的进程，也就是说Supervisor不能管理守护进程。否则提示Exited too quickly (process log may have details)异常。例子中的Tomcat默认是以守护进程启动的，所以我们改成了catalina.sh run，以前台进程的方式运行。

yum方式安装

  1. yum install epel-release
  2. yum install -y supervisor

supervisor没有发布在标准的CentOS源在，需要安装epel源。这种方式安装的可能不是最新版本，但比较方便，安装完成之后，配置文件会自动帮你生成。 
默认配置文件：/etc/supervisord.conf 
进程管理配置文件放到：/etc/supervisord.d/目录下即可

默认日志文件：/tmp/supervisord.log，可以查看进程的启动信息

 

 

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 

进程管理supervisor的简单说明

背景：

      项目中遇到有些脚本需要通过后台进程运行，保证不被异常中断，之前都是通过nohup、&、screen来实现，带着能否做一个start/stop/restart/reload的服务启动的想法找到里Supervisor。关于supervisor的介绍在网上大致搜索总结如下：

      Supervisor是用Python开发的一套通用的进程管理程序，能将一个普通的命令行进程变为后台daemon，并监控进程状态，异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程。

说明：

1，安装

复制代码
1：easy_install 安装：
easy_install supervisor

2：pip 安装：
pip install supervisor

3：Debian / Ubuntu可以直接通过apt安装：
apt-get install supervisor
复制代码

2，配置文件

1）通过apt-get install安装后，supervisor的配置文件在：

/etc/supervisor/supervisord.conf 

supervisor的配置文件默认是不全的，不过在大部分默认的情况下，上面说的基本功能已经满足。而其管理的子进程配置文件在：

/etc/supervisor/conf.d/*.conf

然后，开始给自己需要的脚本程序编写一个子进程配置文件，让supervisor来管理它，放在/etc/supervisor/conf.d/目录下，以.conf作为扩展名（每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起）。如任意定义一个和脚本相关的项目名称的选项组（/etc/supervisor/conf.d/test.conf）：

复制代码
#项目名
[program:blog]
#脚本目录
directory=/opt/bin
#脚本执行命令
command=/usr/bin/python /opt/bin/test.py
#supervisor启动的时候是否随着同时启动，默认True
autostart=true
#当程序exit的时候，这个program不会自动重启,默认unexpected
#设置子进程挂掉后自动重启的情况，有三个选项，false,unexpected和true。如果为false的时候，无论什么情况下，都不会被重新启动，如果为unexpected，只有当进程的退出码不在下面的exitcodes里面定义的
autorestart=false
#这个选项是子进程启动多少秒之后，此时状态如果是running，则我们认为启动成功了。默认值为1
startsecs=1
#日志输出 
stderr_logfile=/tmp/blog_stderr.log 
stdout_logfile=/tmp/blog_stdout.log 
#脚本运行的用户身份 
user = zhoujy 
#把 stderr 重定向到 stdout，默认 false
redirect_stderr = true
#stdout 日志文件大小，默认 50MB
stdout_logfile_maxbytes = 20M
#stdout 日志文件备份数
stdout_logfile_backups = 20


[program:zhoujy] #说明同上
directory=/opt/bin 
command=/usr/bin/python /opt/bin/zhoujy.py 
autostart=true 
autorestart=false 
stderr_logfile=/tmp/zhoujy_stderr.log 
stdout_logfile=/tmp/zhoujy_stdout.log 
#user = zhoujy  
复制代码

2）通过easy_install安装后，配置文件不存在，需要自己导入。

①：运行echo_supervisord_conf打印出一个配置文件的样本，样本说明可以看supervisor(一)基础篇的详细说明，要是设置样本为一个配置文件则：

1：运行 echo_supervisord_conf，查看配置样本：
echo_supervisord_conf

2：创建配置文件：
echo_supervisord_conf > /etc/supervisord.conf

②：配置子进程配置文件，可以直接在supervisor中的;[program:theprogramname]里设置。

详细的子进程配置文件：

样本：

View Code

说明：

View Code

改成自己实际的配置文件：和①上面一样。

3：运行

1）apt-get install 安装的supervisor直接可以通过 /etc/init.d/supervisor 运行：

/etc/init.d/supervisor start

2）通过easy_install 安装的supervisor运行supervisord 运行：

supervisord

4：web界面操作

需要在supervisor的配置文件里添加[inet_http_server]选项组：之后可以通过http://10.211.55.11:9001来访问控制子线程的管理。

[inet_http_server]
port=10.211.55.11:9001
username=user
password=123

效果：

5：子进程管理(supervisorctl)

1) 查看所有子进程的状态： 

# supervisorctl status
blog                             RUNNING    pid 2395, uptime 0:08:41
zhoujy                           RUNNING    pid 2396, uptime 0:08:41

2）关闭、开启指定的子进程：

# supervisorctl stop zhoujy
zhoujy: stopped

# supervisorctl start zhoujy
zhoujy: started

3）关闭、开启所有的子进程：

# supervisorctl stop all
blog: stopped
zhoujy: stopped
# supervisorctl start all
blog: started
zhoujy: started

4）：其他参数：supervisor开启后子进程自动开启（autostart=true）和子进程退出后自动启动（autorestart=ture）

更多的参数可以看官方文档和supervisor(一)基础篇的说明。

总结：

      我们需要的功能在上面介绍的supervisor的基本功能中已经实现，supervisor还有其他的一些功能：如进程组、web页面管理子进程、监控子线程情况等等，更多的信息可以去官网上查看。

参考文档：

Supervisor官方文档

Supervisor(一)基础篇

Supervisor(二)event

Supervisor(三)xml_rpc

【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/fengff/p/9237319.html