宜信開源|微服務網關SIA-GateWay使用指南

1、DeskTop

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

每一個網關組包括以下四項：

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

2、首頁

首頁展現網關當前的運行狀況。

主要包含以下部分：

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

3、路由管理

路由管理分以下四部分：

3.1 新建路由

新建路由填寫以下選項：

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

後端服務策略	說明
後端服務ID	填寫註冊到註冊中心的應用名，路由匹配時將根據註冊中心的服務列表匹配對應實例
後端服務URL	路由匹配後直接轉發到填寫的URL
ListofServer	路由匹配後使用輪詢策略選擇一個實例轉發

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

3.2 路由導入導出

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

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

3.3 路由操做

路由操做分爲如下兩部分：

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

3.4 路由拓撲

點擊路由拓撲圖展現路由的實時拓撲圖，拓撲圖分爲三段：應用->網關->後端服務，若是該路由沒有請求則路由拓撲圖爲空。

4、組件管理

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

4.1 公共組件

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

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

4.2 第三方組件

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

5、網關監控

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

5.1 運行狀態監控

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

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

5.2 拓撲圖

拓撲圖展現了該網關的服務流圖，是所有路由拓撲圖的集合。

6、日誌管理

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

7、熔斷管理

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

8、註冊中心管理

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

8.1 註冊信息查詢

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

8.2 動態修改註冊中心地址

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

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

• 該網關組下無狀態爲發佈的路由
• 管理端能夠請求通新註冊中心地址

9、路由聯通性測試

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

10、網關Swagger

網關Swagger整合了註冊中心註冊的服務的所有網關接口文檔，可經過右上角選擇不一樣服務查看接口文檔。

11、系統黑名單

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

12、網關審計

網關審計展現了全部在網關管理端操做的用戶、行爲和性能，方便監控和分析用戶行爲。

十3、網關設置

網關設置分爲三部分：預警郵箱、日誌級別操做、查看版本號

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