OpenTelemetry gebruiken met Azure Functions

OpenTelemetry wordt momenteel niet ondersteund voor in-process C#-apps.

In dit artikel wordt ervan uitgegaan dat uw app gebruikmaakt IHostApplicationBuildervan versie 2.x en hoger van Microsoft.Azure.Functions.Worker. Zie versie 2.x in de handleiding voor het geïsoleerde werkrolmodel van C# voor meer informatie.

1. Voer deze opdrachten uit om de vereiste assembly's in uw app te installeren:

   • Application Insights
   • OTLP-exporteur

   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. Voeg in het Program.cs projectbestand deze using instructie toe:

   • Application Insights
   • OTLP-exporteur

   using Azure.Monitor.OpenTelemetry.Exporter; 
   

3. De manier waarop u OpenTelemetry configureert, is afhankelijk van of het opstarten van uw project gebruikmaakt IHostBuilder van of IHostApplicationBuilder, dat is geïntroduceerd in v2.x van de extensie van het .NET-geïsoleerde werkrolmodel.

   • IHostApplicationBuilder
   • IHostBuilder

   Voeg in program.cs deze coderegel toe na ConfigureFunctionsWebApplication:

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

   U kunt vanuit dezelfde app exporteren naar beide OpenTelemetry-eindpunten.

1. Voeg de vereiste bibliotheken toe aan uw app. De manier waarop u bibliotheken toevoegt, is afhankelijk van of u implementeert met Behulp van Maven of Kotlin en of u ook gegevens naar Application Insights wilt verzenden.

   • 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. U kunt deze code desgewenst toevoegen om aangepaste spans te maken:

   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. Installeer deze NPM-pakketten in uw project:

   • Application Insights
   • OTLP-exporteur

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

2. Maak een codebestand in uw project, kopieer en plak de volgende code in dit nieuwe bestand en sla het bestand op als src/index.js:

   • Application Insights
   • OTLP-exporteur

   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. Werk het veld in het main package.json-bestand bij om dit nieuwe src/index.js bestand op te nemen. Dit kan er als volgt uitzien:

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

2. Maak een codebestand in uw project, kopieer en plak de volgende code in dit nieuwe bestand en sla het bestand op als src/index.ts:

   • Application Insights
   • OTLP-exporteur

   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. Werk het veld in het main package.json-bestand bij om de uitvoer van dit nieuwe src/index.ts bestand op te nemen. Dit kan er als volgt uitzien:

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

Deze instructies zijn alleen van toepassing op een OTLP-exporteur:

1. Voeg een toepassingsinstelling toe met de OTEL_FUNCTIONS_WORKER_ENABLED naam met de waarde van True.

2. Maak een Modules op app-niveau in de hoofdmap van uw app en voer de volgende opdracht uit:

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

   Hiermee wordt de vereiste AzureFunctions.PowerShell.OpenTelemetry.SDK module rechtstreeks in uw app geïnstalleerd. U kunt het requirements.psd1 bestand niet gebruiken om deze afhankelijkheid automatisch te installeren, omdat beheerde afhankelijkheden momenteel niet worden ondersteund in de preview van het Flex Consumption-abonnement .

3. Voeg deze code toe aan uw profiel.ps1-bestand:

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

1. Zorg ervoor dat deze bibliotheken zich in uw requirements.txt bestand bevinden, ongeacht of u geen opmerkingen maakt of uzelf toevoegt:

   • Application Insights
   • OTLP-exporteur

   azure-monitor-opentelemetry
   

2. Voeg deze code toe aan het function_app.py hoofdinvoerpuntbestand:

   • Application Insights
   • OTLP-exporteur

   Als u al aan uw toepassingsinstellingen hebt toegevoegd PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY=true , kunt u deze stap overslaan. Als u Application Insights-verzameling handmatig wilt inschakelen zonder automatische instrumentatie, voegt u deze code toe aan uw app:

   from azure.monitor.opentelemetry import configure_azure_monitor 
   configure_azure_monitor() 
   

3. Raadpleeg de documentatie over het gebruik van Azure Monitor Distro voor opties voor het verder configureren van de SDK.

• Aangepaste reeksen bevatten automatisch alle resourcekenmerken en gebruiken de exporteurs die in uw app zijn geconfigureerd.

• Wanneer uw app buiten Azure wordt uitgevoerd, inclusief tijdens lokale ontwikkeling, stelt de resourcedetector het service.name kenmerk java-function-app standaard in.

• Gebruik deze JVM-vlaggen (Java Virtual Machine) om telemetrie stil te leggen bij lokaal uitvoeren tijdens eenheidstests:

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

• U hoeft middleware niet handmatig te registreren; de automatische detectie van OpenTelemetryInvocationMiddlewareJava-werkrollen.