如何在 OpenResty Edge 中配置 Webhook:閘道器伺服器離線告警
在 OpenResty Edge 中配置 webhook,只需進入 Global Config → Webhooks 建立一個 webhook,並訂閱某個事件(例如 Gateway Server Offline 閘道器伺服器離線)。此後每當該事件發生,Edge Admin 就會自動向您自己實現的自定義 API 傳送 HTTP 請求。Gateway Server Offline 事件涵蓋伺服器下線的任何原因——無論是 Edge 主動健康探測發現的下線、伺服器自身異常,還是在 Edge Admin 裡手動標記離線——因此您的告警 API 能捕獲每一次下線。本教程演示如何建立、觸發並驗證這樣一個 webhook。若想先了解為甚麼事件驅動的 webhook 通知優於基於輪詢的監控,請參閱 OpenResty Edge Webhook 機制解讀。
在 OpenResty Edge Admin 中建立一個 webhook
讓我們進入 OpenResty Edge 的 Web 控制檯。這是我們控制檯的樣例部署。每個使用者都有自己的本地部署。
首先,我們需要建立一個 webhook。進入 “Global Config” 頁面。
選擇 “Webhooks”。
建立一個 webhook。
這裡我們建立了一個 webhook,它的作用是在閘道器伺服器離線時,將 HTTP 請求傳送到使用者自己實現的 API 上。
這裡提供了很多內建的事件供您選擇,我們也可以根據您的需求新增更多的事件。
這裡我們選擇 “Gateway Server Offline” 事件。
點選 “Create” 之後,新的 webhook 就新增完成了。
透過閘道器伺服器離線事件觸發 webhook
為了觸發這個 webhook,我們來將一個閘道器伺服器設定成離線。
使用這個伺服器。
開啟設定頁面。
請注意這個伺服器現在是線上狀態。
將它設定為離線狀態。
儲存。
檢視 webhook 的執行歷史
現在讓我們進入 webhooks 頁面檢視執行歷史。
選擇 “Webhooks”。
點選 “詳情” 按鈕。
可以看到 webhook 的執行歷史,說明觸發的事件已經成功傳送了。
除了這裡演示的在 Edge Admin 裡手動標記下線,OpenResty Edge 還會主動對各閘道器伺服器做健康探測——一旦探測到伺服器下線,或伺服器自身發生異常,同樣會觸發 Gateway Server Offline 事件。關於用這類事件驅動告警與自動化運維的思路,可參閱 OpenResty Edge Webhook:用事件驅動通知取代輪詢的閘道器狀態推送。
常見問題
OpenResty Edge 中有哪些事件可以觸發 webhook?
OpenResty Edge 提供了多種內建事件供 webhook 訂閱,例如本教程使用的 Gateway Server Offline(閘道器伺服器離線)事件。如果需要的事件尚未內建,我們也可以根據需求新增。每當訂閱的事件發生時,Edge Admin 就會向您配置的自定義 API 傳送一次 HTTP 請求。
Gateway Server Offline 事件只在手動將伺服器標記為離線時才觸發嗎?
不是。除了在 Edge Admin 裡手動標記離線,OpenResty Edge 還會主動對各閘道器伺服器做健康探測——一旦探測到伺服器下線,或伺服器自身發生異常,都會觸發 Gateway Server Offline 事件。因此訂閱該事件的 webhook 能捕獲每一次下線,而不只是計劃內的手動操作。
如何確認 webhook 確實傳送成功了?
在 Edge Admin 中進入 Webhooks 頁面,點選對應 webhook 的“詳情”按鈕即可檢視它的執行歷史。其中的每條記錄都表示一次被觸發的事件已成功傳送到您的自定義 API,因此您無需在自己的介面上額外埋點即可驗證投遞情況。
關於 OpenResty Edge
OpenResty Edge 是一款專為微服務和分散式流量架構設計的全能型閘道器軟體,由我們自主研發。它集流量管理、私有 CDN 構建、API 閘道器、安全防護等功能於一體,幫助您輕鬆構建、管理和保護現代應用程式。OpenResty Edge 擁有業界領先的效能和可擴充套件性,能夠滿足高併發、高負載場景下的苛刻需求。它支援排程 K8s 等容器應用流量,並可管理海量域名,輕鬆滿足大型網站和複雜應用的需求。
如果你喜歡這個教程,請訂閱這個部落格網站和我們的 B 站頻道。謝謝!
關於作者
章亦春是開源 OpenResty® 專案創始人兼 OpenResty Inc. 公司 CEO 和創始人。
章亦春(Github ID: agentzh),生於中國江蘇,現定居美國灣區。他是中國早期開源技術和文化的倡導者和領軍人物,曾供職於多家國際知名的高科技企業,如 Cloudflare、雅虎、阿里巴巴, 是 “邊緣計算“、”動態追蹤 “和 “機器程式設計 “的先驅,擁有超過 22 年的程式設計及 16 年的開源經驗。作為擁有超過 4000 萬全球域名使用者的開源專案的領導者。他基於其 OpenResty® 開源專案打造的高科技企業 OpenResty Inc. 位於美國矽谷中心。其主打的兩個產品 OpenResty XRay(利用動態追蹤技術的非侵入式的故障剖析和排除工具)和 OpenResty Edge(最適合微服務和分散式流量的全能型閘道器軟體),廣受全球眾多上市及大型企業青睞。在 OpenResty 以外,章亦春為多個開源專案貢獻了累計超過百萬行程式碼,其中包括,Linux 核心、Nginx、LuaJIT、GDB、SystemTap、LLVM、Perl 等,並編寫過 60 多個開源軟體庫。
關注我們
如果您喜歡本文,歡迎關注我們 OpenResty Inc. 公司的部落格網站 。也歡迎掃碼關注我們的微信公眾號:
翻譯
我們提供了英文版原文和中譯版(本文)。我們也歡迎讀者提供其他語言的翻譯版本,只要是全文翻譯不帶省略,我們都將會考慮採用,非常感謝!






































