在 AWS Lambda 中檢測 Ruby 代碼

Lambda 會與 AWS X-Ray 整合，讓您能夠追蹤、偵錯和最佳化 Lambda 應用程式。您可以使用 X-Ray 來追踪請求，因為它會周遊應用程式中的資源，從前端 API 到後端的存儲體和資料庫。只要將 X-Ray SDK 程式庫新增至您的建置組態，就可以針對函數對 AWS 服務所進行的任何呼叫記錄錯誤和延遲。

設定主動追蹤之後，您可以透過應用程式來觀察特定請求。X-Ray 服務圖顯示了有關應用程式及其所有元件的資訊。下列範例顯示了一個具有兩個函數的應用程式。主要函式會處理事件，有時會傳回錯誤。第二個函數會處理出現在第一個函數日誌群組中的錯誤，並使用 AWS SDK 來呼叫 X-Ray、Amazon Simple Storage Service (Amazon S3) 和 Amazon CloudWatch Logs。

若要使用控制台在 Lambda 函數上切換主動追蹤，請按照下列步驟操作：

您的函數需要將追蹤資料上傳至 X-Ray 的許可。當您在 Lambda 主控台中啟用追蹤時，Lambda 會將必要的許可新增至函數的執行角色。否則，請將 AWSXRayDaemonWriteAccess 政策新增至執行角色。

X-Ray 無法追蹤應用程式的所有請求。X-Ray 會套用取樣演算法以確保追蹤的效率，同時仍提供所有請求的代表範本。取樣率為每秒 1 次請求和 5% 的額外請求。不能針對函數設定 X-Ray 取樣率。

在 X-Ray 中，追蹤會記錄一或多個服務所處理之要求的相關資訊。Lambda 會在每個追蹤上記錄 2 個區段，這會在服務圖表上建立兩個節點。下圖反白顯示了這兩個節點：

左側第一個節點代表接收調用請求的 Lambda 服務。第二個節點代表您特定的 Lambda 函數。下列範例顯示了具有這 2 個區段的追蹤。兩者都被命名為 my-function，但其中之一的來源為 AWS::Lambda，而另一個的來源為 AWS::Lambda::Function。如果 AWS::Lambda 區段顯示錯誤，Lambda 服務就會出現問題。如果 AWS::Lambda::Function 區段顯示錯誤，表示您的函數出現了問題。

此範例會展開 AWS::Lambda::Function 區段以顯示其三個子區段：

舊式函數區段包含下列子區段：

新式函數區段不包含 Invocation 子區段。相反地，客戶子區段會直接連接至函數區段。如需舊式和新式函數區段結構的詳細資訊，請參閱了解 X-Ray 追蹤。

您可以測試處理常式程式碼，以記錄中繼資料並追蹤下游呼叫。若要記錄處理常式對其他資源和服務所進行之呼叫的詳細資料，請使用適用於 Ruby 的 X-Ray 開發套件。若要取得開發套件，請將 aws-xray-sdk 套件新增至應用程式的相依性。

# Gemfile
source 'https://rubygems.org'

gem 'aws-xray-sdk', '0.11.4'
gem 'aws-sdk-lambda', '1.39.0'
gem 'test-unit', '3.3.5'

若要檢測 AWS 開發套件用戶端，請在初始化程式碼中建立用戶端之後請求該 aws-xray-sdk/lambda 模組。

# lambda_function.rb
require 'logger'
require 'json'
require 'aws-sdk-lambda'
$client = Aws::Lambda::Client.new()
$client.get_account_settings()

require 'aws-xray-sdk/lambda'

def lambda_handler(event:, context:)
  logger = Logger.new($stdout)
  ...

在 X-Ray 中，追蹤會記錄一或多個服務所處理之要求的相關資訊。Lambda 會在每個追蹤上記錄 2 個區段，這會在服務圖表上建立兩個節點。下圖反白顯示了這兩個節點：

左側第一個節點代表接收調用請求的 Lambda 服務。第二個節點代表您特定的 Lambda 函數。下列範例顯示了具有這 2 個區段的追蹤。兩者都被命名為 my-function，但其中之一的來源為 AWS::Lambda，而另一個的來源為 AWS::Lambda::Function。如果 AWS::Lambda 區段顯示錯誤，Lambda 服務就會出現問題。如果 AWS::Lambda::Function 區段顯示錯誤，表示您的函數出現了問題。

此範例會展開 AWS::Lambda::Function 區段以顯示其三個子區段：

舊式函數區段包含下列子區段：

新式函數區段不包含 Invocation 子區段。相反地，客戶子區段會直接連接至函數區段。如需舊式和新式函數區段結構的詳細資訊，請參閱了解 X-Ray 追蹤。

您也可以檢測 HTTP 用戶端、記錄 SQL 查詢，以及建立具有註釋和中繼資料的自訂子區段。如需詳細資訊，請參閱《AWS X-Ray 開發人員指南》中的適用於 Ruby 的 X-Ray 開發套件。

透過 Lambda API 啟用主動追蹤

若要使用 AWS CLI 或 AWS 開發套件管理追蹤組態，請使用下列 API 操作：

下列範例 AWS CLI 命令啟用對名稱為 my-function 之函數的主動追蹤。

aws lambda update-function-configuration --function-name my-function \
--tracing-config Mode=Active

追蹤模式是您發布函數版本時版本特定組態的一部分。您無法變更已發佈版本上的追蹤模式。

搭配 AWS CloudFormation 啟用主動追蹤

若要在 AWS CloudFormation 範本中啟用對 AWS::Lambda::Function 資源的追蹤，請使用 TracingConfig 屬性。

Resources:
  function:
    Type: AWS::Lambda::Function
    Properties:
      TracingConfig:
        Mode: Active
      ...

對於 AWS Serverless Application Model (AWS SAM) AWS::Serverless::Function 資源，請使用 Tracing 屬性。

Resources:
  function:
    Type: AWS::Serverless::Function
    Properties:
      Tracing: Active
      ...

將執行時間相依性儲存在圖層中

如果您使用 X-Ray 開發套件來測試 AWS 開發套件用戶端，您的函數程式碼、您的部署套件可能會變得相當大。為了避免每次更新函數程式碼時上傳執行時間相依性，請將 X-Ray SDK 封裝在一個 Lambda 層中。

下面的例子顯示了儲存適用於 Ruby 的 X-Ray 開發套件的 AWS::Serverless::LayerVersion 資源。

Resources:
  function:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: function/.
      Tracing: Active
      Layers:
        - !Ref libs
      ...
  libs:
    Type: AWS::Serverless::LayerVersion
    Properties:
      LayerName: blank-ruby-lib
      Description: Dependencies for the blank-ruby sample app.
      ContentUri: lib/.
      CompatibleRuntimes:
        - ruby2.5

透過此組態，您只有在變更執行時間相依性時才會更新程式庫層。由於函數部署套件僅含有您的程式碼，因此有助於減少上傳時間。

為相依性建立圖層需要建置變更，才能在部署之前產生圖層封存。如需工作範例，請參閱 blank-ruby 範例應用程式。