前言
Fizz Gateway 是一個基於 Java開發的微服務聚合網關,能夠實現熱服務編排聚合、自動授權選擇、線上服務腳本編碼、在線測試、高性能路由、API審核管理、回調管理等目的,擁有強大的自定義插件系統可以自行擴展,並且提供友好的圖形化配置界面,能夠快速幫助企業進行API服務治理、減少中間層膠水代碼以及降低編碼投入、提高 API 服務的穩定性和安全性。Fizz Gateway致力於讓企業更好的解放雙手,寫更少得代碼,實現更多想要的效果。 接下來,將會大概介紹Fizz 后台管理系統的使用。
- 歡迎大家使用: http://demo.fizzgate.com/#/login
功能介紹
經過不斷的迭代,Fizz管理后台功能模塊也越發豐富了。截止v2.6.1版本,我們已有功能模塊如下:
-
網關管理
- 路由管理:支持服務注冊中心、負載均衡、配置調用方、內置的key-auth, JWT, basic-auth等鑒權方式、配置插件、配正則表達式、路徑測試,校驗配置的路由是否正確、配置禁止訪問的路由 等功能
- 插件管理:維護插件元數據,定義路由級別的自定義屬性、插件級別的自定義配置信息
- 網關分組:維護分組元數據,將網關實例IP與分組關聯,通過為不同的分組配置不同的路由策略,從而實現網關的分組管理
- appID管理:維護應用鑒權信息,可配置是否啟用簽名、是否啟用IP白名單,AppID級別的自定義配置供自定義插件使用
- 接口統計: Fizz網關會將訪問請求數據(IP地址、網關分組、服務、應用、請求方法、API Path、請求時間)推送到Kafka中,管理后台消費Kafka消息統計接口訪問數據
- 公共資源: 可以定義鍵(Key)值(Value)對數據,在服務編排接口中通過引用鍵(Key)來獲取值(Value),從而避免將值硬編碼在接口中。
- 注冊中心: 護注冊中心的配置,可配置多個注冊中心,類型支持Eureka、Nacos,配置格式支持yml、properties。下面介紹注冊配置功能。
- 網關實例: 用於查看當前集群中啟動的網關實例,可查看各個網關實例當前的路由配置和服務編排配置
- 設置管理: 用於管理gateway的配置,包括基礎設置、錯誤響應碼、鏈路跟蹤、自定義鑒權頭、Web Client、日志設置、服務編排、Dubbo設置、專線配置
- 網關日志: 打印並展示網關日志
-
流控管理
- 默認規則:用於配置全局的流控規則,包含全局配置、服務默認配置、appid默認配置,可從並發數、QPS兩個維度對流量進行限制,支持自定義觸發限流后響應報文
- 接口流控:用於配置服務、路徑級別的流控規則,可從並發數、QPS兩個維度對流量進行限制,支持自定義觸發限流后響應報文。
- appID流控:用於配置appID(網關從請求的請求頭中獲取,更多詳情請查看appID管理功能介紹)級別的流控規則,可從並發數、QPS兩個維度對流量進行限制,支持自定義觸發限流后響應報文。
- 來源IP流控:用於配置來源IP級別的流控規則,可從並發數、QPS兩個維度對流量進行限制,支持自定義觸發限流后響應報文。
-
熔斷管理
- 默認規則:用於配置全局的熔斷規則,包含服務默認配置,熔斷策略支持異常比例、異常數,恢復策略支持嘗試恢復、逐步恢復、立即恢復,支持自定義觸發熔斷后響應報文
- 熔斷規則:於配置服務、路徑級別的熔斷規則,熔斷策略支持異常比例、異常數,恢復策略支持嘗試恢復、逐步恢復、立即恢復,支持自定義觸發熔斷后響應報文
-
回調管理
- 回調配置:配置哪些請求需要保存,及如何響應這些請求
- 回調回放:對已保存的請求,如何回放
- 回放日志:回溯回放操作
-
服務編排
- 接口列表:維護聚合接口
- 服務管理:維護服務元數據
- 操作日志:記錄了聚合接口的新增、修改、發布、下線、回滾、刪除操作日志
- 網關緩存:用於查詢Fizz網關實例本地緩存的已發布接口信息
-
編排審核
- 我的申請:用於發布|下線申請過程的相關操作
- 待審核:用於審核發布|下線申請
- 審核日志:記錄了發布|下線申請的審核操作日志
-
RPC管理
- 服務聲明:用於定義底層的RPC服務信息,支持Dubbo、gRPC、HTTP,定義后的服務聲明可在服務編排接口中引用使用
- 接口管理:定義底層的RPC接口信息,定義后的接口信息可在服務編排接口中引用使用
-
文檔管理
- 文檔集:文檔集是由一個或多個接口文檔組成的文檔集合,每個文檔集都會生成一個唯一訪問地址
- 接口文檔:對接口模塊進行建檔管理
- 認證信息:維護認證信息數據。認證信息是在發送請求時候,附帶於請求頭、Query參數上,會作為請求參數傳遞給后台
- 環境信息:用於管理接口請求環境。
-
公網專線
- 專線配對:用於專線的配對,展示已配對的專線信息,對已開通的專線業務提供入口
- 專線業務:維護在專線上運行的業務,支持接口、網站兩種業務類型
- 專線管理:專線管理維護專線信息,定義專線上可運行的專線業務,生成配對碼,限制配對次數。
-
告警管理
- 訂閱告警:配置用戶訂閱網關告警,告警類型支持接口超時、接口錯誤、限流告警、熔斷告警,當告警觸發時通過郵件發送
- 告警列表:用於查看網關的歷史告警信息列表
使用說明
登錄
輸入賬號、密碼和驗證碼進行登錄。登錄成功后,會直接跳轉到 Fizz 后台主界面。
后台主架構
-
在主界面左側,可以對菜單欄進行折疊、展開。
-
在后台主界面的右側,可以查看最新的版本情況、使用文檔、主題切換、全屏查看情況等。
-
版本情況及授權:點擊“標准版2.6.1”按鈕,可以查看Fizz Gateway 商業授權信息,以及粘貼授權證書進行授權更新。
-
點擊 "使用文檔",可以查看系統的詳細使用說明。
-
主題切換: 主題包含默認主題、白色主題、炫彩主題、智能主題、iview主題和vip主題,可按需要進行切換。同時對登錄圖片和logo圖片的自定義上傳
-
首頁
系統首頁通過圖表、具體統計數據,清晰的展示了平均響應時間、QPS、並發數、請求數、最近24小時的top 10 服務列表、接口總數和訪問次數的情況。
- 實時數據:對今日接口總數、今日訪問次數、當前QPS和當前並發數 這四個維度進行統計
- 響應時間、QPS、並發數、請求數: 多個查詢篩選條件,實時展示
- 最近24小時的top 10:以Top 10 慢服務、Top 10 異常服務、Top 10 活躍服務、Top 10 AppID 這四個維度進行統計
- 接口總數和訪問次數統計: 以折線圖形式展示,支持 網關分組、時間范圍 兩個維度的篩選。
其他模塊
對於其他模塊的具體使用,建議移步Fizz 官網查閱詳細的使用說明,這里就不一一介紹了。傳送門地址: https://www.fizzgate.com/fizz/guide/intro/ (強烈建議閱讀了解)
Fizz網關介紹
Fizz Gateway 是一個基於 Java開發的微服務聚合網關,能夠實現熱服務編排聚合、自動授權選擇、線上服務腳本編碼、在線測試、高性能路由、API審核管理、回調管理等目的,擁有強大的自定義插件系統可以自行擴展,並且提供友好的圖形化配置界面,能夠快速幫助企業進行API服務治理、減少中間層膠水代碼以及降低編碼投入、提高 API 服務的穩定性和安全性。
GitHub: https://github.com/wehotel/fizz-gateway-community
碼雲:https://gitee.com/fizzgate/fizz-gateway
入門教程:https://www.fizzgate.com/fizz/guide/GettingStarted/
作者:大松鼠