使用 SDK - AWS X-Ray

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

使用 SDK

注意

End-of-support通知 – 在 2027 年 2 月 25 日, AWS X-Ray 將停止支援 AWS X-Ray SDKs 和協助程式。2027 年 2 月 25 日之後,您將不再收到更新或版本。如需支援時間軸的詳細資訊,請參閱 X-Ray SDK 和協助程式終止支援時間表。建議您遷移至 OpenTelemetry。如需遷移至 OpenTelemetry 的詳細資訊,請參閱從 X-Ray 檢測遷移至 OpenTelemetry 檢測

如果您想要使用命令列界面,或比 中可用的功能需要更多自訂追蹤、監控或記錄功能,請使用 開發套件 AWS Management Console。您也可以使用 AWS SDK 來開發使用 X-Ray APIs程式。您可以使用 AWS Distro for OpenTelemetry (ADOT) 開發套件或 X-Ray 開發套件。

如果您使用 SDK,您可以在檢測應用程式和設定收集器或代理程式時,將自訂新增至工作流程。您可以使用 SDK 來執行無法使用 執行的下列任務 AWS Management Console:

  • 發佈自訂指標 – 高解析度到 1 秒的範例指標,使用多個維度來新增指標的相關資訊,並將資料點彙總到統計資料集。

  • 自訂您的收集器 – 自訂收集器任何部分的組態,包括接收者、處理器、匯出器和連接器。

  • 自訂您的檢測 – 自訂區段和子區段、新增自訂索引鍵/值對做為屬性,以及建立自訂指標。

  • 以程式設計方式建立和更新抽樣規則。

如果您想要彈性地使用標準 ADOT SDK 並新增多層 AWS 安全性和最佳化,請使用 OpenTelemetry SDK。 AWS Distro for OpenTelemetry (ADOT) SDK 是與廠商無關的套件,允許與其他廠商和非AWS 服務的後端整合,而不必重新檢測您的程式碼。

如果您已使用 X-Ray 開發套件、僅與 AWS 後端整合,而且不想變更您與 X-Ray 或應用程式程式碼互動的方式,請使用 X-Ray 開發套件。

如需每個功能的詳細資訊,請參閱 選擇 AWS Distro for OpenTelemetry 和 X-Ray SDKs

使用 ADOT SDK

SDK ADOT是一組開放原始碼 APIs、程式庫和代理程式,可將資料傳送至後端服務。 ADOT 受 支援 AWS、與多個後端和代理程式整合,並提供OpenTelemetry社群維護的大量開放原始碼程式庫。使用 ADOT 開發套件來檢測您的應用程式,並收集日誌、中繼資料、指標和追蹤。您也可以使用 ADOT 來監控服務,並根據 CloudWatch 中的指標設定警示。

如果您使用 ADOT開發套件,您可以搭配 代理程式使用下列選項:

  • 搭配 CloudWatch 代理程式使用 ADOT SDK – 建議使用。

  • 搭配 ADOT Collector 使用 ADOT 開發套件 – 如果您想要搭配 AWS 多層安全性和最佳化使用與廠商無關的軟體,建議使用 。

若要使用 ADOT SDK,請執行下列動作:

ADOT 收集器收到您的資料後,會將其傳送至您在ADOT組態中指定的後端。 ADOT可以將資料傳送至多個後端,包括 以外的廠商 AWS,如下圖所示:

您可以在檢測應用程式和設定收集器時自訂 ADOT 收集器。

AWS 會定期更新ADOT以新增功能,並與 OpenTelemetry 架構保持一致。開發的更新和未來計劃ADOT是可供公眾使用的藍圖的一部分。 ADOT支援多種程式設計語言,包括下列項目:

  • Go

  • Java

  • JavaScript

  • Python

  • .NET

  • Ruby

  • PHP

如果您使用的是 Python, ADOT 可以自動檢測您的應用程式。若要開始使用 ADOT,請參閱 Distro for OpenTelemetry Collector 簡介和入門。 AWS OpenTelemetry

使用 X-Ray SDK

X-Ray SDK 是一組 AWS APIs和程式庫,可將資料傳送至 AWS 後端服務。使用 X-Ray 開發套件來檢測您的應用程式並收集追蹤資料。您無法使用 X-Ray 開發套件來收集日誌或指標資料。

如果您使用 X-Ray 開發套件,您可以搭配 代理程式使用下列選項:

  • 搭配 使用 X-Ray 開發套件 AWS X-Ray 協助程式 – 如果您不想更新應用程式碼,請使用此選項。

  • 搭配 CloudWatch 代理程式使用 X-Ray 開發套件 – (建議) CloudWatch 代理程式與 X-Ray 開發套件相容。

若要使用 X-Ray 開發套件,請執行下列動作:

  • 使用 X-Ray SDK 檢測您的應用程式。

  • 設定收集器以告知收集資料的位置。您可以使用 CloudWatch 代理程式或 X-Ray 協助程式來收集追蹤資訊。

收集器或代理程式收到您的資料後,會將其傳送至您在代理程式組態中指定的 AWS 後端。X-Ray SDK 只能將資料傳送至 AWS 後端,如下圖所示:

搭配 CloudWatch 代理程式或 X-Ray 協助程式使用 X-Ray 開發套件。

如果您使用的是 Java,您可以使用 X-Ray 開發套件自動檢測您的應用程式。若要開始使用 X-Ray 開發套件,請參閱與下列程式設計語言相關聯的程式庫: