1. Supervisor

Supervisor是一个Python开发的client/server系统，可以管理和监控nix上面的进程。不过同daemontools一样，它也*不能监控daemon进程

2. 部件组成

Supervisor有不同的部件组成，部件分别负责不同的功能，对进程进行监控和管理。

  • Supervisord（服务端）
    Supervisor的server部分称为supervisord。主要负责管理子进程，响应客户端的命令，log子进程的输出，创建和处理不同的事件
  • Supervisorctl（命令行）
    Supervisor的命令行客户端。它可以与不同的supervisord进程进行通信，获取子进程信息，管理子进程
  • Web Server（服务界面）
    Supervisor的web server，用户可以通过web对子进程进行监控，管理等等，作用与supervisorctl一致。
  • XML-RPC interface（服务接口）
    XML-RPC接口，提供XML-RPC服务来对子进程进行管理，监控

3. 安装

  1. # Python安装
  2. sudo pip install supervisor
  3. easy_install supervisor
  5. # Liunx发行版安装
  6. apt-get install supervisor
  7. yum install supervisor

4. 使用

  • 生成配置
  1. echo_supervisord_conf > /path/to/supervisord.conf
  3. # 如果出现没有权限的问题，可以使用这条命令
  4. sudo su - root -c "echo_supervisord_conf > /etc/supervisord.conf"
  • 配置

配置文件supervisord.conf是一个ini文件，可以对http_server、supervisord、supervisorctl和program进行配置。

  1. [unix_http_server]
  2. ;file=/tmp/supervisor.sock   ; UNIX socket 文件，supervisorctl 会使用
  3. file=/var/run/supervisor.sock   ; (the path to the socket file)
  4. ;chmod=0700                 ; socket 文件的 mode，默认是 0700
  5. ;chown=nobody:nogroup       ; socket 文件的 owner，格式： uid:gid
  7. ;[inet_http_server]         ; HTTP 服务器，提供 web 管理界面
  8. ;port=127.0.0.1:9699        ; Web 管理后台运行的 IP 和端口，如果开放到公网，需要注意安全性
  9. ;username=user              ; 登录管理后台的用户名
  10. ;password=123               ; 登录管理后台的密码
  12. [supervisord]
  13. logfile=/tmp/supervisord.log ; 日志文件，默认是 $CWD/supervisord.log
  14. logfile_maxbytes=50MB        ; 日志文件大小，超出会 rotate，默认 50MB
  15. logfile_backups=10           ; 日志文件保留备份数量默认 10
  16. loglevel=info                ; 日志级别，默认 info，其它: debug,warn,trace
  17. pidfile=/tmp/supervisord.pid ; pid 文件
  18. nodaemon=false               ; 是否在前台启动，默认是 false，即以 daemon 的方式启动
  19. minfds=1024                  ; 可以打开的文件描述符的最小值，默认 1024
  20. minprocs=200                 ; 可以打开的进程数的最小值，默认 200
  22. [supervisorctl]
  23. serverurl=unix:///var/run/supervisor.sock ; 通过 UNIX socket 连接 supervisord
  24. ;serverurl=http://127.0.0.1:9001 ; 通过 HTTP 的方式连接 supervisord
  26. ; 包含其他的配置文件
  27. [include]
  28. files = relative/directory/*.ini    ; 可以是 *.conf 或 *.ini
  30. [program:redis]
  31. command = redis-server   //需要执行的命令
  32. autostart=true    //supervisor启动的时候是否随着同时启动
  33. autorestart=true   //当程序跑出exit的时候，这个program会自动重启
  34. startsecs=3  //程序重启时候停留在runing状态的秒数
  36. ; 管理的单个进程的配置，可以添加多个program
  37. [program:chatdemon]
  38. command=python /home/felinx/demos/chat/chatdemo.py
  39. autostart = true
  40. startsecs = 5
  41. user = felinx
  42. redirect_stderr = true
  43. ；这对这个program的log的配置，上面的logfile_maxbytes是supervisord本身的log配置
  44. stdout_logfile_maxbytes = 20MB
  45. stdoiut_logfile_backups = 20
  46. stdout_logfile = /var/log/supervisord/chatdemo.log
  48. ; 配置一组进程，对于类似的program可以通过这种方式添加，避免手工一个个添加
  49. [program:groupworker]
  50. command=python /home/felinx/demos/groupworker/worker.py
  51. numprocs=24
  52. process_name=%(program_name)s_%(process_num)02d
  53. autostart = true
  54. startsecs = 5
  55. user = felinx
  56. redirect_stderr = true
  57. stdout_logfile = /var/log/supervisord/groupworker.log
  59. [program:usercenter]
  60. directory = /home/leon/projects/usercenter ; 程序的启动目录
  61. command = gunicorn -c gunicorn.py wsgi:app  ; 启动命令，可以看出与手动在命令行启动的命令是一样的
  62. autostart = true     ; 在 supervisord 启动的时候也自动启动
  63. startsecs = 5        ; 启动 5 秒后没有异常退出，就当作已经正常启动了
  64. autorestart = true   ; 程序异常退出后自动重启
  65. startretries = 3     ; 启动失败自动重试次数，默认是 3
  66. user = leon          ; 用哪个用户启动
  67. redirect_stderr = true  ; 把 stderr 重定向到 stdout，默认 false
  68. stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
  69. stdout_logfile_backups = 20     ; stdout 日志文件备份数
  70. ; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
  71. stdout_logfile = /data/logs/usercenter_stdout.log
  73. ; 可以通过 environment 来添加需要的环境变量，一种常见的用法是修改 PYTHONPATH
  74. ; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

（更多配置说明请参考：http://supervisord.org/configuration.html）

  • Supervisord管理
    Supervisord安装完成后有两个可用的命令行supervisor和supervisorctl，命令使用解释如下： | 命令 | 解释 | | —- | —- | | supervisord [ -c /etc/supervisord.conf ] | 初始启动Supervisord，启动、管理配置中设置的进程。 | | supervisorctl stop programxxx | 停止某一个进程(programxxx)，programxxx为[program:chatdemon]里配置的值，这个示例就是chatdemon。 | | supervisorctl start programxxx | 启动某个进程 | | supervisorctl restart programxxx | 重启某个进程 | | supervisorctl stop groupworker: | 重启所有属于名为groupworker这个分组的进程(start,restart同理) | | supervisorctl stop all | 停止全部进程，注：start、restart、stop都不会载入最新的配置文件。 | | supervisorctl reload | 载入最新的配置文件，停止原有进程并按新的配置启动、管理所有进程。 | | supervisorctl update | 根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启。 | | ctl中： help | 查看命令 | | ctl中： status | 查看状态 | | supervisorctl -c conf/app.conf status | 自定义配置路径需要这么进？没尝试 |
  • 查看log

5. 使用注意

  1. 用supervisor启动Redis,nginx等进程时，需要在注释掉相关进程的启动方式不要用守护模式启动（daemonize为no）
  2. supervisor进程文件默认放在 /tmp 目录下，修改为 /var/run 目录，避免被系统删除
  3. supervisor日志文件默认在 /tmp/supervisord.log

6. 参考

  1. 用Supervisord管理Python进程
  2. 进程的守护神 - Supervisor
  3. 【重要】使用 supervisor 管理进程
  4. 【重要】Python 进程管理工具 Supervisor 使用教程