supervisor安裝配置

Supervisor是用Python開發的一個client/server服務,是Linux/Unix系統下的一個進程管理工具,不支持Windows系統。它可以很方便的監聽、啟動、停止、重啟一個或多個進程。用Supervisor管理的進程,當一個進程意外被殺死,supervisort監聽到進程死后,會自動將它重新拉起,很方便的做到進程自動恢復的功能,不再需要自己寫shell腳本來控制。

1、supervisor組件

  • supervisord(server 部分):主要負責管理子進程,響應客戶端命令以及日志的輸出等;
  • supervisorctl(client 部分):命令行客戶端,用戶可以通過它與不同的 supervisord 進程聯系,獲取子進程的狀態等。
  • Web Server主要可以在界面上管理進程,Web Server其實是通過XML_RPC來實現的,可以向supervisor請求數據,也可以控制supervisor及子進程。配置在[inet_http_server]塊里面;
  • XML_RPC接口
    提供了與webserver中相同的用于查詢和控制進程的http接口;

2、安裝

python版本要求2.4以上, 且不能是python3, supervisor不能運行在任何python3版本上。(但是可以用py2運行 supervisor, supervisor啟動py3的程序,也就是linux自帶py2所以不用糾結py版本問題)
可以直接用pip安裝:

sudo pip install supervisor

Centos安裝:

yum install supervisor

Ubuntu安裝(下面兩行任意一種即可):

wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
easy_install supervisor

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

3、配置

運行supervisord服務的時候,需要指定supervisor配置文件,如果沒有顯示指定,默認在以下目錄查找:

$CWD/supervisord.conf
$CWD/etc/supervisord.conf
/etc/supervisord.conf
/etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
../etc/supervisord.conf (Relative to the executable)
../supervisord.conf (Relative to the executable)

$CWD表示運行supervisord程序的目錄。
可以通過運行echo_supervisord_conf程序生成supervisor的初始化配置文件,如下所示:

mkdir /etc/supervisor
echo_supervisord_conf > /etc/supervisor/supervisord.conf

3.1、 啟動

然后可以通過 supervisord 命令啟動 supervisord.

$ supervisord

查看supervisor進程信息

$ ps aux | grep super
root       1405  0.0  0.2  60956  7032 ?        Ss   10:34   0:01 /usr/bin/python /usr/bin/supervisord -n -c /etc/supervisor/supervisord.conf

此時supervisord已經啟動,可以通過supervisorctl進入shell管理界面:

$ supervisorctl
supervisor>status
supervisor>

由于目前沒有添加任何需要管理的進程,所以 status 沒有輸出人和結果。

3.2、 program配置

上面我們已經把 supervisrod 運行起來了,現在可以添加我們要管理的進程的配置文件。可以把所有配置項都寫到 supervisord.conf 文件里,但并不推薦這樣做,而是通過 include 的方式把不同的程序(組)寫到不同的配置文件里。
為了舉例,我們新建一個目錄 /etc/supervisor/ 用于存放這些配置文件,相應的,把 /etc/supervisord.conf 里 include 部分的的配置修改一下:

