nginx信號集案例詳解

之前工作時候，一臺引流測試機(jī)器的一個 ngx_lua 服務(wù)突然出現(xiàn)了一些 HTTP/500 響應(yīng)，從錯誤日志打印的堆棧來看，是不久前新發(fā)布的版本里添加的一個 Lua table 不存在，而有代碼向其進(jìn)行索引導(dǎo)致的。這令人百思不得其解，如果是版本回退導(dǎo)致的，那么為什么使用這個 Lua table 的代碼沒有被回退，偏偏定義這個 table 的代碼被回退了呢？

經(jīng)過排查發(fā)現(xiàn)，當(dāng)時 nginx 剛剛完成熱更新操作，舊的 master 進(jìn)程還存在，因為要準(zhǔn)備機(jī)器重啟，先切掉了引流流量（但有些請求還在），同時系統(tǒng)觸發(fā)了 nginx -s stop，這才導(dǎo)致了這個問題。

場景復(fù)現(xiàn)

下面我將使用一個原生的 nginx，在我的安裝了 fedora26 的虛擬機(jī)上復(fù)現(xiàn)這個過程，我使用的 nginx 版本是目前最新的 1.13.4

首先啟動 nginx

可以看到 master 和 worker 都已經(jīng)在運行。

接著我們向 master 發(fā)送一個 SIGUSR2 信號，當(dāng) nginx 核心收到這個信號后，就會觸發(fā)熱更新。

可以看到新的 master 和該 master fork 出來的 worker 已經(jīng)在運行了，此時我們接著向舊 master 發(fā)送一個 SIGWINCH 信號，舊 master 收到這個信號后，會向它的 worker 發(fā)送 SIGQUIT，于是舊 master 的 worker 進(jìn)程就會退出：

此時只剩下舊的 master，新的 master 和新 master 的 worker 在運行，這和當(dāng)時線上運行的情況類似。

接著我們使用 stop 命令：

我們會發(fā)現(xiàn)，新的 master 和它的 worker 都已經(jīng)退出，而舊的 master 還在運行，并產(chǎn)生了 worker 出來。這就是當(dāng)時線上的情況了。

事實上，這個現(xiàn)象和 nginx 自身的設(shè)計有關(guān)：當(dāng)舊的 master 準(zhǔn)備產(chǎn)生 fork 新的 master 之前，它會把 nginx.pid 這個文件重命名為 nginx.pid.oldbin，然后再由 fork 出來的新的 master 去創(chuàng)建新的 nginx.pid，這個文件將會記錄新 master 的 pid。nginx 認(rèn)為熱更新完成之后，舊 master 的使命幾乎已經(jīng)結(jié)束，之后它隨時會退出，因此之后的操作都應(yīng)該由新 master 接管。當(dāng)然，在舊 master 沒有退出的情況下通過向新 master 發(fā)送 SIGUSR2 企圖再次熱更新是無效的，新 master 只會忽略掉這個信號然后繼續(xù)它自己的工作。

問題分析

更不巧的是，我們上面提到的這個 Lua table，定義它的 Lua 文件早在運行 init_by_lua 這個 hook 的時候，就已經(jīng)被 LuaJIT 加載到內(nèi)存并編譯成字節(jié)碼了，那么顯然舊的 master 必然沒有這個 Lua table，因為它加載那部分 Lua 代碼是舊版本的。

而索引該 table 的 Lua 代碼并沒有在 init_by_lua 的時候使用到，這些代碼都是在 worker 進(jìn)程里被加載起來的，這時候項目目錄里的代碼都是最新的，所以 worker 進(jìn)程加載的都是最新的代碼，如果這些 worker 進(jìn)程處理到相關(guān)的請求，就會出現(xiàn) Lua 運行時錯誤，外部表現(xiàn)則是對應(yīng)的 HTTP 500。

吸收了這個教訓(xùn)之后，我們需要更加合理地關(guān)閉我們的 nginx 服務(wù)。 所以一個更加合理的 nginx 服務(wù)啟動關(guān)閉腳本是必需的，網(wǎng)上流傳的一些腳本并沒有對這個現(xiàn)象做處理，我們更應(yīng)該參考 NGINX 官方提供的腳本。

這段代碼引自 NGINX 官方的 /etc/init.d/nginx 。

nginx 信號集

接下來我們來全面梳理下 nginx 信號集，這里不會涉及到源碼細(xì)節(jié)，感興趣的同學(xué)可以自行閱讀相關(guān)源碼。

我們有兩種方式來向 master 進(jìn)程發(fā)送信號，一種是通過 nginx -s signal 來操作，另一種是通過 kill 命令手動發(fā)送。

第一種方式的原理是，產(chǎn)生一個新進(jìn)程，該進(jìn)程通過 nginx.pid 文件得到 master 進(jìn)程的 pid，然后把對應(yīng)的信號發(fā)送到 master，之后退出，這種進(jìn)程被稱為 signaller。

第二種方式要求我們了解 nginx -s signal 到真實信號的映射。下表是它們的映射關(guān)系：

operation signal
reload SIGHUP
reopen SIGUSR1
stop SIGTERM
quit SIGQUIT
hot update SIGUSR2 & SIGWINCH & SIGQUIT
stop vs quit

stop 發(fā)送 SIGTERM 信號，表示要求強(qiáng)制退出，quit 發(fā)送 SIGQUIT，表示優(yōu)雅地退出。 具體區(qū)別在于，worker 進(jìn)程在收到 SIGQUIT 消息（注意不是直接發(fā)送信號，所以這里用消息替代）后，會關(guān)閉監(jiān)聽的套接字，關(guān)閉當(dāng)前空閑的連接（可以被搶占的連接），然后提前處理所有的定時器事件，最后退出。沒有特殊情況，都應(yīng)該使用 quit 而不是 stop。

