您可以參考本文在API Gateway控制台配置Trace鏈路追蹤,將日誌上傳到阿里雲鏈路追蹤平台,鏈路追Tracing Analysis 提供了完整的調用鏈路還原、調用請求量統計、鏈路拓撲、應用依賴分析等工具,可以協助使用者提高開發診斷效率。本功能僅支援專享執行個體。
前提條件
API Gateway為專享執行個體
1 鏈路追蹤授權
1.1 登入鏈路追蹤控制台。
1.2 在概覽頁面上,單擊立即授權,授權鏈路追蹤讀寫您的Log Service。
1.3 在雲資源訪問授權頁面上,選擇所需的許可權,並單擊同意授權。
1.4 授權後可在概覽>接入流程,單擊查看存取點資訊,在存取點資訊頁,叢集資訊選擇開啟顯示Token,用戶端採集工具選擇Jaeger。即可查看到詳細的存取點資訊。儲存通過HTTP上報資料中的存取點地址。
2 API Gateway配置Trace鏈路追蹤
2.1 登入API Gateway控制台。
2.2 在左側導覽列選擇API 管理>分組管理。在分組列表單擊API分組進入分組詳情。在分組詳情頁即可配置。
Trace欄位位置:指定Trace欄位的位置,可選位置有Header、Query。
Trace欄位名稱:自訂Trace欄位的名稱。
如果用戶端提供trace欄位並且該欄位的值符合標準的TraceId格式,即16位或32位的十六進位數。網關會透傳給後端,並以該欄位的值作為TraceId向鏈路追蹤平台上報日誌資訊,並且會記錄在使用者API Gateway日誌的 `CustomTraceId` 欄位。
如果用戶端未提供Trace欄位或欄位值不符合規範,網關會隨機產生一個TraceId向鏈路追蹤平台上報資訊。
透傳或產生EAGLEEYE相關頭(Eagleeye-Rpcid、Eagleeye-Traceid、Eagleeye-Sampled):勾選配置後,若用戶端傳了EAGLEEYE相關頭,網關會將相關頭透傳給後端服務,若沒有傳,網關將會產生相關頭並傳給後端服務。(共用執行個體/Serverless執行個體和專享執行個體均可使用)
透傳或產生B3相關頭(X-B3-traceid、X-B3-Parentspanid、X-B3-Spanid、X-B3-Sampled):勾選配置後,若用戶端傳了B3相關頭,網關會將相關頭透傳給後端服務,若沒有傳,網關將會產生相關頭並傳給後端服務。(共用執行個體/Serverless執行個體和專享執行個體均可使用)
將追蹤日誌上傳到阿里雲鏈路追蹤平台(僅專享執行個體使用):
應用程式名稱:自訂鏈路追蹤的應用程式名稱。
存取點:填寫1.4中的存取點地址,同region建議使用內網存取點,可以大幅提高效率。
日誌採樣策略:支援全部上傳、按百分比上傳、每秒上傳固定數,根據需要選擇即可。
API Gateway配置Trace鏈路追蹤後的請求可以在鏈路追蹤控制台查看到請求鏈路。
關於鏈路追蹤的使用可參考查看介面調用情況