Lambdaモニタリング用の従来の手動インストゥルメンテーション

Go-language Lambdaをインストゥルメントするには、以下の手順に従います。

1. Goエージェントパッケージをダウンロードし、関数と同じディレクトリに置きます。

2. エージェントをインストール：go get -u github.com/newrelic/go-agent/v3/newrelicを呼び出します。

3. nrlambdaインテグレーションgo get -u github.com/newrelic/go-agent/v3/integrations/nrlambdaをインストールします。

4. Lambdaコードで、コンポーネントをインポートし、アプリケーションを作成し、Lambdaの起動方法を更新します。インストゥルメントされたLambdaの例については、GitHubリポジトリを参照してください。

5. オプション：RecordCustomEvent APIを使用して、Lambdaの呼び出しに関連付けられるカスタムイベントを追加します。例：

   func handler(ctx context.Context) {
     if txn := newrelic.FromContext(ctx); nil != txn {
       txn.Application().RecordCustomEvent("MyEvent", map[string]interface{}{
         "zip": "zap",
       })
     }
     fmt.Println("hello world!")
   }

   コピー

6. Lambda関数を構築して圧縮し、AWSにアップロードします。

   圧縮とアップロートについての推奨

   Lambdaの圧縮とアップロードについての推奨は、次のとおりです。

   1. Linuxで実行するバイナリを構築します。これにより、mainと呼ばれるバイナリファイルが作成されます。次のものを使用できます。

      $ GOOS=linux go build -o main

      コピー

   2. 次のものを使用して、バイナリをデプロイメントパッケージに圧縮します。

      $ zip deployment.zip main

      コピー

   3. AWS LambdaコンソールまたはAWS CLIのいずれかを使用して、zipファイルをAWSにアップロードします。（バイナリ構築中に付けられた名前と同じにするため）ハンドラーの名前をmainにします。

7. 次の環境変数はLambdaをモニターする機能には不要ですが、Lambda機能をディストリビューティッド（分散）トレーシングに含める場合は必要です。ディストリビューティッド（分散）トレーシングを有効にするには、AWSコンソールで以下の環境変数を設定します。

   • NEW_RELIC_ACCOUNT_ID。アカウントID。
   • NEW_RELIC_TRUSTED_ACCOUNT_KEY。これは、アカウントIDでもあります。アカウントが子アカウントの場合、これはroot/親アカウントのアカウントIDです。

8. オプション：ログ作成を設定するには、Go agentのログ作成を参照してください。

9. 少なくとも1回Lambdaを呼び出します。これにより、CloudWatchロググループが作成されます。次のステップではこのグループが必要です。

   ラッパーはLambda実行についてのデータを収集し、JSONメッセージを生成し、CloudWatchログにログ記録します。次に、CloudWatchを設定してそのログをNew Relicに送信します。

JavaでのAWS Lambdaのモニタリングでは、APM Javaエージェントは使用しません。代わりに、次の2つのOpenTracing依存関係を使用します。

• AWS Lambda OpenTracing Java SDK：AWS Lambda RequestHandlerおよびRequestStreamHandlerのOpenTracingインストゥルメンテーション。

• 当社のAWS Lambda OpenTracing Tracer：OpenTracing Tracerの実装は、AWS Lambdaをモニターするように設計されています。スパン、エラーイベント、トランザクションイベント、エラートレースを生成し、ディストリビューティッド（分散）トレーシングをサポートします。

  ヒント

  サポート対象の OpenTracing バージョン

  • OpenTracing 0.31.0:

    • Lambda Tracer：com.newrelic.opentracing:newrelic-java-lambda:1.1.1
    • Lambda SDK：com.newrelic.opentracing:java-aws-lambda:1.0.0

  • OpenTracing 0.32.0、0.33.0：

    • Lambda Tracer：com.newrelic.opentracing:newrelic-java-lambda:2.1.1
    • Lambda SDK：com.newrelic.opentracing:java-aws-lambda:1.0.0

  Java Lambdaをインストゥルメントするには、以下の手順に従います。

1. プロジェクトのbuild.gradleファイルに、OpenTracing AWS Lambda TracerとAWS Lambda OpenTracing SDKの依存関係を含めます。

   dependencies {
       compile("com.newrelic.opentracing:java-aws-lambda:2.1.0")
       compile("com.newrelic.opentracing:newrelic-java-lambda:2.1.1")
       compile("io.opentracing:opentracing-util:0.33.0")
   }

   コピー

