Use OpenTelemetry com Funções do Azure

• Atualmente, o OpenTelemetry não é suportado para aplicativos em processo em C#.

Exemplos neste artigo assumem que a sua aplicação usa IHostApplicationBuilder, que está disponível na versão 2.x e versão posterior de Microsoft.Azure. Functions.Worker. Para obter mais informações, consulte Versão 2.x no guia de modelo de trabalho isolado em C#.

1. Execute estes comandos para instalar os assemblies necessários em seu aplicativo:

   • Informações sobre aplicativos
   • Exportador OTLP

   Observação

   A partir da versão 3.0, o pacote Microsoft.ApplicationInsights.WorkerService aproveita Azure Monitor Exporter. Pode usar este pacote para manter os comportamentos de configuração existentes do Application Insights enquanto utiliza internamente o pipeline do Azure Monitor, incluindo o exportador OpenTelemetry. Pode usar o pacote Microsoft.ApplicationInsights.WorkerService (v3.0 ou posterior) em vez do pacote Azure.Monitor.OpenTelemetry.Exporter, que é mostrado no exemplo seguinte.

   dotnet add package Microsoft.Azure.Functions.Worker.OpenTelemetry
   dotnet add package OpenTelemetry.Extensions.Hosting 
   dotnet add package Azure.Monitor.OpenTelemetry.Exporter  
   

2. No seu arquivo de projeto Program.cs, adicione esta using instrução:

   • Informações sobre aplicativos
   • Exportador OTLP

   using Azure.Monitor.OpenTelemetry.Exporter; 
   

3. Configure o OpenTelemetry com base se o início do seu projeto utiliza IHostBuilder ou IHostApplicationBuilder. Este último foi introduzido na versão 2.x da extensão do modelo trabalhador isolado .NET.

   • IHostApplicationBuilder
   • IHostBuilder

   No program.cs, adicione esta linha de código após ConfigureFunctionsWebApplication:

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

   Você pode exportar para ambos os endpoints OpenTelemetry da mesma aplicação.

1. Adicione as bibliotecas necessárias ao seu aplicativo. A maneira como você adiciona bibliotecas depende se você implanta usando Maven ou Kotlin e se você também deseja enviar dados para o 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. (Opcional) Adicione este código para criar spans personalizados:

   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. Instale estes pacotes npm em seu projeto:

   • Informações sobre aplicativos
   • Exportador OTLP

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

2. Crie um arquivo de código em seu projeto, copie e cole o seguinte código neste novo arquivo e salve o arquivo como src/index.js:

   • Informações sobre aplicativos
   • Exportador 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. Atualize o main campo no seu ficheiro de package.json para incluir o novo src/index.js ficheiro. Por exemplo:

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

2. Crie um arquivo de código em seu projeto, copie e cole o seguinte código neste novo arquivo e salve o arquivo como src/index.ts:

   • Informações sobre aplicativos
   • Exportador 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. Atualize o main campo no arquivo package.json para incluir a saída desse novo src/index.ts arquivo, que pode ter esta aparência:

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

Estas instruções aplicam-se apenas a um exportador OTLP:

1. Adicione uma configuração de aplicativo nomeada OTEL_FUNCTIONS_WORKER_ENABLED com o valor de True.

2. Crie uma pasta ao nível da aplicação na raiz da sua aplicação e execute o seguinte comando:

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

   Este comando instala o módulo necessário AzureFunctions.PowerShell.OpenTelemetry.SDK diretamente na sua aplicação. Não é possível usar o requirements.psd1 ficheiro para instalar automaticamente essa dependência porque dependências geridas não são suportadas atualmente na visualização do Flex Consumption plan.

3. Adicione este código ao seu ficheiro profile.ps1:

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

1. Certifique-se de que estas bibliotecas estão no seu requirements.txt ficheiro, seja por descomentar ou adicionar manualmente:

   • Informações sobre aplicativos
   • Exportador OTLP

   azure-monitor-opentelemetry
   

2. Adicione este código ao seu function_app.py arquivo de ponto de entrada principal:

   • Informações sobre aplicativos
   • Exportador OTLP

   Se já adicionou PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY=true nas definições da aplicação, pode ignorar este passo. Para habilitar manualmente a coleta do Application Insights sem instrumentação automática, adicione este código ao seu aplicativo:

   from azure.monitor.opentelemetry import configure_azure_monitor 
   configure_azure_monitor() 
   

3. Consulte a documentação do Azure Monitor Distro para opções sobre como configurar o SDK com mais detalhe.

• As extensões personalizadas incluem automaticamente todos os atributos de recursos e usam os exportadores configurados em seu aplicativo.

• Quando a sua aplicação corre fora do Azure, incluindo durante o desenvolvimento local, o detector de recursos define o atributo service.name para java-function-app por defeito.

• Use estes flags da Java Virtual Machine (JVM) para silenciar a telemetria ao correr localmente durante testes unitários:

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

• Não precisas de registar manualmente o middleware; O trabalhador Java descobre automaticamente OpenTelemetryInvocationMiddleware.