supervisor: 基于python开发的通用进程管理工具

supervisor 介绍

supervisor是用python开发的通用进程(不仅仅是python进程)管理程序,其可以将普通的命令行进程转变为后台daemon(守护进程),监控进程状态,当进程异常退出时可自动重启。

注意!注意!后方高能报警中~~~
====》Supervisor只能管理非daemon的进程,也就是说Supervisor不能管理守护进程。否则提示Exited too quickly (process log may have details)异常。

supervisor 原理

supervisor通过fork/exec来将被管理进程当作自己的子进程来启动(只需在supervisor的配置文件中机上进程可执行文件路径即可)。当子进程异常时,父进程可以准确获取子进程挂掉的信息,可以选择自己启动或者报警。

Supervisor管理进程状态转换图

Supervisor管理进程状态转换图.png

说明:

  • running:进程处于运行状态
  • starting:Supervisor 收到启动请求后,进程处于正在启动过程中
  • stopped:进程处于关闭状态
  • stopping:Supervisor 收到关闭请求后,进程处于正在关闭过程中
  • backoff:进程进入 starting 状态后,由于马上就退出导致没能进入 running 状态
  • fatal:进程没有正常启动
  • exited:进程从 running 状态退出

以下步骤均是在ubuntu中实践的结果,可放一亿个心好好参考~~~😊


supervisor 安装

# 安装
apt install supervisor

# 拓展:卸载
apt remove supervisor

安装成功后,可以确认以下两点:

  1. 在/etc/下会生成一个supervisor配置目录:/etc/supervisor


    图片.png
  2. supervisor已成功运行

# 查看supervisor进程的命令
ps -ef | grep supervisor

# 启动supervisor
supervisord

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

1)supervisord :守护进程服务(用来接收进程管理命令)
2)supervisorctl :客户端(用来和守护进程通信,发送管理进程的命令)
3)echo_supervisord_conf :生成初始配置文件程序

supervisor总配置:supervisord.conf

安装成功后,在/etc/supervisor目录下,会生成supervisord.conf配置文件,内容如下所示:

; supervisor config file

[unix_http_server]
file=/var/run/supervisor.sock   ; (the path to the socket file)
chmod=0700                       ; sockef file mode (default 0700)

[supervisord]
logfile=/var/log/supervisor/supervisord.log ; (main log file;default $CWD/supervisord.log)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
childlogdir=/var/log/supervisor            ; ('AUTO' child log dir, default $TEMP)

; 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

; 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 = /etc/supervisor/conf.d/*.conf

当然,若您在/etc/supervisor目录下未发现supervisord.conf文件,可以选择在/etc/supervisor目录下手动创建supervisord.conf,方法有两种:
1) (内容比较简洁,推荐~~~)手动创建supervisord.conf文件,然后完全copy我上面贴出来的内容即可;
2) 内容比较多,不推荐~~~)使用supervisor内置生成配置文件的命令,生成默认配置文件,命令如下:

# 生成默认配置文件
echo_supervisord_conf  >  supervisord.conf

supervisor 进程管理配置

一般地,进程管理配置参数,不建议都写在supervisord.conf文件中,应该每个进程写一个配置文件:*.conf(文件放在include指定地目录下)。
配置文件内容格式如下:

[program:minibreakpad]  //进程名称  
directory = /root/error/mini-breakpad-server //程序的启动目录  
command = node lib/app.js //启动命令  autostart = true //在supervisord 启动的时候也自动启动  
startsecs = 5 //启动5秒后没有退出就当做已经正常启动  
autostart = true // 自动启动
autorestart = true //程序异常退出后自动重启  
startretries = 5 //启动失败自动重试次数 5  
user = root //用哪个用户启动  
redirect_stderr = true //把 stderr 重定向到 stdout 默认 false,如果是false就不需要设置下面的log配置  
stdout_logfile_maxbytes = 20MB //stdout 日志文件大小,默认50MB  
stdout_logfile_backups = 20 //stdout 日志文件备份数  
//stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)  
stdout_logfile = /var/log/flask_demo/stdout.log  // 日志输出路径
stderr_logfile = /var/log/flask_demo/stderr.log // 错误日志输出路径
environment=ASPNETCORE_ENVIRONMENT="Development" // 自定义该子进程的环境变量,和别的子进程是不共享的 (default no adds)

下面是一个supervisor管理nginx进程地实例,仅供参考。

[program:nginx]
directory = /usr/local/nginx
command = /usr/local/nginx/sbin/nginx -g 'daemon off;'
startsecs = 5
autostart = true
autorestart = true
stdout_logfile = /var/log/supervisor/nginx.log
stderr_logfile = /var/log/supervisor/nginx_error.log
user = root

特别注意:
sbin/nginx这条命令默认是后台启动,但是supervisor不能监控后台程序,所以supervisor就一直执行这个命令,导致nginx一直在重启,加上-g 'daemon off;'这个参数可解决这问题,这个参数的意思是在前台运行。

supervisor启动命令

# 启动supervisor服务
supervisord

查看已启动服务

pstree -p |grep supervisord

查看supervisor log日志

日志路径是自定义配置的,不固定。
若不确定路径,可以在supervisord.conf中查找到supervisor log日志的路径。

cat /var/log/supervisor/supervisord.log

supervisorctl 常用命令

# 查看supervisorctl命令
supervisorctl help

# 查看已被监控地program,并进入supervisor的命令行窗口
supervisorctl

# 重载最新的配置文件,当添加/修改supervisor配置后,需要执行reload
supervisorctl reload

# 根据最新的配置文件,启动新配置或有改动的进程,配置没有改动的进程不会受影响而重启
supervisorctl update

# 查看运行状态
supervisorctl status

# 启动某个进程
supervisorctl start <program-name>

# 重启某个进程
supervisorctl restart <program-name>

# 停止某个进程
supervisorctl stop <program-name>

# 停止所有进程
supervisorctl stop all

supervisor设置开机启动

用apt安装supervisor,一般来说是会自动设置好开机启动的,这也是为什么我在本文章开头采用apt安装supervisor的原因。
但,不怕一万就怕万一,若你重启服务器之后supervisor没有自动启动,那么可以按照下面的方法设置开启启动:将supervisor启动命令写进rc.local即可

# 可以使用 whereis supervisord获得supervisord的路径
/usr/bin/supervisord

ubuntu 配置rc.local的方法可参考:ubuntu 设置脚本开机自启动

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351

推荐阅读更多精彩内容