supervisor簡介、安裝與入門使用

supervisor簡介

Supervisor是用Python開發的一套通用的程序client/server管理程式，是UNIX-like系統下的一個程序管理工具，能将一個普通的指令行程序變為背景daemon，并監控程序狀态，異常退出時能自動重新開機。它是通過fork/exec的方式把這些被管理的程序當作supervisor的子程序來啟動，這樣隻要在supervisor的配置檔案中，把要管理的程序的可執行檔案的路徑寫進去即可。也實作當子程序挂掉的時候，父程序可以準确擷取子程序挂掉的資訊的，可以選擇是否自己啟動和報警。supervisor還提供了一個功能，可以為supervisord或者每個子程序，設定一個非root的user，這個user就可以管理它對應的程序。

優點：

可以将非背景運作程式背景運作

自動監控，重新開機程序

缺點：

不能管理背景運作程式

對多程序服務，不能使用kill關閉

supervisor安裝

CentOS通過yum安裝

yum install supervisor      

Debian/Ubuntu可通過apt安裝

apt-get install supervisor      

pip安裝

pip install supervisor      

easy_install安裝

easy_install supervisor      

supervisor配置使用

生成配置檔案，且放在/etc目錄下

echo_supervisord_conf > /etc/supervisord.conf      

為了不将所有新增配置資訊全寫在一個配置檔案裡，建立一個檔案夾，每個程式設定一個配置檔案，互相隔離

mkdir /etc/supervisord.d/      

supervisord.conf是一些預設配置，可自行修改：

[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 = relative/directory/*.ini    ;可以指定一個或多個以.ini結束的配置檔案      

注意：[include]預設配置是制定*.ini，習慣命名為*.conf檔案，是以修改配置如下：

[include]
files = relative/directory/*.conf      

supervisord.d目錄用來存放使用者自定義的程序配置，參考執行個體一：

[program:es]
command=/opt/software/elasticsearch/bin/elasticsearch
user=es
stdout_logfile=/opt/supervisor_test/run.log
autostart=true
autorestart=true
startsecs=60
stopasgroup=true
ikillasgroup=true
startretries=1
redirect_stderr=true      

參考執行個體二：

vim /etc/supervisord.d/rdkit_postgres.conf

[program:postgresql]
command=[conda folder]/envs/my-rdkit-env/bin/postgres -D /folder/where/data/should/be/stored
user=[your username]
autorestart=true      

服務段啟動

supervisord -c /etc/supervisord.conf      

注意: supervisor不能監控背景程序，command 不能為背景運作指令

常用指令介紹

supervisorctl 是 supervisord的指令行用戶端工具

supervisorctl status：檢視所有程序的狀态
supervisorctl stop es：停止es
supervisorctl start es：啟動es
supervisorctl restart es: 重新開機es
supervisorctl update ：配置檔案修改後可以使用該指令加載新的配置
supervisorctl reload: 重新啟動配置中的所有程式      

直接輸入：supervisorctl 進入supervisorctl 的shell互動界面，上面的指令不帶supervisorctl 可直接使用