yeskery

Supervisor安装与配置(Linux/Unix进程管理工具)

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

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

安装Python包管理工具(easy_install)

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

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

安装supervisor

  1. easy_install supervisor

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

配置

运行 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

配置文件参数说明

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

include示例:

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

配置管理进程

进程管理配置参数,不建议全都写在 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
  1. └── config.d
  2. | └── tomcat.ini
  3. └── supervisord.conf

下面是配置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

启动Supervisor服务

  1. supervisord -c /etc/supervisor/supervisord.conf

控制进程

交互终端

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

  1. tomcat RUNNING pid 2815, uptime 18:57:42
  2. supervisor> help
  3. default commands (type help <topic>):
  4. =====================================
  5. add clear fg open quit remove restart start stop update
  6. avail exit maintail pid reload reread shutdown status tail version
  7. supervisor> help stop
  8. stop <name> Stop a process
  9. stop <gname>:* Stop all processes in a group
  10. stop <name> <name> Stop multiple processes or groups
  11. stop all Stop all processes
  12. supervisor>

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

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

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

bash终端

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

Web管理界面

supervisor_web_view

出于安全考虑,默认配置是没有开启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:登录管理后台的密码。

开机启动Supervisor服务

配置 systemctl 服务

  1. 进入 /lib/systemd/system 目录,并创建 supervisor.service 文件
  1. [Unit]
  2. Description=supervisor
  3. After=network.target
  4. [Service]
  5. Type=forking
  6. ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
  7. ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown
  8. ExecReload=/usr/bin/supervisorctl $OPTIONS reload
  9. KillMode=process
  10. Restart=on-failure
  11. RestartSec=42s
  12. [Install]
  13. WantedBy=multi-user.target
  1. 设置开机启动

    1. systemctl enable supervisor.service
    2. systemctl daemon-reload
  2. 修改文件权限为 766

    1. chmod 766 supervisor.service

配置 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. # source function library
  16. . /etc/rc.d/init.d/functions
  17. RETVAL=0
  18. start() {
  19. echo -n $"Starting supervisord: "
  20. daemon "supervisord -c /etc/supervisor/supervisord.conf "
  21. RETVAL=$?
  22. echo
  23. [ $RETVAL -eq 0 ] && touch /var/lock/subsys/supervisord
  24. }
  25. stop() {
  26. echo -n $"Stopping supervisord: "
  27. killproc supervisord
  28. echo
  29. [ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/supervisord
  30. }
  31. restart() {
  32. stop
  33. start
  34. }
  35. case "$1" in
  36. start)
  37. start
  38. ;;
  39. stop)
  40. stop
  41. ;;
  42. restart|force-reload|reload)
  43. restart
  44. ;;
  45. condrestart)
  46. [ -f /var/lock/subsys/supervisord ] && restart
  47. ;;
  48. status)
  49. status supervisord
  50. RETVAL=$?
  51. ;;
  52. *)
  53. echo $"Usage: $0 {start|stop|status|restart|reload|force-reload|condrestart}"
  54. exit 1
  55. esac
  56. 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,可以查看进程的启动信息。

本文转载自:http://blog.csdn.net/xyang81/article/details/51555473

评论

发表评论 点击刷新验证码

提示

该功能暂未开放