Använda OpenTelemetry med Azure Functions

OpenTelemetry stöds för närvarande inte för processbaserade C#-appar.

Exempel i den här artikeln förutsätter att din app använder IHostApplicationBuilder, som är tillgänglig i version 2.x och senare version av Microsoft.Azure.Functions.Worker. Mer information finns i Version 2.x i modellguiden för isolerad C#-arbetsmodell.

1. Kör dessa kommandon för att installera de nödvändiga sammansättningarna i din app:

   • Application Insights
   • OTLP-exportör

   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. Lägg till den här using instruktionen i din Program.cs projektfil:

   • Application Insights
   • OTLP-exportör

   using Azure.Monitor.OpenTelemetry.Exporter; 
   

3. Hur du konfigurerar OpenTelemetry beror på om projektets start använder IHostBuilder eller IHostApplicationBuilder, som introducerades i v2.x i .NET-tillägget för isolerade arbetsmodeller.

   • IHostApplicationBuilder
   • IHostBuilder

   I program.cs lägger du till den här kodraden efter ConfigureFunctionsWebApplication:

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

   Du kan exportera till båda OpenTelemetry-slutpunkterna från samma app.

1. Lägg till de bibliotek som krävs i din app. Hur du lägger till bibliotek beror på om du distribuerar med Maven eller Kotlin och om du även vill skicka data till 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. Du kan också lägga till den här koden för att skapa anpassade intervall:

   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. Installera dessa npm-paket i projektet:

   • Application Insights
   • OTLP-exportör

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

2. Skapa en kodfil i projektet, kopiera och klistra in följande kod i den nya filen och spara filen som src/index.js:

   • Application Insights
   • OTLP-exportör

   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. Uppdatera fältet main i din package.json-fil så att den innehåller den här nya src/index.js filen, vilket kan se ut så här:

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

2. Skapa en kodfil i projektet, kopiera och klistra in följande kod i den nya filen och spara filen som src/index.ts:

   • Application Insights
   • OTLP-exportör

   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. Uppdatera fältet main i package.json-filen så att det innehåller utdata från den nya src/index.ts filen, vilket kan se ut så här:

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

Dessa instruktioner gäller endast för en OTLP-exportör:

1. Lägg till en programinställning med namnet OTEL_FUNCTIONS_WORKER_ENABLED med värdet True.

2. Skapa en Modules på appnivå i appens rot och kör följande kommando:

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

   Detta installerar den nödvändiga AzureFunctions.PowerShell.OpenTelemetry.SDK modulen direkt i din app. Du kan inte använda requirements.psd1 filen för att installera det här beroendet automatiskt eftersom hanterade beroenden för närvarande inte stöds i förhandsversionen av Flex Consumption-planen .

3. Lägg till den här koden i filen profile.ps1:

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

1. Kontrollera att de här biblioteken finns i filen requirements.txt , oavsett om du vill ta bort kommentarer eller lägga till dig själv:

   • Application Insights
   • OTLP-exportör

   azure-monitor-opentelemetry
   

2. Lägg till den här koden i huvudinmatningspunktens function_app.py fil:

   • Application Insights
   • OTLP-exportör

   Om du redan har lagt till PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY=true i programinställningarna kan du hoppa över det här steget. Om du vill aktivera Application Insights-samlingen manuellt utan automatisk instrumentering lägger du till den här koden i din app:

   from azure.monitor.opentelemetry import configure_azure_monitor 
   configure_azure_monitor() 
   

3. Mer information om hur du konfigurerar SDK finns i dokumentationen om Distribution av distribution i Azure Monitor .

• Anpassade intervall inkluderar automatiskt alla resursattribut och använder de exportörer som konfigurerats i din app.

• När din app körs utanför Azure, inklusive under lokal utveckling, anger resursdetektorn service.name attributet till java-function-app som standard.

• Använd dessa JVM-flaggor (Java Virtual Machine) för att tysta telemetri när du kör lokalt under enhetstester:

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

• Du behöver inte registrera mellanprogram manuellt. Java Worker autodiscovers OpenTelemetryInvocationMiddleware.