2. Java Lambdaの例に示されたようにAWS Lambda RequestHandlerインタフェースを実装し、doHandleRequestメソッドを上書きします。

3. doHandleRequestメソッドで、LambdaTracing.instrument(...) APIを呼び出して、lambda関数の実行をトレースするrootスパンを作成します。ここでは、Lambda関数のビジネスロジックも定義します。

4. Java Lambdaの例に示されたように、LambdaTracer.INSTANCEをOpenTracing Globalトレーサーとして登録します。

5. ZIPデプロイメントパッケージを作成し、AWS Lambdaにアップロードします。または、その他の方法でディプロイします。

6. AWS Lambdaコンソールで、ハンドラーを設定します。Java Lambda例の場合は、ハンドラーはcom.handler.example.MyLambdaHandler::handleRequestとなります。handleRequestが前提となっているため、com.handler.example.MyLambdaHandlerも使用できます。

7. 以下の AWSコンソール環境変数は、Lambda関数をディストリビューティッド（分散）トレーシングに含める場合は必要です。これが推奨されます。

   • NEW_RELIC_ACCOUNT_ID。アカウントID。
   • NEW_RELIC_PRIMARY_APPLICATION_ID。これは、お客様のアカウントIDでもあります。
   • NEW_RELIC_TRUSTED_ACCOUNT_KEY。これは、アカウントIDでもあります。アカウントが子アカウントの場合、これはroot/親アカウントのアカウントIDである必要があります。

8. オプション：Lambdaコンソールで、この環境変数を追加してデバッグロギングを有効にします。NEW_RELIC_DEBUGはtrueです。

9. 少なくとも1回Lambdaを呼び出します。これにより、CloudWatchロググループが作成されます。次のステップではこのグループが必要です。

   ラッパーはLambda実行についてのデータを収集し、JSONメッセージを生成し、CloudWatchログにログ記録します。次に、CloudWatchを設定してそのログをNew Relicに送信します。

   以下のような、一般的な使用例を示す完全なプロジェクトのAWS Lambdaディストリビューティッド（分散）トレーシングの例を参照してください。

• Lambda関数間のディストリビューティッド（分散）トレーシング
• 手作業でのスパン作成（別名カスタムインストゥルメンテーション）
• 外部コールのトレース
• カスタムアトリビュート（別名タグ）のスパンへの追加

.NET CoreベースのAWS Lambda関数のモニタリングでは、標準.NET Core APMエージェントは使用しません。代わりに、NuGetパッケージを使用します。

.NET Core Lambdaをインストゥルメントするには、以下の手順に従います。

1. Lambda関数プロジェクトに、NewRelic.OpenTracing.AmazonLambda.Tracer NuGetパッケージをインストールします。

   注：NewRelic.OpenTracing.AmazonLambda.Tracerは、Amazon.Lambda.APIGatewayEvent NuGet パッケージのバージョン1.2.0 以降によって異なります。環境がすでに下位バージョンのAmazon.Lambda.APIGatewayEventを使用している場合、New RelicパッケージはSystem.MissingMethodExceptionなどのエラーを生成する可能性があります。

2. NuGetパッケージとOpenTracingユーティリティをインポートします。

   using OpenTracing.Util;
   using NewRelic.OpenTracing.AmazonLambda;

   コピー

