supervisord守护进程搭建

特别说明：如果修改了/etc/supervisord.conf ,,需要执行 supervisorctl reload 来重新加载配置文件

Jenkins启动命令 /etc/rc.d/init.d/jenkins #启动脚本

配置supervisor守护进程

创建一个ci用户，用supervisor启动并监视jenkins服务

查看日志：

tail -f /var/log/supervisor/supervisord.log

（1）安装（supervisord）：

pip install --upgrade pip 【报错升级pip】 
pip install supervisor

（2）测试是否安装成功：

echo_supervisord_conf

（3）创建配置文件：

echo_supervisord_conf > /etc/supervisord.conf

supervisor自启动服务

这里只介绍在CentOS7上面添加supervisord服务为自启动，其他平台请自行google

修改 /lib/systemd/system/supervisord.service`，添加如下内容：

# supervisord service for systemd (CentOS 7.0+)
[Unit]
Description=Supervisor daemon

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisord.conf
ExecStop=/usr/bin/supervisorctl $OPTIONS shutdown
ExecReload=/usr/bin/supervisorctl $OPTIONS reload
KillMode=process
Restart=on-failure
RestartSec=60s

[Install]
WantedBy=multi-user.target

无需修改/etc/supervisord.conf配置文件，该启动脚本都能够添加到systemctl自启动服务:

systemctl enable supervisord.service
systemctl start/restart/stop supervisord.service

配置详解

Supervisor 相当强大，提供了很丰富的功能，不过我们可能只需要用到其中一小部分。安装完成之后，可以编写配置文件，来满足自己的需求。 为了方便，我们把配置分成两部分：

1. supervisord（这是 server 端，对应的有 client 端：supervisorctl）
2. 应用程序（即我们要管理的程序）。

首先来看 supervisord 的配置文件。去除里面大部分注释和“不相关”的部分，我们可以先看这些配置：

; Sample supervisor config file.

[unix_http_server]
file=/var/run/supervisor.sock   ; (the path to the socket file)
;chmod=0700                 ; sockef file mode (default 0700)
;chown=nobody:nogroup       ; socket file uid:gid owner
;username=user              ; (default is no username (open server))
;password=123               ; (default is no password (open server))

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

[supervisord]
logfile=/var/log/supervisor/supervisord.log  ; (main log file;default $CWD/supervisord.log)
logfile_maxbytes=50MB       ; (max main logfile bytes b4 rotation;default 50MB)
logfile_backups=10          ; (num of main logfile rotation backups;default 10)
loglevel=info               ; (log level;default info; others: debug,warn,trace)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
nodaemon=false              ; (start in foreground if true;default false)
minfds=1024                 ; (min. avail startup file descriptors;default 1024)
minprocs=200                ; (min. avail process descriptors;default 200)
;umask=022                  ; (process file creation umask;default 022)
;user=chrism                 ; (default is current user, required if root)
;identifier=supervisor       ; (supervisord identifier, default is 'supervisor')
;directory=/tmp              ; (default is not to cd during start)
;nocleanup=true              ; (don't clean up tempfiles at start;default false)
;childlogdir=/tmp            ; ('AUTO' child log dir, default $TEMP)
;environment=KEY=value       ; (key value pairs to add to environment)
;strip_ansi=false            ; (strip ansi escape codes in logs; def. false)

; the below section must remain in the config file for RPC
; (supervisorctl/web interface) to work, additional interfaces may be
; added by defining them in separate rpcinterface: sections
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[supervisorctl]
serverurl=unix:///var/run/supervisor.sock ; use a unix:// URL  for a unix socket
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris              ; should be same as http_username if set
;password=123                ; should be same as http_password if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

; The below sample program section shows all possible program subsection values,
; create one or more 'real' program: sections to be able to control them under
; supervisor.

;[program:theprogramname]
;command=/bin/cat              ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=999                  ; the relative start priority (default 999)
;autostart=true                ; start at supervisord start (default: true)
;autorestart=true              ; retstart at unexpected quit (default: true)
;startsecs=10                  ; number of secs prog must stay running (def. 1)
;startretries=3                ; max # of serial start failures (default 3)
;exitcodes=0,2                 ; 'expected' exit codes for process (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (default 10)
;stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10     ; # of stderr logfile backups (default 10)
;stderr_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;environment=A=1,B=2           ; process environment additions (def no adds)
;serverurl=AUTO                ; override serverurl computation (childutils)

; The below sample eventlistener section shows all possible
; eventlistener subsection values, create one or more 'real'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.

;[eventlistener:theeventlistenername]
;command=/bin/eventlistener    ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;events=EVENT                  ; event notif. types to subscribe to (req'd)
;buffer_size=10                ; event buffer queue size (default 10)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=-1                   ; the relative start priority (default -1)
;autostart=true                ; start at supervisord start (default: true)
;autorestart=unexpected        ; restart at unexpected quit (default: unexpected)
;startsecs=10                  ; number of secs prog must stay running (def. 1)
;startretries=3                ; max # of serial start failures (default 3)
;exitcodes=0,2                 ; 'expected' exit codes for process (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (default 10)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups        ; # of stderr logfile backups (default 10)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;environment=A=1,B=2           ; process environment additions
;serverurl=AUTO                ; override serverurl computation (childutils)

; The below sample group section shows all possible group values,
; create one or more 'real' group: sections to create "heterogeneous"
; process groups.

;[group:thegroupname]
;programs=progname1,progname2  ; each refers to 'x' in [program:x] definitions
;priority=999                  ; the relative start priority (default 999)

; The [include] section can just contain the "files" setting.  This
; setting can list multiple files (separated by whitespace or
; newlines).  It can also contain wildcards.  The filenames are
; interpreted as relative to this file.  Included files *cannot*
; include files themselves.

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

然后可以通过 supervisord 命令启动 supervisord:

supervisord -c /etc/supervisord.conf

查看 supervisord 是否在运行：

ps aux | grep supervisord

我们可以看到 supervisord 已经被启动了， 然后进入 supervisorctl 的 shell 界面:

$ supervisorctl supervisor> status supervisor>

由于目前没有添加任何需要管理的进程，所以 status 没有输出人和结果， 接下来我们添加一个需要管理的进程 (以启动一个 jenkins的 worker 为例)：

[program:jenkins]
command= /etc/rc.d/init.d/jenkins #jenkins 启动命令
user=jenkins
stdout_logfile=/var/log/supervisor/jenkins_out.log   ;stdout 日志输出位置
stderr_logfile=/var/log/supervisor/jenkins_err.log   ;stderr 日志输出位置
stdout_logfile_maxbytes=20MB                         ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups=20                            ; stdout 日志文件备份数
autostart=true                                       ; 在 supervisord 启动的时候自动启动
autorestart=true                                     ; 程序异常退出后自动重启
startsecs=10                                         ; 启动 10 秒后没有异常退出，就当作已经正常启动

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

使用 supervisorctl

然后运行以下命令更新配置并启动进程：

$ supervisorctl reread (只更新配置文件)
celeryd: available

$ supervisorctl update (只启动有改动的进程)
celeryd: added process group

$ supervisorctl status
jenkins                          RUNNING    pid 1919, uptime 0:00:18

我们看到 celery worker 已经被成功启动了。你可以使用不同的命令来控制进程的启动和关闭:

$ supervisorctl stop jenkins
celeryd: stopped
$ supervisorctl start jenkins
celeryd: started
$ supervisorctl restart jenkins
celeryd: stopped
celeryd: started

把所有的配置文件都放在 supervisord.conf 并不是个好主意，一旦管理的进程过多，就很麻烦。 所以一般都会 新建一个目录来专门放置进程的配置文件，然后通过 include 的方式来获取这些配置信息:

[include]
files = /etc/supervisor/conf.d/*.conf

然后在目录 /etc/supervisor/conf.d 下新建一个配置文件 celery.conf, 配置信息与上面的一致，效果是一样的。

命令详解

supervisord: 初始启动Supervisord，启动、管理配置中设置的进程;
supervisorctl stop(start, restart) xxx/all，停止（启动，重启）某一个进程(xxx)/全部;
supervisorctl reread: 只载入最新的配置文件, 并不重启任何进程;
supervisorctl reload: 载入最新的配置文件，停止原来的所有进程并按新的配置启动管理所有进程;
supervisorctl update: 根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启;

其他

除了 supervisorctl 之外，还可以配置 supervisrod 启动 web 管理界面，这个 web 后台使用 Basic Auth 的方式进行身份认证。

除了单个进程的控制，还可以配置 group，进行分组管理。

经常查看日志文件，包括 supervisord 的日志和各个 pragram 的日志文件， 程序 crash 或抛出异常的信息一半会输出到 stderr，可以查看相应的日志文件来查找问题。

Supervisor有很丰富的功能，还有其他很多配置，可以在官方文档获取更多信息：Supervisor: A Process Control System — Supervisor 4.2.5 documentation

FAQ

最后记录一下问题和解决办法:

1.reload的时候报错
No such file or directory: file: /usr/lib64/python2.7/socket.py
方案：原因是没有指定program的执行用户，指定即可user=root
2.status命令的时候报错
unix:///tmp/supervisor.sock no such file
方案：原因是supervisord进程根本就没启动，请重新执行启动命令。
3.supervisord -c /etc/supervisord.conf 这时候启动又报错
/var/log/supervisor/xxx_out.log does not exist
方案：原因是/var/log/supervisor目录不存在，去mkdir一个就可以了。
mkdir /var/log/supervisor

错误处理

　　１．unix:///tmp/supervisor.sock no such file

　　　　打开/etc/supervisor/supervisord.conf，这里把所有的/tmp路径改掉，

/tmp/supervisor.sock 改成 /var/run/supervisor.sock，

　　　　/tmp/supervisord.log成 /var/log/supervisor/supervisor.log，

/tmp/supervisord.pid 改成 /var/run/supervisor.pid 要不容易被linux自动清掉，

修改权限 chmod 777 /var/log/ 创建supervisor.sock sudo touch /var/run/supervisor.sock sudo chmod 777 /var/run/supervisor.sock 重启supervisord systemctl restart supervisord

　　2.Unlinking stale socket /var/run/supervisor.sock　　　

find / -name supervisor.sock unlink /var/run/supervisor.sock unlink /tmp/supervisor.sock