New RelicとOpenTelemetryによる.NET Lambda関数のトレース

レイヤーをインストールする

AWSは、 OpenTelemetry Lambda Collector を含むマネージドレイヤーを公開しています。

インストールするには

1. 作成した関数を Lambda Console で開きます。

2. DesignerセクションのLayersの下で、 Add a layerを選択します。

3. Specify an ARNの下に、以下のリストから関数のアーキテクチャーのレイヤー ARN の 1 つを貼り付けます。 {region}を AWS リージョン (例: us-east-1 ) に置き換えます。

4. Addを選択します。

   • AMD64 / X86_64： arn:aws:lambda:{region}:901920570463:layer:aws-otel-collector-amd64-ver-0-90-1:1
   • ARM64： arn:aws:lambda:\<region>:901920570463:layer:aws-otel-collector-arm64-ver-0-90-1:1

   SAM および CloudFormation テンプレートの場合、関数のプロパティに以下を追加します。

   yourFunctionHere:
     Type: AWS::Serverless::Function
     Properties:
       # ...
       Layers:
         # Use this if using x86_64 architecture
         - !Sub arn:${AWS::Partition}:lambda:${AWS::Region}:901920570463:layer:aws-otel-collector-amd64-ver-0-90-1:1
         # Use this if using arm64 architecture
         - !Sub arn:${AWS::Partition}:lambda:${AWS::Region}:901920570463:layer:aws-otel-collector-arm64-ver-0-90-1:1

   コピー

   重要

   AWSが公開している最新のARNを参照して、上記のレイヤーARNが最新であることを確認してください。

New Relic 環境変数を追加する

このレイヤーが収集した OpenTelemetry データを New Relic に送信するためには、レイヤーに同梱されている OpenTelemetry Lambda Collector を設定して、受信したテレメトリを New Relic OpenTelemetry Endpoint にエクスポートする必要があります。その前に、まずこのコレクターが依存するいくつかの環境変数を設定する必要があります。

1. New Relic アカウントから New Relic ライセンスキーを生成してコピーします。
2. Lambda Console で作成した関数を開きます。
3. Configuration選択し、次にEnvironment variables選択します。
4. Environment variablesの下で、 Editを選択します。
5. Add environment variableを選択します。
6. KeyをNEW_RELIC_LICENSE_KEYに設定し、 Valueを手順 1 で生成したライセンスキーの値に設定します。 次に、 Save選択します。
7. もう一度Add environment variable選択します。
8. Keyの場合はNEW_RELIC_OPENTELEMETRY_ENDPOINTに設定し、 Valueを以下のオプションのいずれかに設定します (New Relic リージョンによって異なります)。 次に、 Save選択します。
9. もう一度Add environment variable選択します。
10. KeyをOTEL_SERVICE_NAMEに設定し、 Valueを関数の名前に設定します。 次に、 Save選択します。

• otlp.nr-data.net:4317：NewRelicアカウントが米国地域にある場合

• otlp.eu01.nr-data.net:4317：NewRelicアカウントがEU地域にある場合

  SAM および CloudFormation テンプレートの場合は、関数のプロパティに以下を追加します。 your-license-key-here実際のライセンスキーに置き換え、 otlp.nr-data.net:4317をリージョンの New Relic OpenTelemetry エンドポイントに置き換えてください。

  yourFunctionHere:
    Type: AWS::Serverless::Function
    Properties:
      # ...
      Environment:
        Variables:
          # ...
          NEW_RELIC_LICENSE_KEY: your-license-key-here
          NEW_RELIC_OPENTELEMETRY_ENDPOINT: otlp.nr-data.net:4317
          OTEL_SERVICE_NAME: your-function-name-here

  コピー

  重要

  your-license-key-hereを New Relic ライセンスキーに置き換え、 otlp.nr-data.net:4317 New Relic リージョンに適したエンドポイントに置き換えます (上記のリストを参照)。

コレクターを構成する

次に、OpenTelemetry Lambda Collectorのデフォルト構成を、テレメトリをNewRelicOpenTelemetryエンドポイントにエクスポートする構成でオーバーライドします。これを行うには、関数にcollector.yaml構成ファイルを含める必要があります。

関数のルートディレクトリに、次の内容のcollector.yamlファイルを作成します。

receivers:
  otlp:
    protocols:
      grpc:
      http:

exporters:
  otlp:
    endpoint: ${NEW_RELIC_OPENTELEMETRY_ENDPOINT}
    headers:
      api-key: ${NEW_RELIC_LICENSE_KEY}

service:
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [otlp]
    metrics:
      receivers: [otlp]
      exporters: [otlp]
    logs:
      receivers: [otlp]
      exporters: [otlp]

このcollector.yamlファイルを関数のzipパッケージのルートディレクトリにバンドルします。

*.csproj設定の例は次のようになります。

<ItemGroup>
  <Content Include="collector.yaml">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
  </Content>  
</ItemGroup>

そして、機能を再展開する。

1. 作成した関数を Lambda Console で開きます。
2. Configuration選択し、次にEnvironment variables選択します。
3. Environment variablesの下で、 Editを選択します。
4. Add environment variableを選択します。
5. KeyにはOPENTELEMETRY_COLLECTOR_CONFIG_FILEを設定し、 Valueには/var/task/collector.yamlを設定します。
6. 次に、 Save選択します。

SAMやCloudFormationのテンプレートの場合は、関数のプロパティにこれを追加します。

yourFunctionHere:
  Type: AWS::Serverless::Function
  Properties:
    # ...
    Environment:
      Variables:
        # ...
        OPENTELEMETRY_COLLECTOR_CONFIG_FILE: /var/task/collector.yaml

インストゥルメントがあなたの機能を評価した

まず、 AWS Lambda 用の OpenTelemetry SDKとOTLP エクスポータ パッケージを追加します。 OpenTelemetry.Insトゥルメンテーション.AWS や OpenTelemetry.Insトゥルメンテーション.Http などの OpenTelemetryインストゥルメンテーションパッケージをさらに追加して、関数の動作をさらに可視化することができます。

$
dotnet add package OpenTelemetry.Instrumentation.AWSLambda
$
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
$
dotnet add package OpenTelemetry.Instrumentation.AWS
$
dotnet add package OpenTelemetry.Instrumentation.Http

関数の静的コンストラクターに、 TracerProviderからのAddAWSLambdaConfigurations()とAddOtlpExporter()への呼び出しを追加します。

TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
    // add other instrumentations here
    .AddAWSLambdaConfigurations(options => options.DisableAwsXRayContextExtraction = true)
    .AddOtlpExporter()
    .Build();

元のLambdaハンドラー関数と同じシグネチャでラッパー関数を作成します。 AWSLambdaWrapper.Trace() APIを呼び出し、元のLambda関数であるTracerProviderとその入力をパラメーターとして渡します。

// new Lambda function handler passed in
public string TracingFunctionHandler(JObject input, ILambdaContext context) =>
    AWSLambdaWrapper.Trace(tracerProvider, OriginalFunctionHandler, input, context);

public string OriginalFunctionHandler(JObject input, ILambdaContext context) {
    return input?.ToString();
}

元のハンドラーが非同期関数である場合は、 Trace()の代わりにTraceAsync() API を使用します。

public Task<APIGatewayProxyResponse> TracingFunctionHandler(APIGatewayProxyRequest request,
    ILambdaContext context)
    => AWSLambdaWrapper.TraceAsync(tracerProvider, OriginalFunctionHandler, request, context);

public async Task<APIGatewayProxyResponse> OriginalFunctionHandler(APIGatewayProxyRequest apigProxyEvent, ILambdaContext context)
{
    //your function here.
}

例えば、基本的なAPI GatewayのLambda関数は次のようなものです。

using System;
using Amazon.Lambda.APIGatewayEvents;
using Amazon.Lambda.Core;
using OpenTelemetry;
using OpenTelemetry.Instrumentation.AWSLambda;
using OpenTelemetry.Trace;

namespace Example
{
    public class Function
    {
        public static TracerProvider tracerProvider;

        static Function()
        {
            tracerProvider = Sdk.CreateTracerProviderBuilder()
                .AddAWSLambdaConfigurations(options => options.DisableAwsXRayContextExtraction = true)
                .AddOtlpExporter()
                .Build();

            // use AwsSdkSample::AwsSdkSample.Function::TracingFunctionHandler as input Lambda handler instead
            public APIGatewayProxyResponse TracingFunctionHandler(APIGatewayProxyRequest request, ILambdaContext context)
            {
                return AWSLambdaWrapper.Trace(tracerProvider, FunctionHandler, request, context);
            }

            /// <summary>
            /// A simple function that takes a APIGatewayProxyRequest and returns a APIGatewayProxyResponse
            /// </summary>
            /// <param name="input"></param>
            /// <param name="context"></param>
            /// <returns></returns>
            public APIGatewayProxyResponse FunctionHandler(APIGatewayProxyRequest request, ILambdaContext context)
            {
                return new APIGatewayProxyResponse() {
                    StatusCode = 200,
                    Body = Environment.GetEnvironmentVariable("_X_AMZN_TRACE_ID")
                };
            }
        }
    }
}

次に、ラッパー関数をLambda関数のハンドラーとして設定します。上記のクラスの場合、ハンドラーはfunction::Example.Function::TracingFunctionHandlerになります。

AWS SDKのトレースを含めた動作例については、 このサンプルアプリ を参照してください。

上記は基本的な例です。より高度なインストゥルメンテーションについては、 OpenTelemetry .NET SDK documentation をご参照ください。

NewRelicUIでデータを表示する

まず、 Lambda 関数 を何度か起動して、テレメトリの生成を開始します。そこからNew Relicにアクセスして、 トレース 、 メトリクス 、 ログ を見つけてください。

Telemetry は New Relic Serverless の下には表示されません。代わりに、New Relic OpenTelemetry Nerdlets の下にテレメトリーデータが表示されます。