3. この例で示されたように、機能を以下のようにインストゥルメントします。

   public class Function
   {
   
   static Function()
   {
     // Register The NewRelic Lambda Tracer Instance
     GlobalTracer.Register(NewRelic.OpenTracing.AmazonLambda.LambdaTracer.Instance);
   }
   
   public object FunctionWrapper(ILambdaContext context)
   {
     // Instantiate NewRelic TracingWrapper and pass your FunctionHandler as
     // an argument
     return new TracingRequestHandler().LambdaWrapper(FunctionHandler, context);
   }
   
   /// <summary>
   /// A simple function that takes a string and does a ToUpper
   /// </summary>
   /// <param name="input"></param>
   /// <param name="context"></param>
   /// <returns></returns>
   public object FunctionHandler(ILambdaContext context)
   { ... }
   
   }

   コピー

   ヒント

   FunctionWrapperに渡される引数は、FunctionHandlerの署名と一致する必要があります。

   ハンドラー関数がタスクを返す場合、Lambdaラッパーは返されたタスクが完了するまでブロックします。そのため、持続時間を計測でき、例外がある場合それを把握できます。また、APIGatewayProxyFunctionから継承することもできます。

   例については、以下を参照してください。

   非同期ハンドラー関数

   public async Task<int> FunctionHandlerAsync(ILambdaContext lambdaContext)
   {
     return await new TracingRequestHandler().LambdaWrapper(
                           ActualFunctionHandlerAsync, lambdaContext);
   }
   
   public async Task<APIGatewayProxyResponse> ActualFunctionHandlerAsync(ILambdaContext
   lambdaContext)
   { // Function can make other async operations here
   ...
   }

   コピー

   APIGatewayProxyFunctionからの継承

   public class LambdaFunction : APIGatewayProxyFunction
   {
   static LambdaFunction()
   {
   // Register The NewRelic Lambda Tracer Instance
   OpenTracing.Util.GlobalTracer.Register(NewRelic.OpenTracing.AmazonLambda.LambdaTracer.Instance);
   }
   
   public override Task<APIGatewayProxyResponse> FunctionHandlerAsync(APIGatewayProxyRequest request, ILambdaContext lambdaContext)
   {
   Task<APIGatewayProxyResponse> task = new TracingRequestHandler().LambdaWrapper(ActualFunctionHandlerAsync, request, lambdaContext);
   return task;
   }
   
   public Task<APIGatewayProxyResponse> ActualFunctionHandlerAsync(APIGatewayProxyRequest request, ILambdaContext lambdaContext)
   {
   return base.FunctionHandlerAsync(request, lambdaContext);
   }
   }

   コピー

4. SQSおよびSNSのオプション：.NET Lambda Tracerのバージョン1.0以降、ディストリビューティッド（分散）トレーシングのサポートがSQSとSNSについて追加されています。SQSまたはSNSにおいてディストリビューティッド（分散）トレーシングを有効にするには、このステップの項目を完了させるとともに、これに続くステップにおいて環境変数を設定する必要があります。

   重要

   SQSおよびSNSにおいてディストリビューティッド（分散）トレーシングのサポートを有効にすると、SQSとSNSの両方において自動インストゥルメンテーションが無効になり、それらのインストゥルメントに向けてこれらのwrapperの使用が要求されることになります。

   1. NEW_RELIC_USE_DT_WRAPPER環境変数をtrueに設定します。
   2. SQSおよびSNSコールをインストゥルメントするには、規定のwrapperを使用する必要があります。

   SQS Wrapperの使用

   SQS wrapperは、以下の手法のラッピングをサポートしています。

   • Amazon.SQS.AmazonSQSClient.SendMessageAsync(...)

   • Amazon.SQS.AmazonSQSClient.SendMessageBatchAsync(...)

     例

     // SQS Client
     AmazonSQSClient client = new AmazonSQSClient("AWS_SECRET_ACCESS_KEY", AWS_REGION);
     
     // SendMessageRequest
     SendMessageRequest sendRequest = new SendMessageRequest("QUEUE_URI_STRING", "An SQS Message");
     Task<SendMessageResponse> responseOne = SQSWrapper.WrapRequest(client.SendMessageAsync, sendRequest);
     
     // String-based
     Task<SendMessageResponse> responseTwo = SQSWrapper.WrapRequest(client.SendMessageAsync, "QUEUE_URI_STRING", "Another SQS Message");
     
     // SendMessageBatchRequest
     List<SendMessageBatchRequestEntry> batchEntries = new List<SendMessageBatchRequestEntry>();
     batchEntries.Add(new SendMessageBatchRequestEntry("id1", "First SQS Message"));
     batchEntries.Add(new SendMessageBatchRequestEntry("id2", "Second SQS Message"));
     batchEntries.Add(new SendMessageBatchRequestEntry("id3", "Third SQS Message"));
     SendMessageBatchRequest sendBatchRequest = new SendMessageBatchRequest(QUEUE_URI, batchEntries);
     Task<SendMessageBatchResponse> response = SQSWrapper.WrapRequest(client.SendMessageBatchAsync, sendBatchRequest);
     
     // SendMessageBatchRequestEntry List
     List<SendMessageBatchRequestEntry> moreBatchEntries = new List<SendMessageBatchRequestEntry>();
     batchEntries.Add(new SendMessageBatchRequestEntry("id4", "Fourth SQS Message"));
     batchEntries.Add(new SendMessageBatchRequestEntry("id5", "Fifth SQS Message"));
     batchEntries.Add(new SendMessageBatchRequestEntry("id6", "Sixth SQS Message"));
     Task<SendMessageBatchResponse> response = SQSWrapper.WrapRequest(client.SendMessageBatchAsync, moreBatchEntries);

     コピー

   SNS Wrapperの使用

   SNS wrapperは、以下の手法のラッピングをサポートしています。

   • Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.PublishAsync(...)

     例

     // SNS Client
     AmazonSimpleNotificationServiceClient client = new Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient("AWS_SECRET_ACCESS_KEY", AWS_REGION);
     
     // PublishRequest - Phone Number
     PublishRequest phonePublishRequest = new PublishRequest();
     phonePublishRequest.PhoneNumber = +1XXX5555100;
     phonePublishRequest.Message = "An SNS Message for phones";
     Task<PublishResponse> phoneResponse = SNSWrapper.WrapRequest(client.PublishAsync, phonePublishRequest);
     
     // PublishRequest - ARN
     PublishRequest publishRequest = new PublishRequest("TOPIC_ARN", "An SNS Message");
     Task<PublishResponse> publishResponse = SNSWrapper.WrapRequest(client.PublishAsync, publishRequest);
     
     // String-based without subject
     Task<PublishResponse> ResponseOne = SNSWrapper.WrapRequest(client.PublishAsync, "TOPIC_ARN", "Another SNS Message");
     
     // String-based with subject
     Task<PublishResponse> ResponseTwo = SNSWrapper.WrapRequest(client.PublishAsync, "TOPIC_ARN", "Yet Another SNS Message", "A Subject");

     コピー

