supervisord安装和配置

1 supervisord简介

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

supervisor的命令主要有：

supervisord : supervisor的服务器端部分，启动supervisor就是运行这个命令

supervisorctl：启动supervisor的命令行窗口。

2 安装supervisord

环境

  • 系统：centos7.3
  • 软件：supervisord

当前版本的supervisor暂不支持python3，可喜的是基于python2的supervisor同样可以管理使用python3编写的进程。我们使用下面命令安装

  1. [root@backup-41 ~]# yum install epel-release
  2. [root@backup-41 ~]# yum install -y supervisor

3 supervisord管理命令

命令 说明
supervisorctl start program_name 启动某个进程
supervisorctl stop program_name 停止某个进程
supervisorctl restart program_name 重启某个进程
supervisorctl status program_name 查看某个进程的状态
supervisorctl stop all 停止全部进程
supervisorctl reload 载入最新的配置文件，重启所有进程
supervisorctl update 根据最新的配置，重启配置更改过的进程，未更新的进程不受影响

4 详解supervisord配置文件

  1. ; Sample supervisor config file.
  2. ;
  3. ; For more information on the config file, please see:
  4. ; http://supervisord.org/configuration.html
  5. ;
  6. ; Note: shell expansion ("~" or "$HOME") is not supported.  Environment
  7. ; variables can be expanded using this syntax: "%(ENV_HOME)s".
  9. [unix_http_server]          ; supervisord的unix socket服务配置
  10. file=/tmp/supervisor.sock   ; socket文件的保存目录
  11. ;chmod=0700                 ; socket的文件权限 (default 0700)
  12. ;chown=nobody:nogroup       ; socket的拥有者和组名
  13. ;username=user              ; 默认不需要登陆用户 (open server)
  14. ;password=123               ; 默认不需要登陆密码 (open server)
  16. ;[inet_http_server]         ; supervisord的tcp服务配置
  17. ;port=127.0.0.1:9001        ; tcp端口
  18. ;username=user              ; tcp登陆用户
  19. ;password=123               ; tcp登陆密码
  21. [supervisord]                ; supervisord的主进程配置
  22. logfile=/tmp/supervisord.log ; 主要的进程日志配置
  23. logfile_maxbytes=50MB        ; 最大日志体积，默认50MB
  24. logfile_backups=10           ; 日志文件备份数目，默认10
  25. loglevel=info                ; 日志级别，默认info; 还有:debug,warn,trace
  26. pidfile=/tmp/supervisord.pid ; supervisord的pidfile文件
  27. nodaemon=false               ; 是否以守护进程的方式启动
  28. minfds=1024                  ; 最小的有效文件描述符，默认1024
  29. minprocs=200                 ; 最小的有效进程描述符，默认200
  30. ;umask=022                   ; 进程文件的umask，默认200
  31. ;user=chrism                 ; 默认为当前用户，如果为root则必填
  32. ;identifier=supervisor       ; supervisord的表示符, 默认时'supervisor'
  33. ;directory=/tmp              ; 默认不cd到当前目录
  34. ;nocleanup=true              ; 不在启动的时候清除临时文件，默认false
  35. ;childlogdir=/tmp            ; ('AUTO' child log dir, default $TEMP)
  36. ;environment=KEY=value       ; 初始键值对传递给进程
  37. ;strip_ansi=false            ; (strip ansi escape codes in logs; def. false)
  39. ; the below section must remain in the config file for RPC
  40. ; (supervisorctl/web interface) to work, additional interfaces may be
  41. ; added by defining them in separate rpcinterface: sections
  42. [rpcinterface:supervisor]
  43. supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
  45. [supervisorctl]
  46. serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
  47. ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
  48. ;username=chris              ; 如果设置应该与http_username相同
  49. ;password=123                ; 如果设置应该与http_password相同
  50. ;prompt=mysupervisor         ; 命令行提示符，默认"supervisor"
  51. ;history_file=~/.sc_history  ; 命令行历史纪录
  53. ; The below sample program section shows all possible program subsection values,
  54. ; create one or more 'real' program: sections to be able to control them under
  55. ; supervisor.
  57. ;[program:theprogramname]
  58. ;command=/bin/cat              ; 运行的程序 (相对使用PATH路径, 可以使用参数)
  59. ;process_name=%(program_name)s ; 进程名表达式，默认为%(program_name)s
  60. ;numprocs=1                    ; 默认启动的进程数目，默认为1
  61. ;directory=/tmp                ; 在运行前cwd到指定的目录，默认不执行cmd
  62. ;umask=022                     ; 进程umask，默认None
  63. ;priority=999                  ; 程序运行的优先级，默认999
  64. ;autostart=true                ; 默认随supervisord自动启动，默认true
  65. ;autorestart=unexpected        ; whether/when to restart (default: unexpected)
  66. ;startsecs=1                   ; number of secs prog must stay running (def. 1)
  67. ;startretries=3                ; max # of serial start failures (default 3)
  68. ;exitcodes=0,2                 ; 期望的退出码，默认0,2
  69. ;stopsignal=QUIT               ; 杀死进程的信号，默认TERM
  70. ;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
  71. ;stopasgroup=false             ; 向unix进程组发送停止信号，默认false
  72. ;killasgroup=false             ; 向unix进程组发送SIGKILL信号，默认false
  73. ;user=chrism                   ; 为运行程序的unix帐号设置setuid
  74. ;redirect_stderr=true          ; 将标准错误重定向到标准输出，默认false
  75. ;stdout_logfile=/a/path        ; 标准输出的文件路径NONE＝none;默认AUTO
  76. ;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
  77. ;stdout_logfile_backups=10     ; # of stdout logfile backups (default 10)
  78. ;stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
  79. ;stdout_events_enabled=false   ; emit events on stdout writes (default false)
  80. ;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
  81. ;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
  82. ;stderr_logfile_backups=10     ; # of stderr logfile backups (default 10)
  83. ;stderr_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
  84. ;stderr_events_enabled=false   ; emit events on stderr writes (default false)
  85. ;environment=A=1,B=2           ; process environment additions (def no adds)
  86. ;serverurl=AUTO                ; override serverurl computation (childutils)
  88. ; The below sample eventlistener section shows all possible
  89. ; eventlistener subsection values, create one or more 'real'
  90. ; eventlistener: sections to be able to handle event notifications
  91. ; sent by supervisor.
  93. ;[eventlistener:theeventlistenername]
  94. ;command=/bin/eventlistener    ; 运行的程序 (相对使用PATH路径, 可以使用参数)
  95. ;process_name=%(program_name)s ; 进程名表达式，默认为%(program_name)s
  96. ;numprocs=1                    ; 默认启动的进程数目，默认为1
  97. ;events=EVENT                  ; event notif. types to subscribe to (req'd)
  98. ;buffer_size=10                ; 事件缓冲区队列大小，默认10
  99. ;directory=/tmp                ; 在运行前cwd到指定的目录，默认不执行cmd
  100. ;umask=022                     ; 进程umask，默认None
  101. ;priority=-1                   ; 程序运行的优先级，默认-1
  102. ;autostart=true                ; 默认随supervisord自动启动，默认true
  103. ;autorestart=unexpected        ; whether/when to restart (default: unexpected)
  104. ;startsecs=1                   ; number of secs prog must stay running (def. 1)
  105. ;startretries=3                ; max # of serial start failures (default 3)
  106. ;exitcodes=0,2                 ; 期望的退出码，默认0,2
  107. ;stopsignal=QUIT               ; 杀死进程的信号，默认TERM
  108. ;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
  109. ;stopasgroup=false             ; 向unix进程组发送停止信号，默认false
  110. ;killasgroup=false             ; 向unix进程组发送SIGKILL信号，默认false
  111. ;user=chrism                   ; setuid to this UNIX account to run the program
  112. ;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
  113. ;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
  114. ;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
  115. ;stdout_logfile_backups=10     ; # of stdout logfile backups (default 10)
  116. ;stdout_events_enabled=false   ; emit events on stdout writes (default false)
  117. ;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
  118. ;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
  119. ;stderr_logfile_backups        ; # of stderr logfile backups (default 10)
  120. ;stderr_events_enabled=false   ; emit events on stderr writes (default false)
  121. ;environment=A=1,B=2           ; process environment additions
  122. ;serverurl=AUTO                ; override serverurl computation (childutils)
  124. ; The below sample group section shows all possible group values,
  125. ; create one or more 'real' group: sections to create "heterogeneous"
  126. ; process groups.
  128. ;[group:thegroupname]
  129. ;programs=progname1,progname2  ; 任何在[program:x]中定义的x
  130. ;priority=999                  ; 程序运行的优先级，默认999
  132. ; The [include] section can just contain the "files" setting.  This
  133. ; setting can list multiple files (separated by whitespace or
  134. ; newlines).  It can also contain wildcards.  The filenames are
  135. ; interpreted as relative to this file.  Included files *cannot*
  136. ; include files themselves.
  138. ;[include]
  139. ;files = relative/directory/*.ini

5 配置管理进程

进程管理配置参数，不建议全都写在supervisord.conf文件中，应该每个进程写一个配置文件放在include指定的目录下包含进supervisord.conf文件中。

  1. [include]
  2. files = supervisord.d/*.ini

下面是配置Nexus进程的一个列子：

  1. [root@nexus-70 supervisord.d]# vim /etc/supervisord.d/nexus.ini 
  2. [program:nexus]
  3. command=/usr/local/nexus/bin/nexus run         #应用执行命令
  4. stdout_logfile=/usr/local/nexus/nexus.log      #日志输出
  5. stderr_logfile=/usr/local/nexus/nexus_err.log  #日志输出
  6. autostart=true                                 #supervisor启动的时候是否随着同时启动，默认True
  7. autorestart=true                               #进程意外退出后是否自动重启
  8. startsecs=10                                   #进程持续运行多久才认为是启动成功
  9. priority=1                                     #指明进程启动和关闭的优先级
  10. stopasgroup=true                               #这个东西主要用于，supervisord管理的子进程，这个子进程本身还有子进程。那么我们如果仅仅干掉supervisord的子进程的话，子进程的子进程有可能会变成孤儿进程。所以咱们可以设置可个选项，把整个该子进程的整个进程组都干掉。 设置为true的话，一般killasgroup也会被设置为true。需要注意的是，该选项发送的是stop信号。默认为false。。非必须设置。。
  11. killasgroup=true                               #这个和上面的stopasgroup类似，不过发送的是kill信号

6 启动supervisor服务

  1. [root@nexus-70 ~]# systemctl start supervisord
  2. [root@nexus-70 ~]# systemctl enable supervisord

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

  1. [root@nexus-70 supervisord.d]# supervisorctl status nexus
  2. nexus                            RUNNING   pid 24242, uptime 0:00:21
  4. supervisorctl status nexus
  5. supervisorctl stop nexus
  6. supervisorctl start nexus
  7. supervisorctl restart nexus
  8. supervisorctl reread
  9. supervisorctl update