OpenResty Edge 中,錯誤日誌可以在兩個地方檢視:每個應用在 Admin 控制檯裡都有自己的錯誤日誌頁面,而 Dashboard 上則彙總展示了所有閘道器伺服器採集來的全域性錯誤日誌。兩者都支援按請求 ID、閘道器、伺服器、日誌級別和時間區間過濾,你也隨時可以下鑽到某臺閘道器或 Admin 伺服器上的原始 error.log 檔案。本教程會依次演示這些入口,以及它們如何與基於請求 ID(Req-ID)的單請求追蹤、與訪問日誌相關聯。

OpenResty Edge 錯誤日誌概覽示意圖

如何在 OpenResty Edge 中檢視應用錯誤日誌

像往常一樣,讓我們進入 OpenResty Edge 的 Admin Web 控制檯。這是我們控制檯的樣本部署。每個使用者都有自己的本地部署。

OpenResty Edge Admin 控制檯登入介面

我們繼續使用 test-edge.com 域名的樣本應用。

應用列表中的 test-edge.com 樣本應用

進入這個應用。

在控制檯中進入 test-edge.com 應用

點選這裡檢視該應用的錯誤日誌。

應用錯誤日誌頁面的選單入口

可以看到,這裡已經有了一些錯誤日誌記錄。這個頁面顯示了錯誤日誌相關的一些重要資訊。

應用錯誤日誌頁面列出已記錄的錯誤條目

比如說請求 ID,錯誤日誌資訊,主機名,請求體,客戶端 IP 地址等等。

現在我們來對應用做一些改動。改動之後再訪問 test-edge.com 這個域名會生成一個新的錯誤日誌資訊。

這裡我們已經定義好了一個頁面規則。

test-edge.com 現有的頁面規則

這個頁面規則設定了一個反向代理到一個預先定義的上游。

頁面規則配置為反向代理到上游

讓我們轉到 Upstreams 頁面。

OpenResty Edge 的上游配置頁面

編輯上游伺服器。

編輯上游伺服器條目

停用這個上游伺服器。上游伺服器被停用之後,我們訪問應用時將會得到一個 Bad Gateway 的錯誤。

停用上游伺服器以觸發 Bad Gateway 錯誤

儲存這個改動。

儲存上游伺服器的改動

像往常一樣,需要釋出一個新的版本來推送我們剛才的改動。

建立新版本以推送修改後的頁面規則

點選這個按鈕。

控制檯中的版本釋出確認按鈕

釋出!

將版本釋出到所有閘道器伺服器

新版本現在已經同步到所有的閘道器伺服器上了。

版本已同步到所有閘道器伺服器

現在,新的頁面規則已經被推送到所有的閘道器叢集和伺服器。

配置同步到閘道器叢集——同步動畫開始

配置同步到閘道器叢集——同步進行中

配置同步到閘道器叢集——同步完成

這些配置的變化不需要伺服器過載、重啟或二進位制升級。所以它是非常高效和可擴充套件的。

無需過載或重啟的實時配置同步

現在來傳送一個請求。

在終端上,用 curl 傳送請求。

curl -sSI http://test-edge.com

在終端向 test-edge.com 傳送 curl 請求

可以看到返回了 Bad Gateway 錯誤,這個錯誤將被記錄在應用的錯誤日誌中。

終端顯示 502 Bad Gateway 響應

而且可以看到,伺服器端的響應裡有一個請求 ID(Req-ID)。複製這個 ID,用它來查詢相應的日誌資訊。

響應頭中顯示的 Req-ID 請求 ID 值

現在回到應用的錯誤日誌頁面。檢查錯誤日誌資訊。

回到應用錯誤日誌頁面定位新生成的條目

不出所料,剛才的請求生成了錯誤日誌。新生成的錯誤日誌出現在列表的頂部。

列表頂部新生成的 Bad Gateway 錯誤日誌

按請求 ID、閘道器、伺服器與日誌級別過濾錯誤日誌

這個應用的錯誤日誌比較少。現在來看一下我們線上其他應用的錯誤日誌。

轉到應用列表頁。

包含多個線上域名的應用列表頁

讓我們看看 OpenResty.com 網站的錯誤日誌。

選擇 OpenResty 網站應用

轉到該頁面。

開啟 OpenResty 網站應用

轉到錯誤日誌頁面。這裡記錄了更多的錯誤日誌。

openresty.com 的錯誤日誌頁面,記錄了大量條目

頂部的過濾查詢條件有利於準確定位問題。