5. 次の環境変数はLambdaをモニターする機能には不要ですが、Lambda機能をディストリビューティッド（分散）トレーシングに含める場合は必要です。ディストリビューティッド（分散）トレーシングを有効にするには、AWS Lambdaコンソールで次の環境変数を設定します。

   • NEW_RELIC_ACCOUNT_ID：LambdaがレポートするNew RelicアカウントID。
   • NEW_RELIC_TRUSTED_ACCOUNT_KEY：これもアカウントIDです。アカウントが子アカウントの場合、これはroot/親アカウントのアカウントIDである必要があります。

6. ラッパー関数 (上記の例ではFunctionWrapper)が関数ハンドラーとして設定されていることを確認します。

7. 少なくとも1回Lambdaを呼び出します。これにより、CloudWatchロググループが作成されます。次のステップではこのグループが必要です。

   ラッパーはLambda実行についてのデータを収集し、JSONメッセージを生成し、CloudWatchログにログ記録します。次に、CloudWatchを設定してそのログをNew Relicに送信します。

Node.js Lambdaをインストゥルメントするには：

1. Node.jsエージェントパッケージをダウンロードし、関数と同じディレクトリに配置し、エージェントがnode_modulesディレクトリで依存関係としてインストールされていることを確認します。Node Package Managerを使用します。

   npm install newrelic --save

   コピー

2. AWS SDKモジュールをNode.jsエージェントとともにインストールするには:

   npm install @newrelic/aws-sdk --save

   コピー

3. Lambdaコードで、ファイルの先頭でエージェントモジュールとAWS SDKを要求し、ハンドラー関数をラップします。例:

   const newrelic = require('newrelic');
   require('@newrelic/aws-sdk');
   
   // Other module loads go under the two require statements above
   
   module.exports.handler = newrelic.setLambdaHandler((event, context, callback) => {
   // This is your handler function code
   console.log('Lambda executed');
   callback();
   });

   コピー

4. オプション：recordCustomEvent APIを使用して、Lambdaにカスタムイベントを追加することもできます。例:

   module.exports.handler = newrelic.setLambdaHandler((event, context, callback) => {
   newrelic.recordCustomEvent(‘MyEventType’, {foo: ‘bar’});
   
   console.log('Lambda executed');
   callback();
   });

   コピー

5. Lambda関数とNode.jsエージェントフォルダを一緒に圧縮します。要件および推奨：

   • New Relicエージェントフォルダに入っていないNew Relicファイルは、含める必要はありません。
   • Lambda関数のファイル名が、例えば、lambda_function.nodeの場合は、zipファイルをlambda_function.zipと命名することを推奨します。tarballは使用しないでください。
   • Lambdaと関連モジュールはすべて、zipファイルのルートディレクトリにある必要があります。つまり、ファイルを含むファイルを圧縮するとうまくいきません。

6. 圧縮したファイルを、AWS Lambdaアカウントにアップロードします。

