在本教程中,我們將演示如何在 OpenResty Edge 的 Web 控制檯中配置自定義錯誤頁。

自定義模板建立

今天,我將演示如何在 OpenResty Edge 中使用自定義模板建立錯誤頁面。讓我們先進入控制檯。這是我們控制檯的示例部署。每個使用者都會有自己的部署。

Screenshot

首先,我們點選“Global Config”。

Screenshot

然後,我們進入“Global Page Templates”頁面。在這裡,我們可以建立一些全域性頁面模板,這些模板可以自定義錯誤頁面或 WAF 阻止頁面。

Screenshot

現在,我們可以點選這個按鈕來新增一個簡單的模板。

Screenshot

在這裡將模板命名為error-page-template-demo

Screenshot

對於 HTML 的內容,您可以使用一些預定義的變數來自定義它:

Screenshot

比如“CLIENT_IP”,

Screenshot

“CLIENT_COUNTRY”,

Screenshot

以及“HOST”。

Screenshot

現在我們可以輸出客戶端 IP 地址。

Screenshot

也可以輸出請求 ID 和 user agent 作為示例。

Screenshot

然後我們點選儲存。

Screenshot

由於這是全域性配置,對該頁面模板的更改將立即釋出並同步到所有閘道器伺服器。

Screenshot

模板的應用

接下來,轉到我們的示例應用:

Screenshot

然後搜尋 test-edge.com,將頁面模板應用為自定義的錯誤頁面。

Screenshot

進入應用。

Screenshot

然後進入“Page Rules”頁面。

Screenshot

點選“New Rules"。

Screenshot

我們新增一個新的動作。

Screenshot

您可以在這裡選擇或搜尋動作型別。

Screenshot

搜尋“customize error page”。

Screenshot

在這裡,你可以選擇錯誤頁對應的 HTTP 響應狀態碼。

Screenshot

這裡我們只選擇 “404”。

Screenshot

有幾種設定定製錯誤頁面的方法,比如使用原始 HTML、 Backend URL,或者之前已經上傳的全域性靜態檔案。

Screenshot

現在,選擇使用我們剛剛定義並命名為“error-page-template-demo”的全域性頁面模板。

Screenshot

接下來,我們需要再新增一個動作。

Screenshot

點選搜尋框。

Screenshot

搜尋“intercept upstream errors”。

Screenshot

由於我們已經配置了代理到上游,啟用此操作可以攔截上游錯誤。

Screenshot

此外,我們需要將這個規則放在其他規則之前,這樣我們就可以返回我們自定義的錯誤頁面。

Screenshot

儲存即可。

Screenshot

通常,我們需要釋出一個新版本來推送"new page rule"。

Screenshot

點選這裡釋出待處理的變更。

Screenshot

點選發布!

Screenshot

現在已經完全同步了。

Screenshot

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

Embeded video

我們的配置更改無需重新載入、重啟或二進位制升級伺服器,因此非常高效且易於擴充套件。

Embeded image

頁面規則的驗證

讓我們透過測試一個閘道器伺服器以驗證這個規則。

Screenshot

複製這臺舊金山閘道器伺服器的 IP 地址。

Screenshot

然後在終端上進行測試。

Screenshot

這是我們前面看到的舊金山閘道器伺服器的 IP 地址。

Screenshot

這是一個不存在的隨機生成的 URL,所以可以看出這確實是一個 404 響應。

Screenshot

繼續執行指令。

Screenshot

我們可以將請求資訊以 HTML 格式輸出,這對排查錯誤頁面的原因會很有幫助。

Screenshot

如果您想輸出更多資訊或更改錯誤頁面的樣式,您只需編輯頁面模板即可。變更將立即釋出並生效。

Screenshot

錯誤頁的全域性重寫規則

如果您希望為所有應用使用相同的錯誤頁面,還可以配置一個全域性重寫規則。

Screenshot

前往“Global Rewrite Rules”頁面。

Screenshot

透過點選這裡新增一個新規則,它與應用程式中的“Page Rules”幾乎完全相同。 我們會透過另一個教程來介紹這一功能。

Screenshot

今天我所要分享的內容就是這些。

關於作者

章亦春是開源 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. 公司的部落格網站 。也歡迎掃碼關注我們的微信公眾號:

我們的微信公眾號

翻譯

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