用於定位問題的錯誤日誌過濾查詢條件

例如我們可以透過請求 ID 來過濾資訊。

按請求 ID 過濾錯誤日誌資訊

或者透過閘道器。

按閘道器過濾錯誤日誌資訊

伺服器。

按伺服器過濾錯誤日誌資訊

錯誤日誌級別。

按錯誤日誌級別過濾錯誤日誌資訊

以及時間間隔。

按時間間隔過濾錯誤日誌資訊

現在來試試透過閘道器過濾訊息。

選擇一個閘道器來過濾錯誤日誌資訊

選擇 aws-us-west 閘道器。

按 aws-us-west 閘道器過濾

可以看到,aws-us-west 閘道器下沒有任何錯誤日誌。

OpenResty Edge 的三類全域性錯誤日誌

在瞭解了應用的錯誤日誌之後,我們再來看看全域性錯誤日誌。全域性錯誤日誌顯示在 Dashboard 頁面上。

Dashboard 頁面上的全域性錯誤日誌區域

Dashboard 上的全域性錯誤日誌入口

現在轉到 Dashboard 頁面去看看全域性錯誤日誌。

導航到 Dashboard 全域性錯誤日誌

可以看到有三種型別的錯誤日誌。

三類全域性錯誤日誌:全域性、Admin 站點、日誌伺服器

全域性錯誤日誌。

全域性錯誤日誌標籤頁

Admin 站點的錯誤日誌。

Admin 站點錯誤日誌標籤頁

日誌伺服器的錯誤日誌。

日誌伺服器錯誤日誌標籤頁

先來看看全域性錯誤日誌。

檢視全域性錯誤日誌列表

全域性錯誤日誌是由閘道器伺服器收集的,不隸屬於任何應用。

全域性錯誤日誌由閘道器伺服器收集,不隸屬任何應用

可以過濾錯誤日誌。

過濾全域性錯誤日誌

繼續看一下 Admin 站點的錯誤日誌。

開啟 Admin 站點錯誤日誌

這些錯誤日誌是從 Admin 控制檯收集的。

Admin 站點錯誤日誌由 Admin 控制檯收集

我們還支援對日誌進行條件過濾。

對 Admin 站點錯誤日誌進行條件過濾

例如可以選擇日誌級別 “Error”。

選擇 Error 日誌級別過濾條件

可以看到 “Error” 級別和重複次數大於 1 的日誌被高亮顯示。

高亮顯示的 Error 級別、重複次數大於 1 的日誌

最後,來看一下日誌伺服器的錯誤日誌。

開啟日誌伺服器錯誤日誌

本頁面顯示的錯誤日誌來自 OpenResty Edge 日誌伺服器。

來自 OpenResty Edge 日誌伺服器的錯誤日誌

在這裡我們也可以過濾日誌。

過濾日誌伺服器錯誤日誌

可以看到,全域性錯誤日誌和應用錯誤日誌都有日誌級別,但不是所有級別的日誌都會被系統上報。

對比全域性與應用日誌可用的日誌級別

我們可以在全域性配置頁面設定要上報的日誌級別。

在全域性配置頁面設定要上報的日誌級別

這裡我們把它設定為 “warn”,這意味著只會上報警告以及比警告級別更高的日誌。

將上報日誌級別設定為 warn

可以設定的錯誤日誌級別有 “warn”、“error”、“crit”、“alert” 等等。

可用日誌級別:warn、error、crit、alert

在你的本地部署中,你可以設定任意的日誌級別。

如何檢視閘道器與 Admin 伺服器上的 error.log 檔案

現在讓我們來登入 OpenResty Edge 閘道器伺服器,看看 error.log 檔案。

透過 SSH 登入閘道器伺服器

檢查最後一條錯誤日誌資訊。

在閘道器伺服器上檢查最後一條錯誤日誌資訊

閘道器伺服器的錯誤日誌資訊都寫在這裡。

閘道器伺服器 error.log 檔案的位置

執行該命令。

執行命令讀取閘道器的 error.log

我們可以看到閘道器伺服器的錯誤日誌資訊。

終端中顯示的閘道器伺服器錯誤日誌資訊

退出伺服器。

退出閘道器伺服器的 SSH 會話

然後,我們登入 OpenResty Edge 的 Admin 伺服器,檢視 error.log 檔案。

登入 OpenResty Edge Admin 伺服器

看一下最後的錯誤日誌資訊。

在 Admin 伺服器上檢查最後的錯誤日誌資訊