reload

master 進(jìn)程收到 SIGHUP 后，會重新進(jìn)行配置文件解析、共享內(nèi)存申請，等一系列其他的工作，然后產(chǎn)生一批新的 worker 進(jìn)程，最后向舊的 worker 進(jìn)程發(fā)送 SIGQUIT 對應(yīng)的消息，最終無縫實現(xiàn)了重啟操作。

reopen

master 進(jìn)程收到 SIGUSR1 后，會重新打開所有已經(jīng)打開的文件（比如日志），然后向每個 worker 進(jìn)程發(fā)送 SIGUSR1 信息，worker 進(jìn)程收到信號后，會執(zhí)行同樣的操作。reopen 可用于日志切割，比如 NGINX 官方就提供了一個方案：

這里 sleep 1 是必須的，因為在 master 進(jìn)程向 worker 進(jìn)程發(fā)送 SIGUSR1 消息到 worker 進(jìn)程真正重新打開 access.log 之間，有一段時間窗口，此時 worker 進(jìn)程還是向文件 access.log.0 里寫入日志的。通過 sleep 1s，保證了 access.log.0 日志信息的完整性（如果沒有 sleep 而直接進(jìn)行壓縮，很有可能出現(xiàn)日志丟失的情況）。

hot update

某些時候我們需要進(jìn)行二進(jìn)制熱更新，nginx 在設(shè)計的時候就包含了這種功能，不過無法通過 nginx 提供的命令行完成，我們需要手動發(fā)送信號。

通過上面的問題復(fù)現(xiàn)，大家應(yīng)該已經(jīng)了解到如何進(jìn)行熱更新了，我們首先需要給當(dāng)前的 master 進(jìn)程發(fā)送 SIGUSR2，之后 master 會重命名 nginx.pid 到 nginx.pid.oldbin，然后 fork 一個新的進(jìn)程，新進(jìn)程會通過 execve 這個系統(tǒng)調(diào)用，使用新的 nginx ELF 文件替換當(dāng)前的進(jìn)程映像，成為新的 master 進(jìn)程。新 master 進(jìn)程起來之后，就會進(jìn)行配置文件解析等操作，然后 fork 出新的 worker 進(jìn)程開始工作。

接著我們向舊的 master 發(fā)送 SIGWINCH 信號，然后舊的 master 進(jìn)程則會向它的 worker 進(jìn)程發(fā)送 SIGQUIT 信息，從而使得 worker 進(jìn)程退出。向 master 進(jìn)程發(fā)送 SIGWINCH 和 SIGQUIT 都會使得 worker 進(jìn)程退出，但是前者不會使得 master 進(jìn)程也退出。

最后，如果我們覺得舊的 master 進(jìn)程使命完成，就可以向它發(fā)送 SIGQUIT 信號，讓其退出了。

worker 進(jìn)程如何處理來自 master 的信號消息

實際上，master 進(jìn)程再向 worker 進(jìn)程通訊，不是使用 kill 函數(shù)，而是使用了通過管道實現(xiàn)的 nginx channel，master 進(jìn)程向管道一端寫入信息（比如信號信息），worker 進(jìn)程則從另外一端收取信息，nginx channel 事件，在 worker 進(jìn)程剛剛起來的時候，就被加入事件調(diào)度器中（比如 epoll，kqueue），所以當(dāng)有數(shù)據(jù)從 master 發(fā)來時，即可被事件調(diào)度器通知到。

nginx 這么設(shè)計是有理由的，作為一個優(yōu)秀的反向代理服務(wù)器，nginx 追求的就是極致的高性能，而 signal handler 會中斷 worker 進(jìn)程的運行，使得所有的事件都被暫停一個時間窗口，這對性能是有一定損失的。

很多人可能會認(rèn)為當(dāng) master 進(jìn)程向 worker 進(jìn)程發(fā)送信息之后，worker 進(jìn)程立刻會有對應(yīng)操作回應(yīng)，然而 worker 進(jìn)程是非常繁忙的，它不斷地處理著網(wǎng)絡(luò)事件和定時器事件，當(dāng)調(diào)用 nginx channel 事件的 handler 之后，nginx 僅僅只是處理了一些標(biāo)志位。真正執(zhí)行這些動作是在一輪事件調(diào)度完成之后。所以這之間存在一個時間窗口，尤其是業(yè)務(wù)復(fù)雜且流量巨大的時候，這個窗口就有可能被放大，這也就是為什么 NGINX 官方提供的日志切割方案里要求 sleep 1s 的原因。

當(dāng)然，我們也可以繞過 master 進(jìn)程，直接向 worker 進(jìn)程發(fā)送信號，worker 可以處理的信號有

signal effect
SIGINT 強(qiáng)制退出
SIGTERM 強(qiáng)制退出
SIGQUIT 優(yōu)雅退出
SIGUSR1 重新打開文件

總結(jié)

nginx 信號操作在日常運維中是最常見的，也是非常重要的，這個環(huán)節(jié)如果出現(xiàn)失誤則可能造成業(yè)務(wù)異常，帶來損失。所以理清楚 nginx 信號集是非常必要的，能幫助我們更好地處理這些工作。

另外，通過這次的經(jīng)驗教訓(xùn)和對 nginx 信號集的認(rèn)知，我們認(rèn)為以下幾點是比較重要的：

慎用 nginx -s stop，盡可能使用 nginx -s quit

熱更新之后，如果確定業(yè)務(wù)沒問題，盡可能讓舊的 master 進(jìn)程退出

關(guān)鍵性的信號操作完成后，等待一段時間，避免時間窗口的影響

不要直接向 worker 進(jìn)程發(fā)送信號