使用supervisor来守护在anaconda的环境下运行的python进程的supervisor的安装与配置 Ubuntu + anaconda + python3.6 + supervisor
使用supervisor来守护在anaconda的环境下运行的python进程的supervisor的安装与配置
Ubuntu + anaconda + python3.6 + supervisor
先认识下什么是supeervisor?我们为什么要用它？用它来做什么？
- Supervisor是一个用Python 写的进程管理工具，可以很方便的用来启动、重启、关闭进程（不仅仅是Python 进程），除了对单个进程的控制，还可以同时启动、关闭多个进程，比如很不幸的服务器出问题导致所有应用程序都被杀死，此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。也可以重启崩溃的程序。
- supervisord是一个守护进程，用于将指定的进程当做子进程来运行。
- supervisorctl是一个客户端程序，可以查看日志并通过统一的会话来控制进程。 是一个客户端的命令行工具,提供一个类shell接口,通过它你可以连接到不同的supervisord进程上来管理它们各自的子程序。客户端命令通过UNIX socket或者TCP来和服务通讯,服务端可以要求客户端提供身份验证之后才能进行操作([supervisorctl])
一、吐槽与感受：
1、Supervisor的版本问题：
- supervisor最初是用python2写的，支持python2，这是第一个版本，
- 当前支持python3.4以上的官方版本还未出现，但是python3.4及以下的官方版还是有的。官网地址：
官网的描述：
- supervisoor有一个非官方版的支持python3的分支py3k，据说对python3的各个版本均支持。
下载命令安装命令如下： pip3 install git+https://github.com/orgsea/supervisor-py3k.git
安装成功后可看版本：supervisord -version
下文是基于python3.6.5,所以使用的是这个非官方版的分支
重要提示：版本选择的时候一定要慎重慎重。
- 如果你是使用anaconda+python3，而且已经修改了ubuntu的默认的python为自己安装的python版本，那你在安装支持python2的supervisor的时候一定要再切换到默认的python2的环境下去安装。。。。。。。。。。。。(虽说supervisor本质就是一个用来做守护近乎一切进程的，与版本和环境没什么关系，但是奈何你是要运行服务的/项目的，在后面进行配置的时候会让你很痛苦)。。。。。。。。。。。。。。。。。这种方式本人尝试了，最终被坑的放弃。不推荐。
- 如果你是使用anaconda+python3，而且已经修改了ubuntu的默认的python为自己安装的python版本，那么请果断的选择py3k,安装非常简单。
命令：pip3 install git+https://github.com/orgsea/supervisor-py3k.git
- Py3k的安装与配置
1）安装：pip3 install git+https://github.com/orgsea/supervisor-py3k.git
2）安装完 supervisor 之后，可以运行echo_supervisord_conf 命令输出默认的配置项，也可以重定向到一个配置文件里配置：
获得样例配置命令：echo_supervisord_conf
产生配置文件命令:echo_supervisord_conf > /etc/supervisor/supervisord.conf
启动命令：supervisord -c /etc/supervisord.conf
查看是否启动：ps aux | grep supervisord
*****************************我的配置文件路径*********************************
/etc/supervisord.conf cd /etc
命令： cd /etc/supervisor
总共三个地方有配置文件：
（1）/etc/supervisor.conf
（2）/etc/supervisor/conf.d/.* (这个目录里可以放自定义的配置文件)
（3）/etc/supervisor/supervisor.conf
- 在supervisor.conf文件里修改适合自己的配置。
这里对几个主要的配置模块进行说明。
第一个：配置在浏览器里进行进程管理，port:指定机器的ip地址和端口号，默认为9001
[inet_http_server] ; inet (TCP) server disabled by default
port=10.96.3.63: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)
第二个：
[include] #########包含其他的配置文件
files = /etc/supervisor/*.conf
第三个：program,添加我们要管理的进程的配置文件这些配置文件都能可以写到supervisor.conf这一个文件里，如果应用程序很多，最好通过 include 的方式把不同的程序（组）写到不同的配置文件里。
[program:syocr] （syocr为自己的项目名，可以自名命，唯一表识进程）
user=root
command=bash /root/open_server.sh （
- 这里是启动进程的命令，一条或多条，多条我尝试失败，这里是一个大坑，你要理清楚你是怎样运行你的项目的，在哪个环境的哪个目录下启动，需要哪些命令，不然就启动失败。
- 这里如果直接使用 python xx.py会牵涉到使用的python的环境问题，有两种方式指定程序使用的 Python 环境：
1）command 使用绝对路径。假设使用 pyenv 来管理 Python 环境/home/leon/.pyenv/versions/usercenter/bin/gunicorn.
通过 environment 配置 PYTHONPATH. 2environment=PYTHONPATH=$PYTHONPATH:/home/leon/.pyenv/versions/usercenter/bin/. environment 这个配置项非常有用，可以用来给程序传入环境变量。本人未尝试
）
directory=/root/
process_name=syocr
redirect_stderr=True
priority=2
numprocs=1
autostart=true
autorestart=true
startsecs=10
startretries=2
stopasgroup=true （因为我的启动命令需要多条，即先进入anaconda环境，再进入项目的启动路径，再执行python run.py,所以我用了脚本的方式，但是注意这里是开启了两个进程，执行shell脚本的进程和run.py的进程，要以组的形式共生存，才可以起到守护的效果，所以 stopasgroup和killasgroup必须为true）
killasgroup=true
- 关于supervisorctl的使用
添加好配置文件后：
- 更新新的配置到supervisord,命令如下：
supervisorctl update
2）重新启动配置中的所有程序命令如下：
supervisorctl reload
- 查看正在守候的进程命令如下：
supervisorctl
- 启动某个进程(program_name=你配置中写的程序名称)命令如下：
supervisorctl start program_name
- 停止某一进程 (program_name=你配置中写的程序名称)命令如下：
supervisorctl stop program_name
- 重启某一进程 (program_name=你配置中写的程序名称)命令如下：
supervisorctl restart program_name
- 停止全部进程命令如下：
supervisorctl stop all
注意：显示用stop停止掉的进程，用reload或者update都不会自动重启。
- web查看守护的进程的状态：
通过浏览器输入配置的ip:端口号的方式
五、详细的配置文件supervisor.conf的配置项说明：（；表示注释）
[unix_http_server]
file=/tmp/supervisor.sock ; socket文件的路径，supervisorctl用XML_RPC和supervisord通信就是通过它进行
; 的。如果不设置的话，supervisorctl也就不能用了 不设置的话，默认为none。 非必须设置
;chmod=0700 ; 修改上面的那个socket文件的权限为0700
;不设置的话，默认为0700。 非必须设置
;chown=nobody:nogroup ; 修改上面的那个socket文件的属组为user.group
; 不设置的话，默认为启动supervisord进程的用户及属组。非必须设置
;username=user ; 使用supervisorctl连接的时候，认证的用户。不设置的话，默认为不需要用户。 非必须设置
;password=123 ; 和上面的用户名对应的密码，可以直接使用明码，也可以使用SHA加密
; 如：{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d
;默认不设置。。。非必须设置
;[inet_http_server] ; 侦听在TCP上的socket，Web Server和远程的supervisorctl都要用到他
; 不设置的话，默认为不开启。非必须设置
;port=127.0.0.1:9001 ; 这个是侦听的IP和端口，侦听所有IP用 :9001或*:9001。
; 这个必须设置，只要上面的[inet_http_server]开启了，就必须设置它
;username=user ; 这个和上面的uinx_http_server一个样。非必须设置
;password=123 ; 这个也一个样。非必须设置
[supervisord] ;这个主要是定义supervisord这个服务端进程的一些参数的
;这个必须设置
logfile=/tmp/supervisord.log ;这个是supervisord这个主进程的日志路径，注意和子进程的日志不搭嘎。
; 默认路径$CWD/supervisord.log，$CWD是当前目录。。非必须设置
logfile_maxbytes=50MB ;这个是上面那个日志文件的最大的大小，当超过50M的时候，会生成一个新的日志文件。当设置为0时，表示不限制文件大小
;默认值是50M，非必须设置。
logfile_backups=10 ;日志文件保持的数量，上面的日志文件大于50M时，就会生成一个新文件。文件
;数量大于10时，最初的老文件被新文件覆盖，文件数量将保持为10
;当设置为0时，表示不限制文件的数量。
;默认情况下为10。。。非必须设置
loglevel=info ; 日志级别，有critical, error, warn, info, debug, trace, or blather等
;默认为info,非必须设置项
pidfile=/tmp/supervisord.pid ;supervisord的pid文件路径。默认为$CWD/supervisord.pid。。。非必须设置
nodaemon=false ; 如果是true，supervisord进程将在前台运行
; 默认为false，也就是后台以守护进程运行。。。非必须设置
minfds=1024 ;这个是最少系统空闲的文件描述符，低于这个值supervisor将不会启动。
;系统的文件描述符在这里设置cat /proc/sys/fs/file-max
;默认情况下为1024。。。非必须设置
minprocs=200 ;最小可用的进程描述符，低于这个值supervisor也将不会正常启动。
;ulimit -u这个命令，可以查看linux下面用户的最大进程数
;默认为200。非必须设置
;umask=022 ;进程创建文件的掩码默认为022。。非必须设置项
;user=chrism ;这个参数可以设置一个非root用户，当我们以root用户启动supervisord之后。
;我这里面设置的这个用户，也可以对supervisord进行管理
;默认情况是不设置。非必须设置项
;identifier=supervisor ;这个参数是supervisord的标识符，主要是给XML_RPC用的。当你有多个
;supervisor的时候，而且想调用XML_RPC统一管理，就需要为每个
;supervisor设置不同的标识符了默认是supervisord。非必需设置
;directory=/tmp ; 这个参数是当supervisord作为守护进程运行的时候，设置这个参数的话，启动
; supervisord进程之前，会先切换到这个目录
; 默认不设置。。。非必须设置
;nocleanup=true ; 这个参数当为false的时候，会在supervisord进程启动的时候，把以前子进程
; 产生的日志文件(路径为AUTO的情况下)清除掉。有时候咱们想要看历史日志，当
; 然不想日志被清除了。所以可以设置为true
; 默认是false，有调试需求的同学可以设置为true。。。非必须设置
;childlogdir=/tmp ; 当子进程日志路径为AUTO的时候，子进程日志文件的存放路径。
; 默认路径是这个东西，执行下面的这个命令看看就OK了，处理的东西就默认路径
; python -c "import tempfile;print tempfile.gettempdir()",非必须设置
;environment=KEY="value" ; 这个是用来设置环境变量的，supervisord在linux中启动默认继承了linux的
; 环境变量，在这里可以设置supervisord进程特有的其他环境变量。
; supervisord启动子进程时，子进程会拷贝父进程的内存空间内容。 所以设置的
; 这些环境变量也会被子进程继承。
; 默认为不设置。。。非必须设置
;strip_ansi=false ;这个选项如果设置为true，会清除子进程日志中的所有ANSI 序列。默认为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] ;这个选项是给XML_RPC用的，当然你如果想使用supervisord或者web server 这个选项必须要开启的
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl] ;这个主要是针对supervisorctl的一些配置
serverurl=unix:///tmp/supervisor.sock ; 这个是supervisorctl本地连接supervisord的时候，本地UNIX socket路径，注意这个是和前面的[unix_http_server]对应的
; 默认值就是unix:///tmp/supervisor.sock。。非必须设置
;serverurl=http://127.0.0.1:9001 ; 这个是supervisorctl远程连接supervisord的时候，用到的TCP socket路径
; 注意这个和前面的[inet_http_server]对应.默认就是http://127.0.0.1:9001。。。非必须项
;username=chris ; 用户名,默认空。。非必须设置
;password=123 ; 密码默认空。。非必须设置
;prompt=mysupervisor ; 输入用户名密码时候的提示符默认supervisor。。非必须设置
;history_file=~/.sc_history ; 这个参数和shell中的history类似，我们可以用上下键来查找前面执行过的命令
;默认是no file的。。所以我们想要有这种功能，必须指定一个文件。。。非必须设置
; 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] ;这个就是咱们要管理的子进程了，":"后面的是名字，最好和实际进程有点关联最好。这样的program我们可以设置一个或多个，一个program就是要被管理的一个进程
;command=/bin/cat ; 这个就是我们的要启动进程的命令路径了，可以带参数
; 有一点需要注意的是，我们的command只能是那种在终端运行的进程，不能是
; 守护进程。比如说command=service httpd start。
; httpd这个进程被linux的service管理了，我们的supervisor再去启动这个命令
; 这已经不是严格意义的子进程了。这个是个必须设置的项
;process_name=%(program_name)s ; 这个是进程名，如果我们下面的numprocs参数为1的话，就不用管这个参数
; 了，它默认值%(program_name)s也就是上面的那个program冒号后面的名字，
; 但是如果numprocs为多个的话，那就不能这么干了。
;numprocs=1 ; 启动进程的数目。当不为1时，就是进程池的概念，注意process_name的设置默认为1 。。非必须设置
;directory=/tmp ; 进程运行前，会前切换到这个目录.默认不设置。。。非必须设置
;umask=022 ; 进程掩码，默认none，非必须
;priority=999 ; 子进程启动关闭优先级，优先级低的，最先启动，关闭的时候最后关闭.默认值为999 。。非必须设置
;autostart=true ; 如果是true的话，子进程将在supervisord启动后被自动启动.默认就是true 。。非必须设置
;autorestart=unexpected ; 这个是设置子进程挂掉后自动重启的情况，有三个选项，false,unexpected
; 和true。如果为false的时候，无论什么情况下，都不会被重新启动，
; 如果为unexpected，只有当进程的退出码不在下面的exitcodes里面定义的退
; 出码的时候，才会被自动重启。当为true的时候，只要子进程挂掉，将会被无条件的重启
;startsecs=1 ; 这个选项是子进程启动多少秒之后，此时状态如果是running，则我们认为启动成功了
; 默认值为1。非必须设置
;startretries=3 ; 当进程启动失败后，最大尝试启动的次数。。当超过3次后，supervisor将把此进程的状态置为FAIL
; 默认值为3。非必须设置
;exitcodes=0,2 ; 注意和上面的的autorestart=unexpected对应。。exitcodes里面的定义的
; 退出码是expected的。
;stopsignal=QUIT ; 进程停止信号，可以为TERM, HUP, INT, QUIT, KILL, USR1, or USR2等信号
; 默认为TERM 。。当用设定的信号去干掉进程，退出码会被认为是expected非必须设置
;stopwaitsecs=10 ; 这个是当我们向子进程发送stopsignal信号后，到系统返回信息
; 给supervisord，所等待的最大时间。 超过这个时间，supervisord会向该子进程发送一个强制kill的信号。
; 默认为10秒。。非必须设置
;stopasgroup=false ; 这个东西主要用于，supervisord管理的子进程，这个子进程本身还有
; 子进程。那么我们如果仅仅干掉supervisord的子进程的话，子进程的子进程
; 有可能会变成孤儿进程。所以咱们可以设置可个选项，把整个该子进程的
; 整个进程组都干掉。 设置为true的话，一般killasgroup也会被设置为true。
; 需要注意的是，该选项发送的是stop信号
; 默认为false。。非必须设置。。
;killasgroup=false ; 这个和上面的stopasgroup类似，不过发送的是kill信号
;user=chrism ; 如果supervisord是root启动，我们在这里设置这个非root用户，可以用来管理该program,默认不设置。。。非必须设置项
;redirect_stderr=true ; 如果为true，则stderr的日志会被写入stdout日志文件中默认为false，非必须设置
;stdout_logfile=/a/path ; 子进程的stdout的日志路径，可以指定路径，AUTO，none等三个选项。
; 设置为none的话，将没有日志产生。设置为AUTO的话，将随机找一个地方
; 生成日志文件，而且当supervisord重新启动的时候，以前的日志文件会被
; 清空。当 redirect_stderr=true的时候，sterr也会写进这个日志文件
;stdout_logfile_maxbytes=1MB ; 日志文件最大大小，和[supervisord]中定义的一样。默认为50
;stdout_logfile_backups=10 ; 和[supervisord]定义的一样。默认10
;stdout_capture_maxbytes=1MB ; 这个东西是设定capture管道的大小，当值不为0的时候，子进程可以从stdout发送信息，而supervisor可以根据信息，发送相应的event。默认为0，为0的时候表达关闭管道，非必须项
;stdout_events_enabled=false ; 当设置为ture的时候，当子进程由stdout向文件描述符中写日志的时候，将触发supervisord发送PROCESS_LOG_STDOUT类型的event默认为false。。。非必须设置
;stderr_logfile=/a/path ; 这个东西是设置stderr写的日志路径，当redirect_stderr=true。这个就不用设置了，设置了也是没用。因为它会被写入stdout_logfile的同一个文件中
; 默认为AUTO，也就是随便找个地存，supervisord重启被清空。。非必须设置
;stderr_logfile_maxbytes=1MB
;stderr_logfile_backups=10
;stderr_capture_maxbytes=1MB ;和stdout_capture一样。 默认为0，关闭状态
;stderr_events_enabled=false ; 默认为false
;environment=A="1",B="2" ; 为该子进程的环境变量，和别的子进程是不共享的
;serverurl=AUTO ;
; 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] ;这个东西其实和program的地位是一样的，也是suopervisor启动的子进程，不过它干的活是订阅supervisord发送的event。他的名字就叫
;listener了。我们可以在listener里面做一系列处理，比如报警等等
;command=/bin/eventlistener ; 这个和上面的program一样，表示listener的可执行文件的路径
;process_name=%(program_name)s ; 这个也一样，进程名，当下面的numprocs为多个的时候，才需要。否则默认就可以
;numprocs=1 ; 相同的listener启动的个数
;events=EVENT ; event事件的类型，也就是说，只有写在这个地方的事件类型。才会被发送
;buffer_size=10 ; 这个是event队列缓存大小，单位不太清楚，楼主猜测应该是个吧。当buffer超过10的时候，最旧的event将会被清除，并把新的event放进去。默认值为10。。非必须选项
;directory=/tmp ; 进程执行前，会切换到这个目录下执行默认为不切换。。。非必须
;umask=022 ; 默认为none，不说了
;priority=-1 ; 启动优先级，默认-1，也不扯了
;autostart=true ; 是否随supervisord启动一起启动，默认true
;autorestart=unexpected ; 是否自动重启，和program一个样，分true,false,unexpected等，注意unexpected和exitcodes的关系
;startsecs=1 ; 也是一样，进程启动后跑了几秒钟，才被认定为成功启动，默认1
;startretries=3 ; 失败最大尝试次数，默认3
;exitcodes=0,2 ; 期望或者说预料中的进程退出码，
;stopsignal=QUIT ; 干掉进程的信号，默认为TERM，比如设置为QUIT，那么如果QUIT来干这个进程那么会被认为是正常维护，退出码也被认为是expected中的
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; send stop signal to the UNIX process group (default false)
;killasgroup=false ; SIGKILL the UNIX process group (def false)
;user=chrism ;设置普通用户，可以用来管理该listener进程。默认为空。。非必须设置
;redirect_stderr=true ; 为true的话，stderr的log会并入stdout的log里面默认为false。。。非必须设置
;stdout_logfile=/a/path
;stdout_logfile_maxbytes=1MB
;stdout_logfile_backups=10
;stdout_events_enabled=false
;stderr_logfile=/a/path
;stderr_logfile_maxbytes=1MB
;stderr_logfile_backups
;stderr_events_enabled=false
;environment=A="1",B="2" ;这个是该子进程的环境变量默认为空。。。非必须设置
;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分组，划分到组里面的program。我们就不用一个一个去操作了
;我们可以对组名进行统一的操作。 注意：program被划分到组里面之后，就相当于原来
;的配置从supervisor的配置文件里消失了。。。supervisor只会对组进行管理，而不再
;会对组里面的单个program进行管理了
;programs=progname1,progname2 ; 组成员，用逗号分开这个是个必须的设置项
;priority=999 ; 优先级，相对于组和组之间说的默认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] ;这个东西挺有用的，当我们要管理的进程很多的时候，写在一个文件里面就有点大了。我们可以把配置信息写到多个文件中，然后include过来
;files = relative/directory/*.ini
六、关于supervisor的command执行两条命令（本人使用方法一）
如下supervisor的进程的comand配置参数只能写一个命令
- 要执行多条命令，可以写个sh文件包含多条命令，然后sh -x xxxx.sh，但这样又多了一个文件，但必须要有：
stopasgroup = true
killasgroup = true
2、把所有命令放在字符串，然后用eval来执行，这样在shell窗口可以执行，但放在supervisor报找不到eval命令。比如：
command = eval "python -u app/utils_ydf/git_client.py&&gunicorn -w 9 -k gevent --bind 0.0.0.0:5402 app.apis.elong.nearby_hotel:app" 这样不能在supervisor运行。
3、解决方式是使用如下:
command = /bin/bash -c "python -u app/utils_ydf/git_client.py&&gunicorn -w 9 -k gevent --bind 0.0.0.0:5402 app.apis.elong.nearby_hotel:app"
这样就可以了。
这样每次在启动或重启进程时候，会先拉去git再部署，部署速度比jenkens的构建速度快，状态也比jenkens查看方便。
这样运行是要注意下环境变量问题，比如用python的git包时候，读取不了git的路径居然，最后是在配置的enviroment设置GIT_PYTHON_GIT_EXECUTABLE="/usr/bin/git才解决，但单独运行又能读取git。
4、command用bash -c 启动 python xx.py一定要设置如下为true，否则stop不了真正的python/java进程，因为bash命令进程和真正的python进程不是同一个。 如果是command=python xx.py这样，并且程序里面没有使用多进程，则无需设置以下。
stopasgroup = true
killasgroup = true
参考资料：http://liyangliang.me/posts/2015/06/using-supervisor/
https://www.douban.com/note/657000902/