檢測 Ruby 代碼 AWS Lambda

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

設定主動追蹤之後，您可以透過應用程式來觀察特定請求。X-Ray 服務圖顯示了有關應用程式及其所有元件的資訊。下列範例顯示具有兩個函式的應用程式。主要函式會處理事件，有時會傳回錯誤。頂部的第二個函數處理出現在第一個日誌組中的錯誤，並使用調 AWS SDK用 X-Ray，Amazon 簡單存儲服務（Amazon S3）和亞馬遜 CloudWatch 日誌。

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

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

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

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

左側第一個節點代表接收調用請求的 Lambda 服務。第二個節點代表您特定的 Lambda 函數。下列範例顯示了具有這 2 個區段的追蹤。兩者都被命名為我的函數，但一個具有的起源AWS::Lambda，另一個具有的AWS::Lambda::Function起源。如果AWS::Lambda區段顯示錯誤，表示 Lambda 服務發生問題。如果AWS::Lambda::Function區段顯示錯誤，表示您的函數發生問題。

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

舊式函數段包含以下子段：

新樣式的函數段不包含Invocation子段。相反，客戶子段直接附加到功能段。如需有關舊型式和新型式函數區段結構的詳細資訊，請參閱了解 X-Ray 追蹤。

您可以測試處理常式程式碼，以記錄中繼資料並追蹤下游呼叫。若要記錄處理常式對其他資源和服務進行呼叫的詳細資訊，請使用 X-Ray SDK for Ruby。若要取得SDK，請將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 SDK客戶端，請在初始化代碼中創建客戶端後需要該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 個區段的追蹤。兩者都被命名為我的函數，但一個具有的起源AWS::Lambda，另一個具有的AWS::Lambda::Function起源。如果AWS::Lambda區段顯示錯誤，表示 Lambda 服務發生問題。如果AWS::Lambda::Function區段顯示錯誤，表示您的函數發生問題。

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

舊式函數段包含以下子段：

新樣式的函數段不包含Invocation子段。相反，客戶子段直接附加到功能段。如需有關舊型式和新型式函數區段結構的詳細資訊，請參閱了解 X-Ray 追蹤。

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

使用 Lambda 啟用主動追蹤 API

若要使用 AWS CLI 或管理追蹤組態 AWS SDK，請使用下列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 SDK 來檢測 AWS SDK客戶端的功能代碼，則您的部署包可能會變得相當大。若要避免每次更新函數程式碼時都上傳執行階段相依性，請將 X-Ray 封裝SDK在 Lambda 層中。

下面的例子顯示了存儲 X-Ray SDK 的 Ruby 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 範例應用程式。