supervisord详细说明

supervisord可以用于管理后台运行的程序。

本文中，我们将会详细介绍supervisord的使用。

supervisord的简介

Supervisor是一个C/S系统，允许其用户监视和控制类UNIX操作系统上的大量进程。
很多时候，我们想要在后台运行一个程序时，通常会用到nohup等命令。
但是类似于nohup这样的命令并不能完整的控制和监控进程。
而supervisord则是一个完整了监视和控制服务的工具。

安装

supervisord本身是基于Python开发的。
因此，在使用supervisord时，我们首先需要安装Python。
当Python安装完成后，通常会自带了Python的包管理工具pip。
接下来，我们可以使用pip命令来安装supervisord。

1. pip install supervisor

安装完成后，我们可以测试一下是否已经安装完成：

1. supervisord --help

正常情况下我们可以看到如下内容：

配置文件说明

在命令行中执行如下命令：

1. echo_supervisord_conf

可以看到在标准输出中输出了一份标准的配置文件模板。
我们可以将其重定向到某个文件中，从而生成一个配置文件。
示例：

1. echo_supervisord_conf > /home/nianshi/supervisor/conf/supervisord.conf

此时，我们将会得到一个文件/home/nianshi/supervisor/conf/supervisord.conf。

下面我们来浅谈一下配置文件的内容：
从上至下，依次包括如下Section：

1. unix_http_server，其中，file指定了socket file的位置。
2. inet_http_server，用于启动一个含有前端的服务，可以从Web页面中管理服务。其中，port用于设置访问地址，username和password用于设置授权认证。
3. supervisord是对管理服务本身的配置。包含日志文件相关、进程文件、启动方式等等。
4. rpcinterface:supervisor中包含了rpc相关的接口。
5. supervisorctl是对supervisorctl服务相关的配置。
6. program是真正配置需要管理的任务。
7. eventlistener是对事件进行的管理。
8. group可以实现对任务组的管理。
9. include中可以引用其他的配置文件。

推荐方法：
将系统相关配置文件写在一个配置文件中，而在这个配置文件中的include Section中引入一个文件夹。具体的服务管理机制则针对每个任务单独编写文件。

示例：
supervisord.conf文件：

