使用 X-Ray API - AWS X-Ray

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 X-Ray API

如果 X-Ray SDK 不支援您的程式設計語言，您可以APIs直接使用 X-Ray 或 AWS Command Line Interface (AWS CLI) 呼叫 X-Ray API 指令。請使用下列指引來選擇您與之互動的方式API：

  • 使用預先格式化的命令或請求中的選項來 AWS CLI 獲得更簡單的語法。

  • API直接使用 X-Ray 以獲得最大的靈活性，並針對您對 X-Ray 提出的請求進行自訂。

如果您API直接使用 X-Ray 而非使用 AWS CLI，則必須以正確的資料格式參數化要求，並且可能還必須設定驗證和錯誤處理。

下圖顯示選擇如何與 X-Ray 互動的指引API：

X-Ray 顯示應用程式要求的詳細資訊。

使用 X-Ray API 將追蹤資料直接傳送至 X-Ray。X-Ray API 支持 X-Ray 中所有可用的功能，SDK包括以下常見操作：

  • PutTraceSegments— 將區段文件上載至 X-Ray。

  • BatchGetTraces— 擷取追蹤清單中的追蹤清單IDs。每個擷取的追蹤都是來自單一要求的區段文件集合。

  • GetTraceSummaries— 擷取IDs和追蹤的註解。您可以指定一個FilterExpression來擷取追蹤摘要的子集。

  • GetTraceGraph— 擷取特定追蹤 ID 的服務圖形。

  • GetServiceGraph— 擷取JSON格式化文件，該文件描述處理傳入要求和呼叫下游要求的服務。

您也可以使用應用程式程式碼中的 AWS Command Line Interface (AWS CLI)，以程式設計方式與 X-Ray 互動。 AWS CLI 支持 X-Ray 中可用的所有功能，SDK包括其他功能 AWS 服務。下列函數是先前使用較簡單格式列出的API作業版本：

  • put-trace-segments— 將區段文件上載至 X-Ray。

  • batch-get-traces— 擷取追蹤清單中的追蹤清單IDs。每個擷取的追蹤都是來自單一要求的區段文件集合。

  • get-trace-summaries— 擷取IDs和追蹤的註解。您可以指定一個FilterExpression來擷取追蹤摘要的子集。

  • get-trace-graph— 擷取特定追蹤 ID 的服務圖形。

  • get-service-graph— 擷取JSON格式化文件，該文件描述處理傳入要求和呼叫下游要求的服務。

若要開始使用，您必須AWS CLI為您的作業系統安裝。 AWS 支援LinuxmacOS和Windows作業系統。若要取得有關 X-Ray 指令清單的更多資訊，請參閱〈X-Ray 的指AWS CLI 令參考指南〉。

主題