Skip to content

一、supervisor简介

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

*注:本文以centos7为例,supervisor版本4.2.2

官方文档,http://supervisord.org/

优点:

​ 规范化

​ supervisor配置文件中指定子进程的配置文件路径,将所有子进程放在一个目录,并对子进程配置文件类型(后缀)统一要求。

自动重启

​ 可以设置 supervisor 启动后,自动启动子进程。父进程对子进程进行监控,当子进程误挂掉后,可以自动重启。

功能丰富:

​ 配置项(自动重启次数、进程数量等)众多,可以根据自己的业务需求选择合适配置项。

命令健全

​ 提供了重启、开启、关闭等命令选项

二、supervisor安装

yum install -y epel-release && yum install -y supervisor

#查看版本
supervisord --version
yum install -y epel-release && yum install -y supervisor

#查看版本
supervisord --version

3.1systemd 配置

shell
vim /usr/lib/systemd/system/supervisord.service

[Unit]
Description=Supervisor daemon

[Service]
Type=forking
PIDFile=/var/run/supervisord.pid
ExecStart=/bin/supervisord -c /etc/supervisord.conf
ExecStop=/bin/supervisorctl shutdown
ExecReload=/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
LimitNOFILE=1048576
[Install]
WantedBy=multi-user.target
vim /usr/lib/systemd/system/supervisord.service

[Unit]
Description=Supervisor daemon

[Service]
Type=forking
PIDFile=/var/run/supervisord.pid
ExecStart=/bin/supervisord -c /etc/supervisord.conf
ExecStop=/bin/supervisorctl shutdown
ExecReload=/bin/supervisorctl reload
KillMode=process
Restart=on-failure
RestartSec=42s
LimitNOFILE=1048576
[Install]
WantedBy=multi-user.target

3.2启动

shell
#开机启动
systemctl enable supervisord


#启动
systemctl start supervisord

#关闭
systemctl stop supervisord

systemctl reload supervisord

systemctl restart supervisord



status:查看服务状态
update:重新加载配置文件,添加新服务的时候执行
restart:重新启动服务
stop:停止服务
pid:查看某服务的 pid
tail:输出最新的 log 信息
shutdown:关闭 supervisord 服务
#开机启动
systemctl enable supervisord


#启动
systemctl start supervisord

#关闭
systemctl stop supervisord

systemctl reload supervisord

systemctl restart supervisord



status:查看服务状态
update:重新加载配置文件,添加新服务的时候执行
restart:重新启动服务
stop:停止服务
pid:查看某服务的 pid
tail:输出最新的 log 信息
shutdown:关闭 supervisord 服务

三、supervisor使用

supervisor配置文件

/etc/supervisord.conf

注:supervisor的配置文件默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足

子进程配置文件路径

/etc/supervisord.d/

注:默认子进程配置文件为ini格式,可在supervisor主配置文件中修改

四、配置文件说明

生成配置文件

$ mkdir /etc/supervisor
$ echo_supervisord_conf > /etc/supervisor/supervisord.conf
$ mkdir /etc/supervisor
$ echo_supervisord_conf > /etc/supervisor/supervisord.conf

主配置部分

[unix_http_server]
file=/tmp/supervisor.sock   ; socket文件的路径
;chmod=0700                 ; socket文件权限
;chown=nobody:nogroup       ; socket文件用户和用户组
;username=user              ; 连接时认证的用户名
;password=123               ; 连接时认证的密码

[inet_http_server]          ; 监听TCP
port=127.0.0.1:9001         ; 监听ip和端口
username=user               ; 连接时认证的用户名
password=123                ; 连接时认证的密码

[supervisord]
logfile=/var/log/supervisord.log ; log目录
logfile_maxbytes=50MB        ; log文件最大空间
logfile_backups=10           ; log文件保持的数量
loglevel=info                ; log级别
pidfile=/var/run/supervisord.pid
nodaemon=false               ; 是否非守护进程态运行
minfds=1024                  ; 系统空闲的最少文件描述符
minprocs=200                 ; 可用的最小进程描述符
;umask=022                   ; 进程创建文件的掩码
;identifier=supervisor       ; supervisord标识符
;directory=/tmp              ; 启动前切换到的目录
;nocleanup=true              ; 启动前是否清除子进程的日志文件
;childlogdir=/tmp            ; AUTO模式,子进程日志路径
;environment=KEY="value"     ; 设置环境变量

