解放程式設計師雙手之Supervisor

深夜裡的程式猿發表於2019-04-12

解放程式設計師雙手之Supervisor

前言

對於大部分程式設計師來說,主要工作都是進行編碼以及一些簡單的中介軟體安裝,這就導致了很多人對於“運維”相關的工作會比較生疏。例如當我們擁有一臺自己的伺服器以後,可能會在上面跑一跑自己blog程式,mysql,nginx等等。當程式越來越多了沒有一個統一的入口管理啟停,也可能會遇到一些特殊的原因導致程式被kill掉了,這時候又沒裝相關的監控程式或者指令碼(太麻煩了懶得裝,機器配置差不想裝),所以只能當我們訪問自己程式發現異常的時候才會登上伺服器查詢原因。

這些狀況對我們來說是比較麻煩的,那麼這就需要一個“神器”來解放我們的雙手,鐺鐺鐺!!Supervisor 就來了。

正文

Supervisor 介紹

Supervisor是用Python開發的一套通用的程式管理程式,能將一個普通的命令列程式變為後臺daemon,並監控程式狀態,異常退出時能自動重啟。它是通過fork/exec的方式把這些被管理的程式當作supervisor的子程式來啟動,這樣只要在supervisor的配置檔案中,把要管理的程式的可執行檔案的路徑寫進去即可。也實現當子程式掛掉的時候,父程式可以準確獲取子程式掛掉的資訊的,可以選擇是否自己啟動和報警。

supervisor 安裝

簡單粗暴

yum install supervisor -y

supervisor 配置說明

通過這種形式安裝的supervisor,其配置檔案的目錄位於:
/etc/supervisord.conf (主配置檔案,下面會詳細介紹)
/etc/supervisor.d/ (預設子程式配置檔案,也就是需要我們根據程式配置的地方)


supervisord.conf 基本配置項說明,由於其引數比較多,這些只貼出一些常用的配置項,詳細內容可參閱官網。溫馨提示 “;” 符號是表示該行配置被註釋。

[unix_http_server]
file=/home/supervisor/supervisor.sock   ; supervisorctl使用的 socket檔案的路徑
;chmod=0700                 ; 預設的socket檔案許可權0700
;chown=nobody:nogroup       ; socket檔案的擁有者

[inet_http_server]         ; 提供web管理後臺管理相關配置
port=0.0.0.0:9001          ; web管理後臺執行的ip地址及埠,繫結外網需考慮安全性 
;username=root             ; web管理後臺登入使用者名稱密碼
;password=root

[supervisord]
logfile=/var/log/supervisord.log ; 日誌檔案,預設在$CWD/supervisord.log
logfile_maxbytes=50MB        ; 日誌限制大小,超過會生成新檔案,0表示不限制
logfile_backups=10           ; 日誌備份數量預設10,0表示不備份
loglevel=info                ; 日誌級別
pidfile=/home/supervisor/supervisord.pid ; supervisord pidfile; default supervisord.pid              ; pid檔案
nodaemon=false               ; 是否在前臺啟動,預設後臺啟動false
minfds=1024                  ; 可以開啟檔案描述符最小值
minprocs=200                 ; 可以開啟的程式最小值

[supervisorctl]
serverurl=unix:///home/supervisor/supervisor.sock ; 通過socket連線supervisord,路徑與unix_http_server->file配置的一致

[include]
files = supervisor.d/*.conf ;指定了在當前目錄supervisor.d資料夾下配置多個配置檔案

複製程式碼
準備測試專案

這裡我打包了一個簡單的spring-boot程式,存放與“/opt/project/”下。

解放程式設計師雙手之Supervisor

在這個程式中我們只是簡單的定義了一個rest介面,主要用於演示作用。

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello(){
        return "hello world";
    }
}
複製程式碼

如果不用supervisor的話,我們啟動程式一般用一下命令

nohup java -jar springboot-hello-sample.jar &

這是以後臺的方式啟動jar包,程式執行相關輸出會在nohup.out中,我們我們就不再贅述了,那麼我們來看一下,切換到supervisor的方式,我們是怎麼配置專案,以及管理的呢?

定義supervisor管理程式配置檔案

從上面的配置檔案[include]->files配置項我們可以知道,supervisor會把supervisor.d/下以conf結尾的配置檔案都載入進來,那麼我們在這個目錄下面新建一個sboot.conf,內容如下:


[program:sboot] ;[program:xxx] 這裡的xxx是指的專案名字
directory = /opt/project  ;程式所在目錄
command =  java -jar springboot-hello-sample.jar ;程式啟動命令
autostart=true ;是否跟隨supervisord的啟動而啟動
autorestart=true; 程式退出後自動重啟,可選值:[unexpected,true,false],預設為unexpected,表示程式意外殺死後才重啟
stopasgroup=true;程式被殺死時,是否向這個程式組傳送stop訊號,包括子程式
killasgroup=true;向程式組傳送kill訊號,包括子程式
stdout_logfile=/var/log/sboot/supervisor.log;該程式日誌輸出檔案,目錄需要手動建立
stdout_logfile_maxbytes = 50MB;日誌大小
stdout_logfile_backups  = 100;備份數

複製程式碼

可以看到,在配置檔案裡面已經有配置該程式名,啟動路徑等,這樣一來,supervisor就可以完全的掌管程式的生死了。接著我們執行

service supervisord restart

重啟supervisord。

觀察效果

瀏覽器輸入:伺服器ip:9001 (這裡的web管理頁面埠是在配置檔案配置好的。)

解放程式設計師雙手之Supervisor

如圖所示,我們可以可以觀察到springboot程式已經是running狀態了,pid是27517,我們可以點選Tail -f拉力觀察輸出日誌,它的作用跟我們在伺服器直接“tail -f”是類似的。

解放程式設計師雙手之Supervisor

這裡我們為了方便延時就沒有新增驗證了,如果大家是在公網的使用環境,需要配置檔案裡面的使用者名稱密碼驗證註釋開啟。不然別人掃出你的後臺管理頁面就可以隨意控制程式了。

除了web管理頁面,還有一些簡單的命令也是需要我們掌握的。

直接在命令列輸入supervisorctl會展示當前已配置好的專案資訊。

[root@wangzh supervisor.d]# supervisorctl 
sboot                            RUNNING   pid 27517, uptime 0:18:04
supervisor> 

複製程式碼

然後可以執行

start/stop/restart sboot 來簡單控制專案的啟停等
複製程式碼
supervisorctl update #更新配置檔案
supervisorctl reload #重新啟動配置的程式
supervisorctl stop all #停止全部管理程式
複製程式碼

結語

只需要一點簡單的配置,就可以統一的管理我們的程式了,同時也可以在程式意外死掉的時候自動重啟,這些工作以後就交給supervisor了,我們只要掌握一點簡單的命令就可以“為所欲為”。

supervisor官網:www.supervisord.org/

解放程式設計師雙手之Supervisor

公眾號<深夜裡的程式猿> - 分享最乾的乾貨

相關文章