Azure Functions で OpenTelemetry を使用する

OpenTelemetry は現在、 C# インプロセス アプリではサポートされていません。

この記事の例では、アプリがバージョン 2.x 以降のIHostApplicationBuilder で利用可能なを使用していることを前提としています。 詳細については、C# 分離ワーカー モデル ガイドの バージョン 2.x を参照してください。

1. 次のコマンドを実行して、必要なアセンブリをアプリにインストールします。

   • Application Insights
   • OTLP エクスポーター

   dotnet add package Microsoft.Azure.Functions.Worker.OpenTelemetry --version  1.1.0-preview6
   dotnet add package OpenTelemetry.Extensions.Hosting 
   dotnet add package Azure.Monitor.OpenTelemetry.Exporter  
   

2. Program.cs プロジェクト ファイルに、次の using ステートメントを追加します。

   • Application Insights
   • OTLP エクスポーター

   using Azure.Monitor.OpenTelemetry.Exporter; 
   

3. OpenTelemetry を構成する方法は、.NET 分離 worker モデル拡張機能の v2.x で導入された IHostBuilder または IHostApplicationBuilderをプロジェクトのスタートアップで使用するかどうかによって異なります。

   • IHostApplicationBuilder
   • IHostBuilder

   program.csで、次のコード行をConfigureFunctionsWebApplication後に追加します。

   builder.Services.AddOpenTelemetry()
       .UseFunctionsWorkerDefaults()
       .UseAzureMonitorExporter();
   

   同じアプリから両方の OpenTelemetry エンドポイントにエクスポートできます。

1. 必要なライブラリをアプリに追加します。 ライブラリを追加する方法は、Maven と Kotlin のどちらを使用してデプロイするか、Application Insights にもデータを送信するかどうかによって異なります。

   • Maven
   • Kotlin

   <dependency>
     <groupId>com.microsoft.azure.functions</groupId>
     <artifactId>azure-functions-java-opentelemetry</artifactId>
     <version>1.0.0</version>
   </dependency>
   <dependency>
     <groupId>com.azure</groupId>
     <artifactId>azure-monitor-opentelemetry-autoconfigure</artifactId>
     <version>1.2.0</version>
   </dependency>
   

2. 必要に応じて、次のコードを追加してカスタム スパンを作成できます。

   import com.microsoft.azure.functions.opentelemetry.FunctionsOpenTelemetry;
   import io.opentelemetry.api.trace.Span;
   import io.opentelemetry.api.trace.SpanKind;
   import io.opentelemetry.context.Scope;
   
   Span span = FunctionsOpenTelemetry.startSpan(
           "com.contoso.PaymentFunction",  // tracer name
           "validateCharge",               // span name
           null,                           // parent = current context
           SpanKind.INTERNAL);
   
   try (Scope ignored = span.makeCurrent()) {
       // business logic here
   } finally {
       span.end();
   }
   

1. プロジェクト ディレクトリに次の npm パッケージをインストールします。

   • Application Insights
   • OTLP エクスポーター

   npm install @opentelemetry/api 
   npm install @opentelemetry/auto-instrumentations-node 
   npm install @azure/monitor-opentelemetry-exporter 
   npm install @azure/functions-opentelemetry-instrumentation
   

2. プロジェクトにコード ファイルを作成し、この新しいファイルに次のコードをコピーして貼り付け、ファイルを src/index.js として保存します。

   • Application Insights
   • OTLP エクスポーター

   const { AzureFunctionsInstrumentation } = require('@azure/functions-opentelemetry-instrumentation');
   const { AzureMonitorLogExporter, AzureMonitorTraceExporter } = require('@azure/monitor-opentelemetry-exporter');
   const { getNodeAutoInstrumentations, getResourceDetectors } = require('@opentelemetry/auto-instrumentations-node');
   const { registerInstrumentations } = require('@opentelemetry/instrumentation');
   const { detectResourcesSync } = require('@opentelemetry/resources');
   const { LoggerProvider, SimpleLogRecordProcessor } = require('@opentelemetry/sdk-logs');
   const { NodeTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-node');
   
   const resource = detectResourcesSync({ detectors: getResourceDetectors() });
   
   const tracerProvider = new NodeTracerProvider({ resource });
   tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new AzureMonitorTraceExporter()));
   tracerProvider.register();
   
   const loggerProvider = new LoggerProvider({ resource });
   loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(new AzureMonitorLogExporter()));
   
   registerInstrumentations({
       tracerProvider,
       loggerProvider,
       instrumentations: [getNodeAutoInstrumentations(), new AzureFunctionsInstrumentation()],
   });
   

