前提條件

• API網(wǎng)關(guān)為專(zhuān)享實(shí)例

• 開(kāi)通鏈路追蹤

• 開(kāi)通日志服務(wù)

1 鏈路追蹤授權(quán)

1.1 登錄鏈路追蹤控制臺(tái)。

1.2 在概覽頁(yè)面上，單擊立即授權(quán)，授權(quán)鏈路追蹤讀寫(xiě)您的日志服務(wù)。

1.3 在云資源訪(fǎng)問(wèn)授權(quán)頁(yè)面上，選擇所需的權(quán)限，并單擊同意授權(quán)。

1.4 授權(quán)后可在概覽>接入流程，單擊查看接入點(diǎn)信息，在接入點(diǎn)信息頁(yè)，集群信息選擇打開(kāi)顯示Token，客戶(hù)端采集工具選擇Jaeger。即可查看到詳細(xì)的接入點(diǎn)信息。保存通過(guò)HTTP上報(bào)數(shù)據(jù)中的接入點(diǎn)地址。

2 API網(wǎng)關(guān)配置Trace鏈路追蹤

2.1 登錄API網(wǎng)關(guān)控制臺(tái)。

2.2 在左側(cè)導(dǎo)航欄選擇API 管理>分組管理。在分組列表單擊API分組進(jìn)入分組詳情。在分組詳情頁(yè)即可配置。

• Trace字段位置：指定Trace字段的位置，可選位置有Header、Query。

• Trace字段名稱(chēng)：自定義Trace字段的名稱(chēng)。

  • 如果客戶(hù)端提供trace字段并且該字段的值符合標(biāo)準(zhǔn)的TraceId格式，即16位或32位的十六進(jìn)制數(shù)。網(wǎng)關(guān)會(huì)透?jìng)鹘o后端，并以該字段的值作為T(mén)raceId向鏈路追蹤平臺(tái)上報(bào)日志信息，并且會(huì)記錄在用戶(hù)API網(wǎng)關(guān)日志的 `CustomTraceId` 字段。

  • 如果客戶(hù)端未提供Trace字段或字段值不符合規(guī)范，網(wǎng)關(guān)會(huì)隨機(jī)生成一個(gè)TraceId向鏈路追蹤平臺(tái)上報(bào)信息。

• 透?jìng)骰蛏蒃AGLEEYE相關(guān)頭（Eagleeye-Rpcid、Eagleeye-Traceid、Eagleeye-Sampled）：勾選配置后，若客戶(hù)端傳了EAGLEEYE相關(guān)頭，網(wǎng)關(guān)會(huì)將相關(guān)頭透?jìng)鹘o后端服務(wù)，若沒(méi)有傳，網(wǎng)關(guān)將會(huì)生成相關(guān)頭并傳給后端服務(wù)。（共享實(shí)例/Serverless實(shí)例和專(zhuān)享實(shí)例均可使用）

• 透?jìng)骰蛏葿3相關(guān)頭（X-B3-traceid、X-B3-Parentspanid、X-B3-Spanid、X-B3-Sampled）：勾選配置后，若客戶(hù)端傳了B3相關(guān)頭，網(wǎng)關(guān)會(huì)將相關(guān)頭透?jìng)鹘o后端服務(wù)，若沒(méi)有傳，網(wǎng)關(guān)將會(huì)生成相關(guān)頭并傳給后端服務(wù)。（共享實(shí)例/Serverless實(shí)例和專(zhuān)享實(shí)例均可使用）

• 將追蹤日志上傳到阿里云鏈路追蹤平臺(tái)（僅專(zhuān)享實(shí)例使用）：

  • 應(yīng)用名稱(chēng)：自定義鏈路追蹤的應(yīng)用名稱(chēng)。

  • 接入點(diǎn)：填寫(xiě)1.4中的接入點(diǎn)地址，同region建議使用內(nèi)網(wǎng)接入點(diǎn)，可以大幅提高效率。

  • 日志采樣策略：支持全部上傳、按百分比上傳、每秒上傳固定數(shù)，根據(jù)需要選擇即可。

API網(wǎng)關(guān)配置Trace鏈路追蹤后的請(qǐng)求可以在鏈路追蹤控制臺(tái)查看到請(qǐng)求鏈路。

關(guān)于鏈路追蹤的使用可參考查看接口調(diào)用情況