微服務網關SIA-GateWay使用指南

一、DeskTop

DeskTop展示當前注冊的各個網關組，點擊一個 網關組 將選中該網關組并跳轉至首頁。

每個網關組包括如下四項：

• 角色值：網關應用名前綴，用于區分網關組
• 擁有實例：網關組實例個數
• 網關狀態：網關組當前狀態
• 網關描述：網關組描述信息，可修改

二、首頁

首頁展示網關當前的運行情況。

主要包含如下部分：

• 網關調用趨勢：每小時各節點調用量，共30小時
• 網關健康狀況：每小時各節點健康狀況，共30小時
• 監控告警：運行過程中發送的警告
• 網關集群狀態：各節點CPU、JVM和連接數監控，其中CPU和JVM數據取自Actuator

三、路由管理

路由管理分如下四部分：

3.1 新建路由

新建路由填寫如下選項：

• 路由ID：路由唯一標示，也是數據庫表primary key
• 網關集群組名：填寫當前網關組名，右上角可見
• 應用名稱：選填，一般填應用名
• 匹配路徑：后端服務的path
• 后端服務策略：存在如下三種選擇：

• 后端服務URL：后端服務策略選擇后端服務URL和ListofServer時填寫后端ip:port
• 前綴是否生效：選擇是則真正的匹配路徑= 匹配路徑 +公共前綴

3.2 路由導入導出

路由導入導出可用于測試環境與生產環境路由數據同步

• 路由導出：默認導出當前網關組全部路由，可選擇部分路由導出，點擊 路由導出 將下載routerList.json文件
• 路由導入：點擊 路由導入 選擇導入的路由文件，導入后將提示導入成功和失敗的路由ID，導入的路由為編輯狀態

3.3 路由操作

路由操作分為以下兩部分：

• 修改路由狀態：路由狀態分為編輯、發布、下線三種狀態，對應有發布、下線、修改、刪除和查看操作
• 路由組件管理：API網關提供了功能豐富的組件，在組件管理中綁定了路由后，可在該路由下查看或配置組件，各組件功能和用法參考組件管理

3.4 路由拓撲

點擊 路由拓撲圖 展示路由的實時拓撲圖，拓撲圖分為三段：應用->網關->后端服務，如果該路由沒有請求則路由拓撲圖為空。

四、組件管理

網關提供了功能豐富的公共組件，同時支持用戶上傳第三方組件。使用組件時首先需要在 組件管理 中綁定路由，然后在 路由管理 中查看或配置組件。

4.1 公共組件

公共組件描述說明了組件的功能和用法，分為如下幾種：

• 日志：分為請求日志組件和影響日志組件
• 灰度：分為藍綠部署組件和金絲雀組件
• 監控：統計組件，統計路由訪問情況
• 限流：限流組件，限制路由單位時間請求數
• 安全：安全認證組件和黑白名單組件

4.2 第三方組件

第三方組件由用戶自定義實現，上傳后即可使用。點擊 第三方組件 查看已經上傳的第三方組件，點擊 組件上傳 可上傳自定義的第三方組件。

五、網關監控

網關監控分為兩部分：運行狀態監控和拓撲圖

5.1 運行狀態監控

運行狀態監控包含如下監控項：

• 監控：集成Hystrix dashboard
• 日志：展示當前日志文件內容，數據來自Actuator
• JVM：監控負載、類加載、線程等，數據來自Actuator
• 內存：監控JVM內存，數據來自Actuator
• 垃圾回收：監控parnew和CMS回收器，數據來自Actuator
• 配置：包括內部和外部的配置文件，數據來自Actuator

5.2 拓撲圖

拓撲圖展示了該網關的服務流圖，是全部路由拓撲圖的集合。

六、日志管理

日志管理集成了Kibana，用戶點擊 日志管理 時將跳轉至Kibana展示網關組ES索引的日志數據。如果路由綁定了日志請求組件或日志響應組件， 可在 路由管理 - 操作 -> 請求日志組件 或 響應日志組件 跳轉。

七、熔斷管理

熔斷管理展示了網關運行過程中被Hystrix熔斷的請求信息，包括熔斷類型、錯誤信息和堆棧信息等。

八、注冊中心管理

注冊中心管理主要包括兩部分：注冊信息查詢和動態修改注冊中心地址

8.1 注冊信息查詢

注冊信息來自于當前網關組所在的Eureka，點擊 查詢 符合條件的應用。

8.2 動態修改注冊中心地址

Eureka服務端地址默認使用本地配置，用戶可通過 設置Eureka 修改Eureka地址，設置成功后新設置的Eureka地址將保存在數據庫中， 同時通知該網關組節點修改內存中注冊中心地址并重新注冊。點擊 重置Eureka 將清除數據庫中的Eureka地址并通知該網關組節點使用本地配置。 設置/重置后將彈窗提示結果。

注冊中心地址設置/重置成功條件：

• 該網關組下無狀態為 發布 的路由
• 管理端可以請求通新注冊中心地址

九、路由聯通性測試

支持GET和POST兩種方式測試路由是否聯通。

十、網關Swagger

網關Swagger整合了注冊中心注冊的服務的全部網關接口文檔，可通過右上角選擇不同服務查看接口文檔。

十一、系統黑名單

系統黑名單可設置全局黑名單，目前支持IP攔截策略，設置后所有來自該IP的請求都將被攔截。

十二、網關審計

網關審計展示了所有在網關管理端操作的用戶、行為和性能，方便監控和分析用戶行為。

十三、網關設置

網關設置分為三部分：預警郵箱、日志級別操作、查看版本號

13.1 預警郵箱

發生預警時將發送預警郵件至設置的郵箱

13.2 日志級別操作

網關日志級別默認為INFO，用戶調試時可查看或動態調整日志級別。日志名可選com.creditease和root，日志級別可選INFO和DEBUG。

在Logback等日志框架中，logger層級類似于java繼承，以名稱組織，使用"."將logger名切分父logger與子logger，當子logger未設置日志級別， 則使用父日志級別，直到ROOT，ROOT相當于Java中的Object。子日志級別被設置后，父（含ROOT）日志級別將不再對子日志有效， 類似于java子類重寫父類方法。

13.3 查看版本號

網關版本號用于區分網關各實例的版本，默認配置下版本號形式為：sag_x.y_timestamp，timestamp為打包時間戳， 可在配置文件中通過 zuul.version 修改。

SIA相關開源產品鏈接

• 微服務任務調度框架 ：https://github.com/siaorg/sia-task
• 微服務路由網關 ：https://github.com/siaorg/sia-gateway
• Rabbitmq隊列服務PLUS：https://github.com/siaorg/sia-rabbitmq-plus