3. package.json ファイルの main フィールドを更新して、この新しい src/index.js ファイルを含めます。これは次のようになります。

   "main": "src/{index.js,functions/*.js}"
   

2. プロジェクトにコード ファイルを作成し、この新しいファイルに次のコードをコピーして貼り付け、ファイルを src/index.ts として保存します。

   • Application Insights
   • OTLP エクスポーター

   import { AzureFunctionsInstrumentation } from '@azure/functions-opentelemetry-instrumentation';
   import { AzureMonitorLogExporter, AzureMonitorTraceExporter } from '@azure/monitor-opentelemetry-exporter';
   import { getNodeAutoInstrumentations, getResourceDetectors } from '@opentelemetry/auto-instrumentations-node';
   import { registerInstrumentations } from '@opentelemetry/instrumentation';
   import { detectResourcesSync } from '@opentelemetry/resources';
   import { LoggerProvider, SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs';
   import { NodeTracerProvider, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-node';
   
   const resource = detectResourcesSync({ detectors: getResourceDetectors() });
   
   const tracerProvider = new NodeTracerProvider({ resource });
   tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new AzureMonitorTraceExporter()));
   tracerProvider.register();
   
   const loggerProvider = new LoggerProvider({ resource });
   loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(new AzureMonitorLogExporter()));
   
   registerInstrumentations({
       tracerProvider,
       loggerProvider,
       instrumentations: [getNodeAutoInstrumentations(), new AzureFunctionsInstrumentation()],
   });
   

3. package.json ファイルの main フィールドを更新して、この新しい src/index.ts ファイルの出力を含めます。これは、次のようになります。

   "main": "dist/src/{index.js,functions/*.js}"
   

これらの手順は、OTLP エクスポーターにのみ適用されます。

1. 値が OTEL_FUNCTIONS_WORKER_ENABLED の True という名前のアプリケーション設定を追加します。

2. アプリのルートに アプリレベルの Modules フォルダーを作成し、次のコマンドを実行します。

   Save-Module -Name AzureFunctions.PowerShell.OpenTelemetry.SDK
   

   これにより、必要な AzureFunctions.PowerShell.OpenTelemetry.SDK モジュールがアプリに直接インストールされます。 requirements.psd1 ファイルを使用してこの依存関係を自動的にインストールすることはできません。マネージド依存関係 は、Flex 従量課金プラン プレビューでは現在サポートされていないためです。

3. 次のコードを profile.ps1 ファイルに追加します。

   Import-Module AzureFunctions.PowerShell.OpenTelemetry.SDK -Force -ErrorAction Stop 
   Initialize-FunctionsOpenTelemetry 
   

1. コメントを解除するか、自分を追加するかに関係なく、これらのライブラリが requirements.txt ファイル内にあることを確認します。

   • Application Insights
   • OTLP エクスポーター

   azure-monitor-opentelemetry
   

2. function_app.py メイン エントリ ポイント ファイルに次のコードを追加します。

   • Application Insights
   • OTLP エクスポーター

   アプリケーション設定に PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY=true を既に追加している場合は、この手順をスキップできます。 自動インストルメンテーションなしで Application Insights コレクションを手動で有効にするには、次のコードをアプリに追加します。

   from azure.monitor.opentelemetry import configure_azure_monitor 
   configure_azure_monitor() 
   

3. SDK をさらに構成する方法のオプションについては、 Azure Monitor Distro の使用状況 に関するドキュメントを参照してください。

• カスタム スパンには、すべてのリソース属性が自動的に含まれており、アプリで構成されたエクスポーターが使用されます。

• ローカル開発中を含め、アプリが Azure の外部で実行されている場合、リソース検出機能によって、 service.name 属性が既定で java-function-app に設定されます。

• 単体テスト中にローカルで実行するときにテレメトリを無音にするには、次の Java 仮想マシン (JVM) フラグを使用します。

  • -Dotel.traces.exporter=none
  • -Dotel.metrics.exporter=none
  • -Dotel.logs.exporter=none

• ミドルウェアを手動で登録する必要はありません。Java ワーカー自動検出 OpenTelemetryInvocationMiddleware。