7. AWSコンソールで、以下の環境変数を設定します。

   • NEW_RELIC_NO_CONFIG_FILE。設定ファイルを使用していない場合は、trueに設定します。
   • NEW_RELIC_APP_NAME：アプリケーション名。
   • NEW_RELIC_ACCOUNT_ID。アカウントID。
   • NEW_RELIC_TRUSTED_ACCOUNT_KEY。これは、アカウントIDでもあります。アカウントが子アカウントの場合、これはroot/親アカウントのアカウントIDである必要があります。

8. オプション：ローカル環境においてAWS以外のサーバーレスモードでエージェントを実行するには、環境変数NEW_RELIC_SERVERLESS_MODE_ENABLEDをtrueに設定します。（これをAWS Lambda環境で実行する場合、エージェントはサーバーレスモードで自動的に実行されます。AWSで実行中の場合、この変数は使用しないでください。）

9. オプション：サーバーレスモードでのロギングを有効にするには、環境変数を次のように設定します。

   • NEW_RELIC_LOG_ENABLEDをtrueに設定します。
   • CloudWatchに出力する場合は、NEW_RELIC_LOGをstdoutに設定、または書き込み可能なファイルロケーションに設定します。
   • ログレベルは、デフォルトでinfoに設定されます。その他のログレベルを参照してください。

10. 少なくとも1回Lambdaを呼び出します。これにより、CloudWatchロググループが作成されます。次のステップではこのグループが必要です。

    ラッパーはLambda実行についてのデータを収集し、JSONメッセージを生成し、CloudWatchログにログ記録します。次に、CloudWatchを設定してそのログをNew Relicに送信します。

Python Lambdaをインストゥルメントするには：

1. Pythonエージェントパッケージをダウンロードし、関数と同じディレクトリに配置します。この場合は、pipを使用します。

   pip install -t . newrelic

   コピー

   重要

   Homebrewを使用する場合は、以下のエラーが発生することがあります。DistutilsOptionError：ホームまたはprefix/exec-prefixのいずれかを提供する必要があります。両方ではありません。詳細については、Homebrew GitHubの投稿を参照してください。

2. Lambdaコードで、Pythonエージェントモジュールをインポートし、New Relicデコレーターを使用してハンドラー関数を修飾します。最初に、コードにNew Relicパッケージをインポートする必要があります。次の例を見てみましょう。

   import newrelic.agent
   newrelic.agent.initialize()
   @newrelic.agent.lambda_handler()
   def handler(event, context):
   ...

   コピー

3. オプション：record_custom_event APIを使用して、Lambdaにカスタムイベントを追加することもできます。次の例を見てみましょう。

   @newrelic.agent.lambda_handler()
   def handler(event, context):
   newrelic.agent.record_custom_event('CustomEvent', {'foo': 'bar'})
   …

   コピー

4. このガイドラインを使用して、lambda_function.pyとnewrelic/フォルダを一緒に圧縮します。

   • newrelic/フォルダに入っていないNew Relicファイルは、含める必要はありません。
   • Lambda関数ファイル名が、たとえばlambda_function.pyの場合は、zipファイルをlambda_function.zipと命名します。tarballは使用しないでください。
   • Lambdaと関連モジュールはすべて、zipファイルのルートディレクトリにある必要があります。つまり、ファイルを含むファイルを圧縮するとうまくいきません。

5. 圧縮したファイルを、AWS Lambdaアカウントにアップロードします。

6. AWSコンソールで、以下の環境変数を設定します。

   • NEW_RELIC_SERVERLESS_MODE_ENABLED。trueに設定します。

7. 次の環境変数はLambdaをモニターする機能には不要ですが、Lambda機能をディストリビューティッド（分散）トレーシングに含める場合は必要です。ディストリビューティッド（分散）トレーシングを有効にするには、AWSコンソールで以下の環境変数を設定します。

   • NEW_RELIC_DISTRIBUTED_TRACING_ENABLED。trueに設定します。
   • NEW_RELIC_ACCOUNT_ID。アカウントID。
   • NEW_RELIC_TRUSTED_ACCOUNT_KEY。これは、アカウントIDでもあります。アカウントが子アカウントの場合、これはroot/親アカウントのアカウントIDである必要があります。

8. オプション：ロギングを設定するには、AWSコンソールでNEW_RELIC_LOGとNEW_RELIC_LOG_LEVEL環境変数を使用します。

9. 少なくとも1回Lambdaを呼び出します。これにより、CloudWatchロググループが作成されます。次のステップではこのグループが必要です。

   New Relicデコレーターは、Lambda実行についてのデータを収集し、JSONメッセージを生成し、CloudWatchログに記録します。次に、CloudWatchを設定してそのログをNew Relicに送信します。