将 OpenTelemetry 与 Azure Functions 配合使用

• C# 进程内应用目前不受 OpenTelemetry 的支持。

本文中的示例假定应用程序使用 IHostApplicationBuilder，该功能在 Microsoft.Azure.Functions.Worker 的 2.x 版本及更高版本中可用。 有关详细信息，请参阅 C# 独立辅助角色模型指南中的 版本 2.x 。

1. 运行以下命令，以在应用中安装所需的程序集：

   • Application Insights
   • OTLP 导出程序

   注释

   从版本 3.0 开始，Microsoft.ApplicationInsights.WorkerService 包利用 Azure Monitor 导出程序。 可以使用此包在内部使用 Azure Monitor 管道（包括 OpenTelemetry 导出程序）来维护现有的 Application Insights 配置行为。 可以使用 Microsoft.ApplicationInsights.WorkerService 包（v3.0 或更高版本），而不是 Azure.Monitor.OpenTelemetry.Exporter 包，如以下示例所示。

   dotnet add package Microsoft.Azure.Functions.Worker.OpenTelemetry
   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. 根据项目启动是使用 IHostBuilder 还是 IHostApplicationBuilder 来配置 OpenTelemetry。 后者是在 .NET 隔离工作者模型扩展功能的 v2.x 中引入的。

   • 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 Consumption 计划预览版目前不支持托管依赖项。

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. 查看 Azure 监视发行版使用情况文档，获取有关如何进一步配置 SDK 的选项。

• 自定义范围会自动包括所有资源属性，并使用应用中配置的导出程序。

• 当应用在Azure外部运行（包括在本地开发期间）时，资源检测器默认将 service.name 属性设置为 java-function-app。

• 可以使用这些Java虚拟机（JVM）标志在本地进行单元测试时禁用遥测：

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

• 无需手动注册中间件，Java工作线程会自动发现OpenTelemetryInvocationMiddleware。