OpenResty Edge Admin 的錯誤日誌資訊寫在這裡。

OpenResty Edge Admin error.log 檔案的位置

執行該命令。

執行命令讀取 Admin 的 error.log

可以看到 OpenResty Edge Admin 的錯誤日誌資訊。

終端中顯示的 OpenResty Edge Admin 錯誤日誌資訊

常見問題

在 OpenResty Edge 中的哪裡可以檢視錯誤日誌?

有兩個地方。每個應用在 Admin 控制檯裡都有自己的錯誤日誌頁面,展示該應用各域名的錯誤。此外,Dashboard 上單獨展示了跨所有閘道器伺服器採集的全域性錯誤日誌。如果要看原始檔案,你也可以 SSH 登入到某臺閘道器或 Admin 伺服器,直接讀取它的 error.log

如何找到某個具體請求的錯誤日誌?

OpenResty Edge 的每個響應都會在響應頭裡帶上一個請求 ID(顯示為 Req-ID)。複製這個值,貼上到應用錯誤日誌頁面的請求 ID 過濾條件裡,就能直接跳到對應的條目。關於請求追蹤的完整機制,參見甚麼是請求 ID

三類全域性錯誤日誌分別是甚麼?

在 Dashboard 上,全域性錯誤日誌分為全域性錯誤日誌(由閘道器伺服器採集,不隸屬於任何應用)、Admin 站點錯誤日誌(由 Admin 控制檯採集)和日誌伺服器錯誤日誌(由 OpenResty Edge 日誌伺服器採集)。每一類都可以按日誌級別及其他條件過濾。

如何設定要上報哪些錯誤日誌級別?

要上報的日誌級別在全域性配置頁面設定。例如設為 warn,就表示只上報 warn 級別及更高階別的訊息。可選級別包括 warnerrorcritalert。在你自己的本地部署中,可以任選所需級別。

如何過濾錯誤日誌以定位問題?

錯誤日誌頁面支援按請求 ID、閘道器、伺服器、錯誤日誌級別和時間區間來縮小結果範圍。例如,你可以選中單個閘道器(如 aws-us-west)來確認錯誤是否只集中在某一處,或者選中 Error 級別,只顯示最嚴重的訊息。

關於 OpenResty Edge

OpenResty Edge 是一款專為微服務和分散式流量架構設計的全能型閘道器軟體,由我們自主研發。它集流量管理、私有 CDN 構建、API 閘道器、安全防護等功能於一體,幫助您輕鬆構建、管理和保護現代應用程式。OpenResty Edge 擁有業界領先的效能和可擴充套件性,能夠滿足高併發、高負載場景下的苛刻需求。它支援排程 K8s 等容器應用流量,並可管理海量域名,輕鬆滿足大型網站和複雜應用的需求。

如果你喜歡這個教程,請訂閱這個部落格網站和我們的 YouTube 頻道B 站頻道。謝謝!

關於作者

章亦春是開源 OpenResty® 專案創始人兼 OpenResty Inc. 公司 CEO 和創始人。

章亦春(Github ID: agentzh),生於中國江蘇,現定居美國灣區。他是中國早期開源技術和文化的倡導者和領軍人物,曾供職於多家國際知名的高科技企業,如 Cloudflare、雅虎、阿里巴巴, 是 “邊緣計算“、”動態追蹤 “和 “機器程式設計 “的先驅,擁有超過 22 年的程式設計及 16 年的開源經驗。作為擁有超過 4000 萬全球域名使用者的開源專案的領導者。他基於其 OpenResty® 開源專案打造的高科技企業 OpenResty Inc. 位於美國矽谷中心。其主打的兩個產品 OpenResty XRay(利用動態追蹤技術的非侵入式的故障剖析和排除工具)和 OpenResty Edge(最適合微服務和分散式流量的全能型閘道器軟體),廣受全球眾多上市及大型企業青睞。在 OpenResty 以外,章亦春為多個開源專案貢獻了累計超過百萬行程式碼,其中包括,Linux 核心、Nginx、LuaJITGDBSystemTapLLVM、Perl 等,並編寫過 60 多個開源軟體庫。

關注我們

如果您喜歡本文,歡迎關注我們 OpenResty Inc. 公司的部落格網站 。也歡迎掃碼關注我們的微信公眾號:

我們的微信公眾號

翻譯

我們提供了英文版原文和中譯版(本文)。我們也歡迎讀者提供其他語言的翻譯版本,只要是全文翻譯不帶省略,我們都將會考慮採用,非常感謝!