在生產環境運維工作中，檢視線上伺服器日誌是一項常規工作。如果這項工作可以在瀏覽器中進行，而無需登入伺服器執行 tail -f 命令，就太方便了。我們可以使用 WebSocket 技術輕鬆實現這一目標。在本文中，我將帶各位一起使用 Python 編寫一個日誌檢視工具。

WebSocket 簡介

WebSocket 是一個標準化協議，構建在 TCP 之上，能夠在客戶端和服務端之間建立一個全雙工的通訊渠道。這裡的客戶端和服務端通常是使用者瀏覽器和 Web 伺服器。在 WebSocket 誕生之前，如果我們想保持這樣的一個長連線，就需要使用諸如長輪詢、永久幀、Comet 等技術。而現今 WebSocket 已經得到了所有主流瀏覽器的支援，我們可以使用它開發出線上聊天室、遊戲、實時儀表盤等軟體。此外，WebSocket 可以通過 HTTP Upgrade 請求來建立連線，並使用 80 埠通訊，從而降低對現有網路環境的影響，如無需穿越防火牆。

websockets Python 類庫

websockets 是第三方的 Python 類庫，它能基於 Python 提供的 asyncio 包來實現 WebSocket 服務端以及客戶端應用。我們可以使用 pip 來安裝它，要求 Python 3.3 以上的版本。

pip install websockets
# For Python 3.3
pip install asyncio

下面是一段簡單的 Echo 服務程式碼：

import asyncio
import websockets

@asyncio.coroutine
def echo(websocket, path)
 
:
    message = yield from websocket.recv()
    print('recv', message)
    yield from websocket.send(message)

start_server = websockets.serve(echo, 'localhost', 8765)

asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()

可以看到，我們使用 Python 的協程來處理客戶端請求。協程是 Python 3.3 引入的新概念，簡單來說，它能通過單個執行緒來實現併發程式設計，主要適用於處理套接字 I/O 請求等場景。Python 3.5 開始又引入了 async

async def echo(websocket, path):
    message = await websocket.recv()
    await websocket.send(message)

對於客戶端應用，我們直接使用瀏覽器內建的 WebSocket 類。將下面的程式碼直接貼上到 Chrome 瀏覽器的 JavaScript 控制檯中就可以運行了：

let ws = new WebSocket('ws://localhost:8765')
ws.onmessage = (event) => {
  console.log(event.data)
}
ws.onopen = () => {
  ws.send('hello')
}

檢視並監聽日誌

我們將通過以下幾步來構建日誌檢視器：

• 首先，客戶端發起一個 WebSocket 請求，並將請求的檔案路徑包含在 URL 中，形如 ws://localhost:8765/tmp/build.log?tail=1；
• 服務端接受到請求後，將檔案路徑解析出來，順帶解析出是否要持續監聽日誌的標誌位；
• 服務端開啟日誌檔案，開始不斷向客戶端傳送日誌檔案內容。

完整的原始碼可以在 GitHub 中檢視，以下只擷取重要的部分：

@asyncio.coroutine
def view_log(websocket, path):
    parse_result = urllib.parse.urlparse(path)
    file_path = os.path.abspath(parse_result.path)
    query = urllib.parse.parse_qs(parse_result.query)
    tail = query and query['tail'] and query['tail'][0] == '1'
    with open(file_path) as f:
        yield from websocket.send(f.read())
        if tail:
            while True:
                content = f.read()
                if content:
                    yield from websocket.send(content)
                else:
                    yield from asyncio.sleep(1)
        else:
            yield from websocket.close()

其它特性

• 在實際應用中發現，瀏覽器有時不會正確關閉 WebSocket 連線，導致服務端資源浪費，因此我們新增一個簡單的心跳機制：

if time.time() - last_heartbeat > HEARTBEAT_INTERVAL:
    yield from websocket.send('ping')
    pong = yield from asyncio.wait_for(websocket.recv(), 5)
    if pong != 'pong':
        raise Exception('Ping error'))
    last_heartbeat = time.time()

• 日誌檔案中有時會包含 ANSI 顏色高亮（如日誌級別），我們可以使用 ansi2html 包來將高亮部分轉換成 HTML 程式碼：

from ansi2html import Ansi2HTMLConverter
conv = Ansi2HTMLConverter(inline=True)
yield from websocket.send(conv.convert(content, full=False))

• 最後，日誌檔案路徑也需要進行許可權檢查，本例中是將客戶端傳遞的路徑轉換成絕對路徑後，簡單判斷了路徑字首，以作許可權控制。

參考資料