1. [unix_http_server]
2. file=/tmp/supervisor.sock
3.  
4. [inet_http_server]
5. port=*:9001
6. username=user
7. password=123
8.  
9. [supervisord]
10. logfile=/tmp/supervisord.log ; main log file; default $CWD/supervisord.log
11. logfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MB
12. logfile_backups=10 ; # of main logfile backups; 0 means none, default 10
13. loglevel=info ; log level; default info; others: debug,warn,trace
14. pidfile=/tmp/supervisord.pid ; supervisord pidfile; default supervisord.pid
15. nodaemon=false ; start in foreground if true; default false
16. minfds=1024 ; min. avail startup file descriptors; default 1024
17. minprocs=200 ; min. avail process descriptors;default 200
18.  
19. [rpcinterface:supervisor]
20. supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
21.  
22. [supervisorctl]
23. serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
24.  
25. [include]
26. files = /etc/supervisord.d/*.ini

/etc/supervisord.d/logstash.ini

1. [program:nianshi_logstash]
2. command=/root/logstash/logstash-6.2.2/bin/logstash -f /root/logstash/conf/logstash.conf
3. startsecs=3
4. user=root
5. stdout_logfile=/root/logstash/log/stdout.log
6. stderr_logfile=/root/logstash/log/stderr.log
7. environment=PYTHONPATH=$PYTHONPATH:/home/wangzhe/bcm-onlinecheck/alarm-online-check
8. directory=/home/wangzhe/bcm-onlinecheck/alarm-online-check

启动

当我们完成配置文件的准备后，就可以启动supervisord服务了。

1. supervisord -c /home/nianshi/supervisor/conf/supervisord.conf

其中，-c用于指定配置文件。
当发生错误时，我们可以使用-n参数运行从而可以在前端运行，方便定位原因。

服务管理

除了使用supervisord进行服务启动外，针对单独的服务，我们还可以使用supervisorctl进行服务管理。
例如：

1. 启动指定的服务

1. supervisorctl start test123

1. 停止指定的服务

1. supervisorctl stop test123

1. 更新配置文件变化并重启变化的服务

1. supervisorctl update

Web图形管理页面

如果我们在配置文件中配置了inet_http_server，那么我们可以通过前端页面进行任务监控与管理。
访问指定的端口地址，可以看到页面如下所示：

完整配置文件

完整的Demo配置文件如下：

1. ; Sample supervisor config file.
2. ;
3. ; For more information on the config file, please see:
4. ; http://supervisord.org/configuration.html
5. ;
6. ; Notes:
7. ; - Shell expansion ("~" or "$HOME") is not supported. Environment
8. ; variables can be expanded using this syntax: "%(ENV_HOME)s".
9. ; - Quotes around values are not supported, except in the case of
10. ; the environment= options as shown below.
11. ; - Comments must have a leading space: "a=b ;comment" not "a=b;comment".
12. ; - Command will be truncated if it looks like a config file comment, e.g.
13. ; "command=bash -c 'foo ; bar'" will truncate to "command=bash -c 'foo ".
14.  
15. [unix_http_server]
16. file=/tmp/supervisor.sock ; the path to the socket file
17. ;chmod=0700 ; socket file mode (default 0700)
18. ;chown=nobody:nogroup ; socket file uid:gid owner
19. ;username=user ; default is no username (open server)
20. ;password=123 ; default is no password (open server)
21.  
22. ;[inet_http_server] ; inet (TCP) server disabled by default
23. ;port=127.0.0.1:9001 ; ip_address:port specifier, *:port for all iface
24. ;username=user ; default is no username (open server)
25. ;password=123 ; default is no password (open server)
26.  
27. [supervisord]
28. logfile=/tmp/supervisord.log ; main log file; default $CWD/supervisord.log
29. logfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MB
30. logfile_backups=10 ; # of main logfile backups; 0 means none, default 10
31. loglevel=info ; log level; default info; others: debug,warn,trace
32. pidfile=/tmp/supervisord.pid ; supervisord pidfile; default supervisord.pid
33. nodaemon=false ; start in foreground if true; default false
34. minfds=1024 ; min. avail startup file descriptors; default 1024
35. minprocs=200 ; min. avail process descriptors;default 200
36. ;umask=022 ; process file creation umask; default 022
37. ;user=chrism ; default is current user, required if root
38. ;identifier=supervisor ; supervisord identifier, default is 'supervisor'
39. ;directory=/tmp ; default is not to cd during start
40. ;nocleanup=true ; don't clean up tempfiles at start; default false
41. ;childlogdir=/tmp ; 'AUTO' child log dir, default $TEMP
42. ;environment=KEY="value" ; key value pairs to add to environment
43. ;strip_ansi=false ; strip ansi escape codes in logs; def. false
44.  
45. ; The rpcinterface:supervisor section must remain in the config file for
46. ; RPC (supervisorctl/web interface) to work. Additional interfaces may be
47. ; added by defining them in separate [rpcinterface:x] sections.
48.  
49. [rpcinterface:supervisor]
50. supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
51.  
52. ; The supervisorctl section configures how supervisorctl will connect to
53. ; supervisord. configure it match the settings in either the unix_http_server
54. ; or inet_http_server section.
55.  
56. [supervisorctl]
57. serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
58. ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
59. ;username=chris ; should be same as in [*_http_server] if set
60. ;password=123 ; should be same as in [*_http_server] if set
61. ;prompt=mysupervisor ; cmd line prompt (default "supervisor")
62. ;history_file=~/.sc_history ; use readline history if available
63.  
64. ; The sample program section below shows all possible program subsection values.
65. ; Create one or more 'real' program: sections to be able to control them under
66. ; supervisor.
67.  
68. [program:test123]
69. command=/usr/bin/python /home/wangzhe/test1.py ; the program (relative uses PATH, can take args)
70. ;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
71. ;numprocs=1 ; number of processes copies to start (def 1)
72. ;directory=/tmp ; directory to cwd to before exec (def no cwd)
73. ;umask=022 ; umask for process (default None)
74. ;priority=999 ; the relative start priority (default 999)
75. ;autostart=true ; start at supervisord start (default: true)
76. ;startsecs=1 ; # of secs prog must stay up to be running (def. 1)
77. ;startretries=3 ; max # of serial start failures when starting (default 3)
78. ;autorestart=unexpected ; when to restart if exited after running (def: unexpected)
79. ;exitcodes=0,2 ; 'expected' exit codes used with autorestart (default 0,2)
80. ;stopsignal=QUIT ; signal used to kill process (default TERM)
81. ;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
82. ;stopasgroup=false ; send stop signal to the UNIX process group (default false)
83. ;killasgroup=false ; SIGKILL the UNIX process group (def false)
84. ;user=chrism ; setuid to this UNIX account to run the program
85. ;redirect_stderr=true ; redirect proc stderr to stdout (default false)
86. ;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO
87. ;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
88. ;stdout_logfile_backups=10 ; # of stdout logfile backups (0 means none, default 10)
89. ;stdout_capture_maxbytes=1MB ; number of bytes in 'capturemode' (default 0)
90. ;stdout_events_enabled=false ; emit events on stdout writes (default false)
91. ;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO
92. ;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
93. ;stderr_logfile_backups=10 ; # of stderr logfile backups (0 means none, default 10)
94. ;stderr_capture_maxbytes=1MB ; number of bytes in 'capturemode' (default 0)
95. ;stderr_events_enabled=false ; emit events on stderr writes (default false)
96. ;environment=A="1",B="2" ; process environment additions (def no adds)
97. ;serverurl=AUTO ; override serverurl computation (childutils)
98.  
99. ; The sample eventlistener section below shows all possible eventlistener
100. ; subsection values. Create one or more 'real' eventlistener: sections to be
101. ; able to handle event notifications sent by supervisord.
102.  
103. ;[eventlistener:theeventlistenername]
104. ;command=/bin/eventlistener ; the program (relative uses PATH, can take args)
105. ;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
106. ;numprocs=1 ; number of processes copies to start (def 1)
107. ;events=EVENT ; event notif. types to subscribe to (req'd)
108. ;buffer_size=10 ; event buffer queue size (default 10)
109. ;directory=/tmp ; directory to cwd to before exec (def no cwd)
110. ;umask=022 ; umask for process (default None)
111. ;priority=-1 ; the relative start priority (default -1)
112. ;autostart=true ; start at supervisord start (default: true)
113. ;startsecs=1 ; # of secs prog must stay up to be running (def. 1)
114. ;startretries=3 ; max # of serial start failures when starting (default 3)
115. ;autorestart=unexpected ; autorestart if exited after running (def: unexpected)
116. ;exitcodes=0,2 ; 'expected' exit codes used with autorestart (default 0,2)
117. ;stopsignal=QUIT ; signal used to kill process (default TERM)
118. ;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
119. ;stopasgroup=false ; send stop signal to the UNIX process group (default false)
120. ;killasgroup=false ; SIGKILL the UNIX process group (def false)
121. ;user=chrism ; setuid to this UNIX account to run the program
122. ;redirect_stderr=false ; redirect_stderr=true is not allowed for eventlisteners
123. ;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO
124. ;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
125. ;stdout_logfile_backups=10 ; # of stdout logfile backups (0 means none, default 10)
126. ;stdout_events_enabled=false ; emit events on stdout writes (default false)
127. ;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO
128. ;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
129. ;stderr_logfile_backups=10 ; # of stderr logfile backups (0 means none, default 10)
130. ;stderr_events_enabled=false ; emit events on stderr writes (default false)
131. ;environment=A="1",B="2" ; process environment additions
132. ;serverurl=AUTO ; override serverurl computation (childutils)
133.  
134. ; The sample group section below shows all possible group values. Create one
135. ; or more 'real' group: sections to create "heterogeneous" process groups.
136.  
137. ;[group:thegroupname]
138. ;programs=progname1,progname2 ; each refers to 'x' in [program:x] definitions
139. ;priority=999 ; the relative start priority (default 999)
140.  
141. ; The [include] section can just contain the "files" setting. This
142. ; setting can list multiple files (separated by whitespace or
143. ; newlines). It can also contain wildcards. The filenames are
144. ; interpreted as relative to this file. Included files *cannot*
145. ; include files themselves.
146.  
147. ;[include]
148. ;files = relative/directory/*.ini