[rpcinterface:supervisor]    ; XML_RPC配置
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; 连接的socket路径
;username=chris               ; 用户名
;password=123                 ; 密码
prompt=mysupervisor           ; 输入用户名和密码时的提示符
;history_file=~/.sc_history   ; 历史操作记录存储路径

[include]                     ; 包含文件,将每个进程配置为一个文件并包含
files = /etc/supervisor/*.ini ; 多个进程的配置文件
[unix_http_server]
file=/tmp/supervisor.sock   ; socket文件的路径
;chmod=0700                 ; socket文件权限
;chown=nobody:nogroup       ; socket文件用户和用户组
;username=user              ; 连接时认证的用户名
;password=123               ; 连接时认证的密码

[inet_http_server]          ; 监听TCP
port=127.0.0.1:9001         ; 监听ip和端口
username=user               ; 连接时认证的用户名
password=123                ; 连接时认证的密码

[supervisord]
logfile=/var/log/supervisord.log ; log目录
logfile_maxbytes=50MB        ; log文件最大空间
logfile_backups=10           ; log文件保持的数量
loglevel=info                ; log级别
pidfile=/var/run/supervisord.pid
nodaemon=false               ; 是否非守护进程态运行
minfds=1024                  ; 系统空闲的最少文件描述符
minprocs=200                 ; 可用的最小进程描述符
;umask=022                   ; 进程创建文件的掩码
;identifier=supervisor       ; supervisord标识符
;directory=/tmp              ; 启动前切换到的目录
;nocleanup=true              ; 启动前是否清除子进程的日志文件
;childlogdir=/tmp            ; AUTO模式,子进程日志路径
;environment=KEY="value"     ; 设置环境变量

[rpcinterface:supervisor]    ; XML_RPC配置
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; 连接的socket路径
;username=chris               ; 用户名
;password=123                 ; 密码
prompt=mysupervisor           ; 输入用户名和密码时的提示符
;history_file=~/.sc_history   ; 历史操作记录存储路径

[include]                     ; 包含文件,将每个进程配置为一个文件并包含
files = /etc/supervisor/*.ini ; 多个进程的配置文件

这部分我们不需要做太多的配置修改,如果需要开启 WEB 终端监控,则需要配置并开启 inet_http_server 项

进程配置部分

[program:work]                      ; 服务名,例如work
command=php -r "sleep(10);exit(1);" ; 带有参数的可执行命令
process_name=%(process_num)s        ; 进程名,当numprocs>1时,需包含%(process_num)s
numprocs=2                          ; 启动进程的数目数
;directory=/tmp                     ; 运行前切换到该目录
;umask=022                          ; 进程掩码
;priority=999                       ; 子进程启动关闭优先级
autostart=true                      ; 子进程是否被自动启动,#这个是设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果>为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的>退出码不在下面的exitcodes里面定义的退出码的时候,才会被自动重启。当为true的时候>>,只要子进程挂掉,将会被无条件的重启
startsecs=1                         ; 成功启动几秒后则认为成功启动
;startretries=3                     ; 子进程启动失败后,最大尝试启动的次数
autorestart=unexpected            ; 子进程意外退出后自动重启的选项,false, unexpected, true。unexpected表示不在exitcodes列表时重启
exitcodes=0,2                     ; 期待的子程序退出码
;stopsignal=QUIT                  ; 进程停止信号,可以为TERM,HUP,INT,QUIT,KILL,USR1,or USR2等信号,默认为TERM
;stopwaitsecs=10                  ; 发送停止信号后等待的最大时间
;stopasgroup=false                ; 是否向子进程组发送停止信号
;killasgroup=false                ; 是否向子进程组发送kill信号
;redirect_stderr=true             ; 是否重定向日志到标准输出
stdout_logfile=/data/logs/work.log ; 进程的stdout的日志路径
;stdout_logfile_maxbytes=1MB      ; 日志文件最大大小
;stdout_logfile_backups=10
;stdout_capture_maxbytes=1MB
;stderr_logfile=/a/path           ; stderr的日志路径
;stderr_logfile_maxbytes=1MB
;stderr_logfile_backups=10
;stderr_capture_maxbytes=1MB
;environment=A="1",B="2"          ; 子进程的环境变量
;serverurl=AUTO                   ; 子进程的环境变量SUPERVISOR_SERVER_URL
[program:work]                      ; 服务名,例如work
command=php -r "sleep(10);exit(1);" ; 带有参数的可执行命令
process_name=%(process_num)s        ; 进程名,当numprocs>1时,需包含%(process_num)s
numprocs=2                          ; 启动进程的数目数
;directory=/tmp                     ; 运行前切换到该目录
;umask=022                          ; 进程掩码
;priority=999                       ; 子进程启动关闭优先级
autostart=true                      ; 子进程是否被自动启动,#这个是设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果>为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的>退出码不在下面的exitcodes里面定义的退出码的时候,才会被自动重启。当为true的时候>>,只要子进程挂掉,将会被无条件的重启
startsecs=1                         ; 成功启动几秒后则认为成功启动
;startretries=3                     ; 子进程启动失败后,最大尝试启动的次数
autorestart=unexpected            ; 子进程意外退出后自动重启的选项,false, unexpected, true。unexpected表示不在exitcodes列表时重启
exitcodes=0,2                     ; 期待的子程序退出码
;stopsignal=QUIT                  ; 进程停止信号,可以为TERM,HUP,INT,QUIT,KILL,USR1,or USR2等信号,默认为TERM
;stopwaitsecs=10                  ; 发送停止信号后等待的最大时间
;stopasgroup=false                ; 是否向子进程组发送停止信号
;killasgroup=false                ; 是否向子进程组发送kill信号
;redirect_stderr=true             ; 是否重定向日志到标准输出
stdout_logfile=/data/logs/work.log ; 进程的stdout的日志路径
;stdout_logfile_maxbytes=1MB      ; 日志文件最大大小
;stdout_logfile_backups=10
;stdout_capture_maxbytes=1MB
;stderr_logfile=/a/path           ; stderr的日志路径
;stderr_logfile_maxbytes=1MB
;stderr_logfile_backups=10
;stderr_capture_maxbytes=1MB
;environment=A="1",B="2"          ; 子进程的环境变量
;serverurl=AUTO                   ; 子进程的环境变量SUPERVISOR_SERVER_URL

通常将每个进程的配置信息配置成独立文件,并通过 include 模块包含,这样方便修改和管理配置文件

kill

supervisor支持的信号:TERM,HUP,INT,QUIT,KILL,USR1或USR2中的任何一个,分别对应内核级信号:SIGTERM,SIGHUP,SIGINT,SIGQUIT,SIGKILL,SIGUSR1,SIGUSR2

其中,USR1信号将导致以下步骤的发生:

  • 停止接受新的连接
  • 等待当前连接停止
  • 重新载入配置文件,重新打开日志文件,重启服务器,从而实现相对平滑的不关机的更改
#以USR1为例,新增如下行
stopsignal = USR1
stopwaitsecs = 20
stopasgroup = true

stopsignal含义
	使用SIGUSR1信号来stop
stopwaitsecs含义
	在向程序发送停止信号后,等待操作系统将SIGCHLD返回给supervisor的秒数。如果超过了这个时间仍未收到SIGCHLD,最终将会使用SIGKILL来杀掉进程。默认值:10秒
stopasgroup含义
	将停止信号发送到整个过程组,使程序将停止信号成为孤立状态
#以USR1为例,新增如下行
stopsignal = USR1
stopwaitsecs = 20
stopasgroup = true

stopsignal含义
	使用SIGUSR1信号来stop
stopwaitsecs含义
	在向程序发送停止信号后,等待操作系统将SIGCHLD返回给supervisor的秒数。如果超过了这个时间仍未收到SIGCHLD,最终将会使用SIGKILL来杀掉进程。默认值:10秒
stopasgroup含义
	将停止信号发送到整个过程组,使程序将停止信号成为孤立状态

supervisor.conf配置文件说明

[unix_http_server]
file=/tmp/supervisor.sock   ;UNIX socket 文件,supervisorctl 会使用
;chmod=0700                 ;socket文件的mode,默认是0700
;chown=nobody:nogroup       ;socket文件的owner,格式:uid:gid
 
;[inet_http_server]         ;HTTP服务器,提供web管理界面
;port=127.0.0.1:9001        ;Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性
;username=user              ;登录管理后台的用户名
;password=123               ;登录管理后台的密码
 
[supervisord]
logfile=/tmp/supervisord.log ;日志文件,默认是 $CWD/supervisord.log
logfile_maxbytes=50MB        ;日志文件大小,超出会rotate,默认 50MB,如果设成0,表示不限制大小
logfile_backups=10           ;日志文件保留备份数量默认10,设为0表示不备份
loglevel=info                ;日志级别,默认info,其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false               ;是否在前台启动,默认是false,即以 daemon 的方式启动
minfds=1024                  ;可以打开的文件描述符的最小值,默认 1024
minprocs=200                 ;可以打开的进程数的最小值,默认 200
 
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord,路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
 
; [program:xx]是被管理的进程配置参数,xx是进程的名称
[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run  ; 程序启动命令
autostart=true       ; 在supervisord启动的时候也自动启动
startsecs=10         ; 启动10秒后没有异常退出,就表示进程正常启动了,默认为1秒
autorestart=true     ; 程序退出后自动重启,可选值:[unexpected,true,false],默认为unexpected,表示进程意外杀死后才重启
startretries=3       ; 启动失败自动重试次数,默认是3
user=tomcat          ; 用哪个用户启动进程,默认是root
priority=999         ; 进程启动优先级,默认999,值小的优先启动
redirect_stderr=true ; 把stderr重定向到stdout,默认false
stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小,默认50MB
stdout_logfile_backups = 20   ; stdout 日志文件备份数,默认是10
; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out

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

stopasgroup=false     ;默认为false,进程被杀死时,是否向这个进程组发送stop信号,包括子进程
killasgroup=false     ;默认为false,向进程组发送kill信号,包括子进程
 
;包含其它配置文件
[include]
files = relative/directory/*.ini    ;可以指定一个或多个以.ini结束的配置文件

子进程配置文件说明

给需要管理的子进程(程序)编写一个配置文件,放在/etc/supervisor.d/目录下,以.ini作为扩展名(每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起)

配置Supervisor

通过运行echo_supervisord_conf程序生成supervisor的初始化配置文件

  • 如果使用yum安装则此步骤省略,直接进行修改配置文件步骤
mkdir /etc/supervisord.d
echo_supervisord_conf > /etc/supervisord.conf
mkdir /etc/supervisord.d
echo_supervisord_conf > /etc/supervisord.conf
  • 修改配置文件
#修改socket文件的mode,默认是0700
sed -i 's/;chmod=0700/chmod=0766/g' /etc/supervisord.conf   

#在配置文件最后添加以下两行内容来包含/etc/supervisord目录
sed -i '$a [include] \
files = /etc/supervisord.d/*.conf' /etc/supervisord.conf
#修改socket文件的mode,默认是0700
sed -i 's/;chmod=0700/chmod=0766/g' /etc/supervisord.conf   

#在配置文件最后添加以下两行内容来包含/etc/supervisord目录
sed -i '$a [include] \
files = /etc/supervisord.d/*.conf' /etc/supervisord.conf

五、supervisor命令说明

5.1常用命令

bash
### 查看supervisorctl支持的命令
# supervisorctl help 

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version


supervisorctl tail client_name stdout
### 查看supervisorctl支持的命令
# supervisorctl help 

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version


supervisorctl tail client_name stdout
命令用途
supervisord启动supervisor监管服务
supervisorctl start xxx启动XXX进程
supervisorctl restart xxx重启XXX进程
supervisorctl stop xxx停止XXX进程
supervisorctl stop all停止全部进程
supervisorctl status查看supervisor监管的进程状态
supervisorctl reload修改完配置文件后重新启动supervisor
supervisorctl update根据最新的配置文件,启动新配置或有改动的进程,配置没有改动的进程不会受影响而重启

注:把xxx换成all可以管理配置中的所有进程。直接输入supervisorctl进入supervisorctl的shell交互界面,此时上面的命令不带supervisorctl可直接使用

5.2三个执行程序

supervisor安装完成后会生成三个执行程序:

supervisortd:用于管理supervisor本身服务

supervisorctl: 用于管理我们需要委托给superviso工具的服务

echo_supervisord_conf: 用于生成superviso的配置文件

更改 Supervisor 的最大打开文件描述符数

# 如果应用使用supervisor来管理,则需要按以下步骤配置,否则上面的配置对使用supervisor管理的应用不生效

# 修改supervisor的配置文件
# vim /etc/supervisord.conf
minfds=1048576

# 修改supervisor的systemctl启动脚本,添加LimitNOFILE属性
# vim /usr/lib/systemd/system/supervisord.service
[Service]
LimitNOFILE=1048576

# 重启supervisord生效
# systemctl daemon-reload
# systemctl restart supervisord
# 如果应用使用supervisor来管理,则需要按以下步骤配置,否则上面的配置对使用supervisor管理的应用不生效

# 修改supervisor的配置文件
# vim /etc/supervisord.conf
minfds=1048576

# 修改supervisor的systemctl启动脚本,添加LimitNOFILE属性
# vim /usr/lib/systemd/system/supervisord.service
[Service]
LimitNOFILE=1048576

# 重启supervisord生效
# systemctl daemon-reload
# systemctl restart supervisord

更改 MySQL(RPM 方式安装)的最大打开文件描述符数

# 如果是通过yum源或者rpm包的方式安装mysql,那么上面的配置对mysql无效,因为systemctl启动脚本覆盖了ulimit配置

# 查看mysql的最大打开文件描述符数
# cat /proc/`pidof mysqld`/limits
# egrep '^(Limit|Max open files)' /proc/`pidof mysqld`/limits

# 第一种方法:直接修改mysql的systemctl启动脚本(不建议修改mysqld.service,这样会影响下次升级)
# vim /usr/lib/systemd/system/mysqld.service
LimitNOFILE=1048576

# 第二种方法:完美解决升级问题
# mkdir /usr/lib/systemd/system/mysqld.service.d
# vim /usr/lib/systemd/system/mysqld.service.d/override.conf
[Service]
LimitNOFILE=1048576

# 重启mysql生效
# systemctl daemon-reload
# systemctl restart mysqld
# 如果是通过yum源或者rpm包的方式安装mysql,那么上面的配置对mysql无效,因为systemctl启动脚本覆盖了ulimit配置

# 查看mysql的最大打开文件描述符数
# cat /proc/`pidof mysqld`/limits
# egrep '^(Limit|Max open files)' /proc/`pidof mysqld`/limits

# 第一种方法:直接修改mysql的systemctl启动脚本(不建议修改mysqld.service,这样会影响下次升级)
# vim /usr/lib/systemd/system/mysqld.service
LimitNOFILE=1048576

# 第二种方法:完美解决升级问题
# mkdir /usr/lib/systemd/system/mysqld.service.d
# vim /usr/lib/systemd/system/mysqld.service.d/override.conf
[Service]
LimitNOFILE=1048576

# 重启mysql生效
# systemctl daemon-reload
# systemctl restart mysqld

5.3环境变量

supervisor 调用的环境变量分为两种,

一种是在 supervisor 配置文件中使用系统已经定义好的环境变量,

另一种为 supervisor 子程序运行过程中使用的环境变量

调用系统环境变量

在 supervisor 的配置文件中调用系统的环境变量时,需要以 %(ENV_xxxx)s 的格式进行调用。

假如系统环境变量中有这样一个环境变量 export MY_HOME=/opt/home,那我在 supervisor 中就要以 %(ENV_MY_HOME)s进行调用

子程序运行的环境变量

此类环境变量一般用来定义子程序所依赖的一些库文件

子程序的环境变量需要在自己的 [program:x] 下新增 environment 字段。如 environment=LD_LIBRARY=/opt/home/lib

[program:hello]
depends_on=hello
command=%(ENV_MY_HOME)s/hello
directory=%(ENV_MY_HOME)s/hello
autostart=true
autorestart=true
stopwaitsecs=3
stdout_logfile=%(ENV_MY_HOME)s/logs/hello.log
stderr_logfile=%(ENV_MY_HOME)s/logs/hello.log
stdout_logfile_maxbytes=10485760
stdout_logfile_backups=2
stderr_logfile_maxbytes=10485760
stderr_logfile_backups=2
environment=LD_LIBRARY=%(ENV_MY_HOME)s/lib
[program:hello]
depends_on=hello
command=%(ENV_MY_HOME)s/hello
directory=%(ENV_MY_HOME)s/hello
autostart=true
autorestart=true
stopwaitsecs=3
stdout_logfile=%(ENV_MY_HOME)s/logs/hello.log
stderr_logfile=%(ENV_MY_HOME)s/logs/hello.log
stdout_logfile_maxbytes=10485760
stdout_logfile_backups=2
stderr_logfile_maxbytes=10485760
stderr_logfile_backups=2
environment=LD_LIBRARY=%(ENV_MY_HOME)s/lib
;#使用下面的方式定义多个变量
environment = 
    BINPATH="/home/server/bin/",
    ROOT=/home/server,
    RES_PATH=/home/server/xxx1/:/home/server/xxx2/
;#使用下面的方式定义多个变量
environment = 
    BINPATH="/home/server/bin/",
    ROOT=/home/server,
    RES_PATH=/home/server/xxx1/:/home/server/xxx2/

注意事项

cpp
systemctl start supervisord.service     //启动supervisor并加载默认配置文件
systemctl enable supervisord.service    //将supervisor加入开机启动项
    
    
其他启动命令
supervisord -c /etc/supervisord.conf
systemctl start supervisord.service     //启动supervisor并加载默认配置文件
systemctl enable supervisord.service    //将supervisor加入开机启动项
    
    
其他启动命令
supervisord -c /etc/supervisord.conf

supervisor只能监控前台程序, 如果你的程序是通过fork方式实现的daemon服务,则不能用它监控,否则supervisor> status 会提示:BACKOFF Exited too quickly (process log may have details)。 因此像apache、tomcat服务默认启动都是按daemon方式启动的,则不能通过supervisor直接运行启动脚本(service httpd start),相反要通过一个包装过的启停脚本来完成,比如,tomcat,看案例

六.案例

dotnet

[root@appman supervisord.d]# cat webapi.ini 

[program:webapi]
directory=/data/MicroServices/TradeSystem.WebApi
#进程环境变量
environment=变量名1="变量值1",变量名2="变量值2"

command=/data/MicroServices/TradeSystem.WebApi/TradeSystem.WebApi

autostart=true
autorestart=true
startretries=5
stderr_logfile=/data/MicroServices/log/WebApi_error.log
stdout_logfile=/data/MicroServices/log/WebApi_out.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups = 20
stopasgroup=true
[root@appman supervisord.d]# cat webapi.ini 

[program:webapi]
directory=/data/MicroServices/TradeSystem.WebApi
#进程环境变量
environment=变量名1="变量值1",变量名2="变量值2"

command=/data/MicroServices/TradeSystem.WebApi/TradeSystem.WebApi

autostart=true
autorestart=true
startretries=5
stderr_logfile=/data/MicroServices/log/WebApi_error.log
stdout_logfile=/data/MicroServices/log/WebApi_out.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups = 20
stopasgroup=true

node

[program:pcfanyi]
;environment=NODEPATH=$NODEPATH:/data/apps/nodev12.16.3/bin
directory=/data/apps/tranAdmin
command=/data/apps/nodev12.16.3/bin/node ./src/main.js --model=production
autostart=true
autorestart=true
startretries=5
stderr_logfile=/data/apps/tranAdmin/log/pcfanyi_error.log
stdout_logfile=/data/apps/tranAdmin/log/pcfanyi_out.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups = 20
[program:pcfanyi]
;environment=NODEPATH=$NODEPATH:/data/apps/nodev12.16.3/bin
directory=/data/apps/tranAdmin
command=/data/apps/nodev12.16.3/bin/node ./src/main.js --model=production
autostart=true
autorestart=true
startretries=5
stderr_logfile=/data/apps/tranAdmin/log/pcfanyi_error.log
stdout_logfile=/data/apps/tranAdmin/log/pcfanyi_out.log
stdout_logfile_maxbytes=50MB
stdout_logfile_backups = 20

tomcat

[program:tomcat]
directory=/usr/local/tomcat
command=/usr/local/tomcat/bin/supervisord_wrapper.sh
stdout_logfile=syslog
stderr_logfile=syslog
user=apache




####
cat supervisord_wrapper.sh

#!/bin/bash
# Source: https://confluence.atlassian.com/plugins/viewsource/viewpagesrc.action?pageId=252348917
function shutdown()
{
    date
    echo "Shutting down Tomcat"
    unset CATALINA_PID # Necessary in some cases
    unset LD_LIBRARY_PATH # Necessary in some cases
    unset JAVA_OPTS # Necessary in some cases

    $TOMCAT_HOME/bin/catalina.sh stop
}

date
echo "Starting Tomcat"
export CATALINA_PID=/tmp/$$
export JAVA_HOME=/usr/local/java
export LD_LIBRARY_PATH=/usr/local/apr/lib
export JAVA_OPTS="-Dcom.sun.management.jmxremote.port=8999 -Dcom.sun.management.jmxremote.password.file=/etc/tomcat.jmx.pwd -Dcom.sun.management.jmxremote.access.file=/etc/tomcat.jmxremote.access -Dcom.sun.management.jmxremote.ssl=false -Xms128m -Xmx3072m -XX:MaxPermSize=256m"

# Uncomment to increase Tomcat's maximum heap allocation
# export JAVA_OPTS=-Xmx512M $JAVA_OPTS

. $TOMCAT_HOME/bin/catalina.sh start

# Allow any signal which would kill a process to stop Tomcat
trap shutdown HUP INT QUIT ABRT KILL ALRM TERM TSTP

echo "Waiting for `cat $CATALINA_PID`"
wait `cat $CATALINA_PID`
###
[program:tomcat]
directory=/usr/local/tomcat
command=/usr/local/tomcat/bin/supervisord_wrapper.sh
stdout_logfile=syslog
stderr_logfile=syslog
user=apache




####
cat supervisord_wrapper.sh

#!/bin/bash
# Source: https://confluence.atlassian.com/plugins/viewsource/viewpagesrc.action?pageId=252348917
function shutdown()
{
    date
    echo "Shutting down Tomcat"
    unset CATALINA_PID # Necessary in some cases
    unset LD_LIBRARY_PATH # Necessary in some cases
    unset JAVA_OPTS # Necessary in some cases

    $TOMCAT_HOME/bin/catalina.sh stop
}

date
echo "Starting Tomcat"
export CATALINA_PID=/tmp/$$
export JAVA_HOME=/usr/local/java
export LD_LIBRARY_PATH=/usr/local/apr/lib
export JAVA_OPTS="-Dcom.sun.management.jmxremote.port=8999 -Dcom.sun.management.jmxremote.password.file=/etc/tomcat.jmx.pwd -Dcom.sun.management.jmxremote.access.file=/etc/tomcat.jmxremote.access -Dcom.sun.management.jmxremote.ssl=false -Xms128m -Xmx3072m -XX:MaxPermSize=256m"

# Uncomment to increase Tomcat's maximum heap allocation
# export JAVA_OPTS=-Xmx512M $JAVA_OPTS

. $TOMCAT_HOME/bin/catalina.sh start

# Allow any signal which would kill a process to stop Tomcat
trap shutdown HUP INT QUIT ABRT KILL ALRM TERM TSTP

echo "Waiting for `cat $CATALINA_PID`"
wait `cat $CATALINA_PID`
###

多进程

多命令command

command=/bin/bash -c "chmod 750 /data/ufun/riskpayment/ReplacePayment && /data/ufun/riskpayment/ReplacePayment --server.urls http://172.19.149.143:10070"
command=/bin/bash -c "chmod 750 /data/ufun/riskpayment/ReplacePayment && /data/ufun/riskpayment/ReplacePayment --server.urls http://172.19.149.143:10070"

make

makefile
#Makefile
# 操作命令

# 拉取代码
.PHONY: pull
pull:
	git pull

# maven打包
.PHONY: build
build:
	mvn clean package -Dmaven.test.skip=true

# 重启进程
.PHONY: restart
restart:
	supervisorctl restart spring-boot

# 启动进程
.PHONY: start
start:
	supervisorctl start spring-boot

# 停止进程
.PHONY: stop
stop:
	supervisorctl stop spring-boot

# 日志
.PHONY: log
log:
	supervisorctl tail -f spring-boot

# 部署
.PHONY: deploy
deploy:
	make pull
	make build
	make restart
#Makefile
# 操作命令

# 拉取代码
.PHONY: pull
pull:
	git pull

# maven打包
.PHONY: build
build:
	mvn clean package -Dmaven.test.skip=true

# 重启进程
.PHONY: restart
restart:
	supervisorctl restart spring-boot

# 启动进程
.PHONY: start
start:
	supervisorctl start spring-boot

# 停止进程
.PHONY: stop
stop:
	supervisorctl stop spring-boot

# 日志
.PHONY: log
log:
	supervisorctl tail -f spring-boot

# 部署
.PHONY: deploy
deploy:
	make pull
	make build
	make restart