AWS X-Ray SDK for Ruby

X-Ray SDK 是 Ruby Web 應用程式的程式庫，提供產生追蹤資料並將其傳送至 X-Ray 精靈的類別和方法。追蹤資料包括應用程式所提供之傳入 HTTP 要求的相關資訊，以及應用程式使用 AWS SDK、HTTP 用戶端或使用中記錄用戶端對下游服務進行呼叫的相關資訊。您也可以手動建立區段，並將除錯資訊新增至註釋和中繼資料中。

您可以透過將它新增至您的 gemfile 並執行 bundle install，來下載軟體開發套件。

範例 Gemfile

gem 'aws-sdk'

如果您使用 Rails，請先新增 X-Ray SDK 中介軟體來追蹤傳入的要求。請求篩選條件會建立區段。當區段開啟時，您可以使用軟體開發套件用戶端的方法，將資訊新增到區段，並建立子區段以追蹤下游呼叫。軟體開發套件也會在區段為開啟時自動記錄應用程式擲回的例外狀況。針對非 Rails 應用程式，您可以手動建立區段。

接下來，使用 X-Ray SDK 來測量您的 AWS SDK for Ruby、HTTP 和 SQL 用戶端，方法是將記錄器設定為修補相關的程式庫。每當您使用已檢測的用戶端對下游 AWS 服務 或資源進行呼叫時，SDK 都會在子區段中記錄有關呼叫的資訊。 AWS 服務 而您在服務中存取的資源會顯示為追蹤對映上的下游節點，以協助您識別個別連線上的錯誤和節流問題。

開始使用軟體開發套件之後，請設定記錄器以自訂其行為。您可以新增外掛程式，以記錄執行應用程式所需的運算資源相關資料、定義抽樣規則以自訂抽樣行為，並提供記錄器以在應用程式日誌中查看更多或更少的軟體開發套件資訊。

使用註釋與中繼資料，記錄應用程式所做的請求和工作等其他資訊。註釋是簡單的鍵/值對，系統會為其建立索引以用於篩選條件表達式，因此您可以搜尋包含特定資料的追蹤。元數據條目的限制較低，可以記錄整個對象和數組-任何可以序列化為 JSON 的內容。

標註與中繼資料

註釋和中繼資料是您使用 X-Ray SDK 新增至區段的任意文字。註釋會編製索引以與篩選器運算式搭配使用 中繼資料不會建立索引，但可以使用 X-Ray 主控台或 API 在原始區段中檢視。您授與 X-Ray 讀取權限的任何人都可以檢視此資料。

當程式碼中有很多經過檢測的用戶端時，單一請求區段可能包含大量子區段，每個使用經檢測用戶端進行的呼叫都有一個子區段。您可以將用戶端呼叫包裝在自訂子區段中，以組織和群組子區段。您可以為整個函數或任何部分的程式碼建立自訂子區段，並記錄子區段上的中繼資料和註釋，而不必寫入父區段上的所有項目。

如需 SDK 類別和方法的參考文件，請參閱 Ruby API 參考的AWS X-Ray SDK。

要求

X-Ray SDK 需要 Ruby 2.3 或更新版本，並且與下列程式庫相容：

• AWS SDK for Ruby 版本 3.0 或更高版本

• Rails 版本 5.1 或更新版本