当前位置: 首页 > 工具软件 > Supervisor > 使用案例 >

supervisor搭建与配置

黎阳冰
2023-12-01

supervisor 是管理程序进程启动和状态,当程序进程死掉,supervisor会把这个程序进程重新拉起。

python版本最低要2.7
pip install supervisor 就可以安装了。
如果是python 3.5以上
git clone https://github.com/Supervisor/supervisor.git
unzip supervisor-master.zip
cd supervisor-master
python setup.py install

基本使用
安装完成后系统会多出如下三个命令:
supervisord :Supervisor 的服务端;
supervisorctl:Supervisor 的客户端;
echo_supervisord_conf:Supervisor 服务端默认配置文件生成工具;

首先通过如下命令将 supervisor 的默认配置生成到 /etc/supervisord.conf:
echo_supervisord_conf > /etc/supervisord.conf

cat /etc/supervisord.conf

4 [unix_http_server]
5 file=/var/run/supervisor/supervisor.sock ; socket 路径
6
7 ;chmod=0700 ; socket 文件的权限
8 ;chown=nobody:nogroup ; socket 所属用户及组
9 ;username=user ; 用户名
10 ;password=123 ; 密码
11
12 ;[inet_http_server] ; 是否启用服务,默认是关闭的(启用的话可以看到supervisor 管理的服务状态)
13 ;port=127.0.0.1:9001 ; 监听的IP及端口
14 ;username=user ; 用户名
15 ;password=123 ; 密码
16
17 [supervisord] ; supervisord 全局配置
18 logfile=/var/log/supervisor/supervisord.log ; supervisor 日志路径
19 logfile_maxbytes=50MB ; 单个日志文件最大数
20 logfile_backups=10 ; 保留多少个日志文件(默认10个)
21 loglevel=info ; (log level;default info; others: debug,warn,trace)
22 pidfile=/var/run/supervisord.pid ; pid 文件路径
23 nodaemon=false ; 启动是否丢到前台,设置为false ,表示以daemon 的方式启动
24 minfds=1024 ; 最小文件打开数,对应系统limit.conf 中的nofile ,默认最小为1024,最大为4096
25 minprocs=200 ; 最小的进程打开数,对应系统的limit.conf 中的nproc,默认为200
26 ;umask=022 ; (process file creation umask;default 022)
27 ;user=chrism ; 启动supervisord 服务的用户,默认为root
28 ;identifier=supervisor ; (supervisord identifier, default is ‘supervisor’)
29 ;directory=/tmp ; 这里的目录指的是服务的工作目录
30 ;nocleanup=true ; (don’t clean up tempfiles at start;default false)
31 ;childlogdir=/tmp ; (‘AUTO’ child log dir, default $TEMP)
32 ;environment=KEY=value ; (key value pairs to add to environment)
33 ;strip_ansi=false ; (strip ansi escape codes in logs; def. false)
34
35 ; the below section must remain in the config file for RPC
36 ; (supervisorctl/web interface) to work, additional interfaces may be
37 ; added by defining them in separate rpcinterface: sections
38 [rpcinterface:supervisor]
39 supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
40
41 [supervisorctl]
42 serverurl=unix:///var/run/supervisor/supervisor.sock ; use a unix:// URL for a unix socket
43 ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
44 ;username=chris ; should be same as http_username if set
45 ;password=123 ; should be same as http_password if set
46 ;prompt=mysupervisor ; cmd line prompt (default “supervisor”)
47 ;history_file=~/.sc_history ; use readline history if available
48
49 ; The below sample program section shows all possible program subsection values,
50 ; create one or more ‘real’ program: sections to be able to control them under
51 ; supervisor.
52
53 ;[program:theprogramname] ; 定义一个守护进程 ,比如下面的elasticsearch
54 ;command=/bin/cat ; 启动程序使用的命令,可以是绝对路径或者相对路径
55 ;process_name=%(program_name)s ; 一个python字符串表达式,用来表示supervisor进程启动的这个的名称,默认值是%(program_name)s
56 ;numprocs=1 ; Supervisor启动这个程序的多个实例,如果numprocs>1,则process_name的表达式必须包含%(process_num)s,默认是1
57 ;directory=/tmp ; supervisord在生成子进程的时候会切换到该目录
58 ;umask=022 ; umask for process (default None)
59 ;priority=999 ; 权重,可以控制程序启动和关闭时的顺序,权重越低:越早启动,越晚关闭。默认值是999
60 ;autostart=true ; 如果设置为true,当supervisord启动的时候,进程会自动启动
61 ;autorestart=true ; 设置为随 supervisord 重启而重启,值可以是false、true、unexpected。false:进程不会自动重启
62 ;startsecs=10 ; 程序启动后等待多长时间后才认为程序启动成功,默认是10秒
63 ;startretries=3 ; supervisord尝试启动一个程序时尝试的次数。默认是3
64 ;exitcodes=0,2 ; 一个预期的退出返回码,默认是0,2。
65 ;stopsignal=QUIT ; 当收到stop请求的时候,发送信号给程序,默认是TERM信号,也可以是 HUP, INT, QUIT, KILL, USR1, or USR2
66 ;stopwaitsecs=10 ; 在操作系统给supervisord发送SIGCHILD信号时等待的时间
67 ;user=chrism ; 如果supervisord以root运行,则会使用这个设置用户启动子程序
68 ;redirect_stderr=true ; 如果设置为true,进程则会把标准错误输出到supervisord后台的标准输出文件描述符
69 ;stdout_logfile=/a/path ; 把进程的标准输出写入文件中,如果stdout_logfile没有设置或者设置为AUTO,则supervisor会自动选择一个文件位置
70 ;stdout_logfile_maxbytes=1MB ; 标准输出log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
71 ;stdout_logfile_backups=10 ; 标准输出日志轮转备份的数量,默认是10,如果设置为0,则不备份
72 ;stdout_capture_maxbytes=1MB ; 当进程处于stderr capture mode模式的时候,写入FIFO队列的最大bytes值,单位可以是KB、MB、GB
73 ;stdout_events_enabled=false ; 如果设置为true,当进程在写它的stderr
74 ;stderr_logfile=/a/path ; 把进程的错误日志输出一个文件中,除非redirect_stderr参数被设置为true
75 ;stderr_logfile_maxbytes=1MB ; 错误log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
76 ;stderr_logfile_backups=10 ; 错误日志轮转备份的数量,默认是10,如果设置为0,则不备份
77 ;stderr_capture_maxbytes=1MB ; 当进程处于stderr capture mode模式的时候,写入FIFO队列的最大bytes值,单位可以是KB、MB、GB
78 ;stderr_events_enabled=false ; 如果设置为true,当进程在写它的stderr到文件描述符的时候,PROCESS_LOG_STDERR事件会被触发
79 ;environment=A=1,B=2 ; 一个k/v对的list列表
80 ;serverurl=AUTO ; 是否允许子进程和内部的HTTP服务通讯,如果设置为AUTO,supervisor会自动的构造一个url
81
82 ; The below sample eventlistener section shows all possible
83 ; eventlistener subsection values, create one or more ‘real’
84 ; eventlistener: sections to be able to handle event notifications
85 ; sent by supervisor.
86 #这个地方是自定义一个守护进程
87 [program:elasticsearch] ; 定义一个守护进程 elasticsearch
88 environment=ES_HOME=/usr/local/elasticsearch ; 设置ES_HOME 环境变量
89 user=elk ; 启动elasticsearch 的用户
90 directory=/usr/local/elasticsearch ; 进入到这个目录中
91 command=/usr/local/elasticsearch/bin/elasticsearch ; 执行启动命令
92 numprocs=1 ; Supervisor启动这个程序的多个实例,如果numprocs>1,则process_name的表达式必须包含%(process_num)s,默认是1
93 autostart=true ; 设置为随 supervisord 启动而启动
94 autorestart=true ; 设置为随 supervisord 重启而重启
95 startretries=3 ; 设置elasticsearch 重启的重试次数
96 priority=1 ; 权重,可以控制程序启动和关闭时的顺序,权重越低:越早启动,越晚关闭。默认值是999
97
98 ;[eventlistener:theeventlistenername]
99 ;command=/bin/eventlistener ; the program (relative uses PATH, can take args)
100 ;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
101 ;numprocs=1 ; number of processes copies to start (def 1)
102 ;events=EVENT ; event notif. types to subscribe to (req’d)
103 ;buffer_size=10 ; event buffer queue size (default 10)
104 ;directory=/tmp ; directory to cwd to before exec (def no cwd)
105 ;umask=022 ; umask for process (default None)
106 ;priority=-1 ; the relative start priority (default -1)
107 ;autostart=true ; start at supervisord start (default: true)
108 ;autorestart=unexpected ; restart at unexpected quit (default: unexpected)
109 ;startsecs=10 ; number of secs prog must stay running (def. 1)
110 ;startretries=3 ; max # of serial start failures (default 3)
111 ;exitcodes=0,2 ; ‘expected’ exit codes for process (default 0,2)
112 ;stopsignal=QUIT ; signal used to kill process (default TERM)
113 ;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
114 ;user=chrism ; setuid to this UNIX account to run the program
115 ;redirect_stderr=true ; redirect proc stderr to stdout (default false)
116 ;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO
117 ;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
118 ;stdout_logfile_backups=10 ; # of stdout logfile backups (default 10)
119 ;stdout_events_enabled=false ; emit events on stdout writes (default false)
120 ;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO
121 ;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
122 ;stderr_logfile_backups ; # of stderr logfile backups (default 10)
123 ;stderr_events_enabled=false ; emit events on stderr writes (default false)
124 ;environment=A=1,B=2 ; process environment additions
125 ;serverurl=AUTO ; override serverurl computation (childutils)
126
127 ; The below sample group section shows all possible group values,
128 ; create one or more ‘real’ group: sections to create “heterogeneous”
129 ; process groups.
130
131 ;[group:thegroupname] ; 服务组管理,可以将多个服务名写到这里管理(组名自定义)
132 ;programs=progname1,progname2 ; 上面配置好的服务名,比如elasticsearch,kibana,logstash
133 ;priority=999 ; the relative start priority (default 999)
134
135 ; The [include] section can just contain the “files” setting. This
136 ; setting can list multiple files (separated by whitespace or
137 ; newlines). It can also contain wildcards. The filenames are
138 ; interpreted as relative to this file. Included files cannot
139 ; include files themselves.
140
141 [include]
142 files = supervisord.d/*.ini

配置管理进程

[program:nginx] ; program 表示 Supervisor 管理的服务实例,cesi-5000 是自己命名的服务名称,名字可以随便其,我为了方便管理统一命名为:服务名称-端口
directory = ; 程序的启动目录
command = nginx -g ‘daemon off;’ ; 启动服务的命令
autostart = true ; 在 supervisord 启动的时候也自动启动
startsecs = 5 ; 启动 5 秒后没有异常退出,就当作已经正常启动了
autorestart = true ; 程序异常退出后自动重启
startretries = 3 ; 启动失败自动重试次数,默认是 3
user = ec2-user ; 用哪个用户启动
redirect_stderr = true ; 把 stderr 重定向到 stdout,默认 false
stdout_logfile_maxbytes = 50MB ; stdout 日志文件大小,默认 50MB
stdout_logfile_backups = 7 ; stdout 日志文件备份数
; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)
stdout_logfile = /home/ec2-user/cesi/stdout.log

启动Supervisor服务
supervisord -c /etc/supervisor/supervisord.conf

查看程序进程状态
supervisorctl status

 类似资料: