Python—守護進程管理工具（Supervisor）

一、前言簡介

1、Supervisor 是一個 Python 開發的 client/server 系統，可以管理和監控類 UNIX 操作系統上面的進程。可以很方便的用來啟動、重啟、關閉進程（不僅僅是 Python 進程）。

2、Supervisor 安裝完成之后，可以編寫配置文件，來滿足自己的需求。為了方便，我們把配置分成兩部分：supervisord（這是 server 端，對應的有 client 端：supervisorctl）和應用程序（即我們要管理的程序）。

• supervisord(server 部分)：主要負責管理子進程，響應客戶端命令以及日志的輸出等，受控的監聽進程都會以其子進程地方式出現，不過如果supervisord的主進程非正常退出時，被管理的進程仍然是運行狀態。
• supervisorctl(client 部分)：命令行客戶端，用戶可以通過它與不同的 supervisord 進程聯系，獲取子進程的狀態等。

3、Supervisord 要求管理的程序是非daemon程序，supervisord 會幫你把它轉成daemon程序，因此如果用supervisord來管理nginx的話，必須在nginx的配置文件里添加一行設置daemon off讓nginx以非daemon方式啟動，當然了，redis等亦如是。 

二、安裝supervisor

1、安裝supervisor

[root@localhost ~]# pip install supervisor

2、測試supervisor安裝是否成功

[root@localhost ~]# echo_supervisord_conf

3、卸載supervisor

[root@localhost ~]# pip uninstall supervisor

supervisor安裝完成后會生成三個執行程序：supervisortd、supervisorctl、echo_supervisord_conf。分別是supervisor的守護進程服務（用於接收進程管理命令）、客戶端（用於和守護進程通信，發送管理進程的指令）、生成初始配置文件程序。

三、配置supervisord

安裝 supervisor 完成之后，可以編寫配置文件，來滿足自己的需求。為了方便，我們把配置分成兩部分：supervisord（這是 server 端，對應的 client 端：supervisorctl）和應用程序（即我們要管理的程序）。首先來看 supervisord 的配置文件。

1、通過運行 echo_supervisord_conf 命令生成 supervisor 的初始化配置文件：supervisord.conf（supervisord.conf文件的位置無所謂，這里當作第二個位置）

[root@localhost ~]# echo_supervisord_conf > /etc/supervisord.conf
[root@localhost ~]# echo_supervisord_conf > /etc/supervisor/supervisord.conf

2、啟動 supervisord 服務（通過 -c 選項指定配置文件路徑，如果不指定會按照這個順序查找配置文件：$CWD/supervisord.conf,  $CWD/etc/supervisord.conf,  /etc/supervisord.conf,  /etc/supervisor/supervisord.conf）：

[root@localhost ~]# supervisord                                          # 默認去找 /etc/supervisord.conf 這個配置文件       
[root@localhost ~]# supervisord -c /etc/supervisord.conf                 # 到指定路徑下去找配置文件         
[root@localhost ~]# supervisord -c /etc/supervisor/supervisord.conf      # 到指定路徑下去找配置文件

3、查看 supervisord 服務是否在運行：

[root@localhost ~]# ps aux | grep supervisord

4、查看 supervisord 服務是否生效

[root@localhost ~]# ps -ef | grep ProjectName

四、配置文件參數說明

[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 = /www/server/panel/plugin/supervisor/profile/*.ini    ;可以指定一個或多個以.ini結束的配置文件

五、配置supervisord開機自啟

1.在 /usr/lib/systemd/system/ 目錄下面新建文件supervisord.service，並寫入如下內容：

[Unit]
Description=Process Monitoring and Control Daemon(Supervisor daemon)
After=rc-local.service nss-user-lookup.target

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf
ExecStop=/usr/bin/supervisord shutdown
ExecReload=/usr/bin/supervisord reload
killMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target

2.啟動服務：執行開機啟動命令，讓 supervisord 服務開機自啟。

[root@localhost ~]# systemctl enable supervisord

3.驗證一下是否為開機啟動。enabled：開機自啟。disabled：開機不自啟。

[root@localhost ~]# systemctl is-enabled supervisord

4.重啟服務器，檢查 supervisor 是否啟動。

[root@localhost ~]# ps aux | grep supervisor

六、Web管理頁面

supervisor提供了可視化的Web管理頁面，允許遠程操作，但是需要在配置文件中手動打開。可以在網頁端訪問supervisor服務。

注意：如果是騰訊雲或阿里雲服務器，需要安全組放行9001端口，才能訪問。

# 1.打開配置配件
[root@localhost ~]# vi /etc/supervisor/supervisord.conf
 
# 2.將下面幾行前面的分號去掉，修改一下數據保存退出（用戶名與密碼自己定義）
[inet_http_server]             # inet (TCP) server disabled by default
port=0.0.0.0: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)

# 3.重新載入配置文件
[root@localhost ~]# supervisorctl reload
 
# 4.在瀏覽器輸入：IP:9001，再輸入用戶名與密碼即可登陸查看。

七、開啟多個進程

numprocs=2         # 啟動進程的數目，默認為1。; 若 numprocs 不為1時,就是進程池的概念。process_name 的表達式中一定要包含 process_num 來區分不同的進程。
process_name=%(program_name)s_%(process_num)02d      # 直接就可以使用

八、Supervisor管理的項目名稱是中文的問題解決

在配置文件中添加或修改：environment=LANG="en_US.UTF-8",LC_ALL="en_US.UTF-8"。例如：

environment=LANG="en_US.UTF-8",LC_ALL="en_US.UTF-8"

[include]
files = /www/server/panel/plugin/supervisor/profile/*.ini

　https://www.osgeo.cn/post/71f93

九、常見報錯問題

1、Error: Another program is already listening on a port that one of our HTTP servers is configured to use.  Shut this program down first before starting supervisord。

[root@localhost ~]# ps -ef | grep supervisord      # 獲取所有supervisord正在運行的pid。假設pid值為2506 
[root@localhost ~]# kill -s SIGTERM 2506           # 殺死進程，之后再重新執行：supervisord -c /etc/supervisor/supervisord.conf 即可。

2、pip下載報錯

[root@localhost ~]# /www/server/panel/pyenv/bin/pip install supervisor -i http://pypi.douban.com/simple --trusted-host pypi.douban.com --ignore-installed meld3