[include]
files = /etc/supervisor/*.conf

上面這個要注意一下是.conf還是.ini,以及這個路徑。決定著你一會創建的配置管理文件在哪和名字以什么結尾!
假設有個用 Python 和 Flask 框架編寫的用戶中心系統,取名 usercenter,用 gunicorn做 web 服務器。項目代碼位于 /home/leon/projects/usercenter,gunicorn 配置文件為 gunicorn.py,WSGI callable 是 wsgi.py 里的 app 屬性。所以直接在命令行啟動的方式可能是這樣的:

cd /home/tudou/projects/usercenter
gunicorn -c gunicorn.py wsgi:app

現在編寫一份配置文件來管理這個進程(需要注意:用 supervisord 管理時,gunicorn 的 daemon 選項需要設置為 False),文件地址和后綴名跟剛才的files 有關比如/etc/supervisor/usercenter.conf:

[program:usercenter]
directory = /home/leon/projects/usercenter ; 程序的啟動目錄
command = gunicorn -c gunicorn.py wsgi:app  ; 啟動命令,可以看出與手動在命令行啟動的命令是一樣的
autostart = true     ; 在 supervisord 啟動的時候也自動啟動
startsecs = 5        ; 啟動 5 秒后沒有異常退出,就當作已經正常啟動了
autorestart = true   ; 程序異常退出后自動重啟
startretries = 3     ; 啟動失敗自動重試次數,默認是 3
user = leon          ; 用哪個用戶啟動
redirect_stderr = true  ; 把 stderr 重定向到 stdout,默認 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小,默認 50MB
stdout_logfile_backups = 20     ; stdout 日志文件備份數
; stdout 日志文件,需要注意當指定目錄不存在時無法正常啟動,所以需要手動創建目錄(supervisord 會自動創建日志文件)
stdout_logfile = /data/logs/usercenter_stdout.log

; 可以通過 environment 來添加需要的環境變量,一種常見的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

一份配置文件至少需要一個 [program:x] 部分的配置,來告訴 supervisord 需要管理那個進程。[program:x] 語法中的 x 表示 program name,會在客戶端(supervisorctl 或 web 界面)顯示,在 supervisorctl 中通過這個值來對程序進行 start、restart、stop 等操作。

3.3、 管理命令

可以使用以下命令更新配置、更新進程、查看狀態

# 讀取有更新(增加)的配置文件,不會啟動新添加的程序
$ supervisorctl reread
# 重啟配置文件修改過的程序
$ supervisorctl update
# 查看程序狀態
$ supervisorctl status
# 啟動程序 App_name
$ supervisorctl start App_name
# 關閉程序 App_name
$ supervisorctl stop App_name
# 重啟程序 App_name
$ supervisorctl restart App_name

以上命令也可以在supervisorctl Shell中執行:

$ supervisorctl
supervisor> reread
supervisor> update
supervisor> status
supervisor> start App_name
supervisor> stop App_name
supervisor> restart App_name

3.4、web管理界面

除了 supervisorctl 之外,還可以配置 supervisrod 啟動 web 管理界面,這個 web 后臺使用 Basic Auth 的方式進行身份認證。
除了單個進程的控制,還可以配置 group,進行分組管理。
經常查看日志文件,包括 supervisord 的日志和各個 pragram 的日志文件,程序 crash 或拋出異常的信息一半會輸出到 stderr,可以查看相應的日志文件來查找問題。

3.4.1、配置

編輯配置文件/etc/supervisor/supervisord.conf,添加inet_http_server節點,如下(注:這里每一行前面都帶個;號,他是注釋要去掉才行):

[inet_http_server]
port = 0.0.0.0:9001
username = username
password = password

其中,port是服務監聽端口信息,username是管理員用戶名,password是管理員密碼。

權限報錯

本人直接root用戶運行了,如果沒有權限則像下面這樣修改

1、日志權限錯誤

IOError: [Errno 13] Permission denied: '/var/log/supervisor/supervisord.log'

原因,/var/log/supervisor/supervisord.log沒有寫權限,賦予權限即可:

sudo chmod -R 777 /var/log/supervisor/supervisord.log

2、開啟HTTP Server錯誤

Error: Cannot open an HTTP server: socket.error reported errno.EACCES (13)

配置文件中 /var/run 文件夾,沒有授予啟動 supervisord 的相應用戶的寫權限。/var/run 文件夾實際上是鏈接到 /run,因此我們修改 /run 的權限。

sudo chmod 777 /run

一般情況下,我們可以用 root 用戶啟動 supervisord 進程,然后在其所管理的進程中,再具體指定需要以那個用戶啟動這些進程。

3、日志權限問題

'INFO spawnerr: unknown error making dispatchers for 'app_name': EACCES'

修改日志文件的權限

sudo chmod 777 /usr/log/supervisor/supervisor.log
sudo chmod 777 /usr/log/supervisor/youAppName.log

開機自啟

配置Supervisor開機啟動:

新建一個“supervisord.service”文件(如果/usr/lib/systemd/system/有該文件,就不用管了)

# dservice for systemd (CentOS 7.0+) 
# by ET-CS (https://github.com/ET-CS) 
[Unit] 
Description=Supervisor daemon

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

[Install] 
WantedBy=multi-user.target

如果沒有該文件則把這個新建的文件拷貝至:“/usr/lib/systemd/system/supervisord.service”
然后命令行輸入

systemctl enable supervisord

驗證一下是否為開機啟動:

systemctl is-enabled supervisord
>>>enabled(返回這個就對了)

本博文是抄襲此博客后完善的

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380

推薦閱讀更多精彩內容