Использование OpenTelemetry с Функции Azure

В настоящее время OpenTelemetry не поддерживается для приложений внутрипроцессного процесса C#.

Примеры в этой статье предполагают, что ваше приложение использует IHostApplicationBuilder, которое доступно в версии 2.x и более поздних версиях Microsoft.Azure.Functions.Worker. Дополнительные сведения см. в руководстве по изолированной рабочей модели C# версии 2.x .

1. Выполните следующие команды, чтобы установить необходимые сборки в приложении:

   • Аналитика приложений
   • Экспортер 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 :

   • Аналитика приложений
   • Экспортер OTLP

   using Azure.Monitor.OpenTelemetry.Exporter; 
   

3. Способ настройки OpenTelemetry зависит от того, ли используется IHostBuilder или IHostApplicationBuilder, который был представлен в версии 2.x расширения изолированной рабочей модели .NET.

   • 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 в проекте:

   • Аналитика приложений
   • Экспортер 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:

   • Аналитика приложений
   • Экспортер 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. main Обновите поле в файле package.json, чтобы включить этот новый src/index.js файл, который может выглядеть следующим образом:

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

2. Создайте файл кода в проекте, скопируйте и вставьте следующий код в этот новый файл и сохраните его следующим образом src/index.ts:

   • Аналитика приложений
   • Экспортер 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. main Обновите поле в файле package.json, чтобы включить выходные данные этого нового 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, путем снятия комментариев или добавления их вручную.

   • Аналитика приложений
   • Экспортер OTLP

   azure-monitor-opentelemetry
   

2. Добавьте этот код в function_app.py файл основной точки входа:

   • Аналитика приложений
   • Экспортер OTLP

   Если вы уже добавили PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY=true в параметры приложения, этот шаг можно пропустить. Чтобы вручную включить коллекцию Application Insights без автоматического инструментирования, добавьте этот код в приложение:

   from azure.monitor.opentelemetry import configure_azure_monitor 
   configure_azure_monitor() 
   

3. Ознакомьтесь с документацией по использованию дистрибутива Azure Monitor , чтобы узнать, как настроить пакет SDK.

• Пользовательские диапазоны автоматически включают все атрибуты ресурсов и используют экспортеры, настроенные в приложении.

• Когда приложение выполняется за пределами Azure, включая локальную разработку, детектор ресурсов задает service.name атрибут java-function-app по умолчанию.

• Используйте эти флаги виртуальной машины Java (JVM) для отключения телеметрии при локальной работе в модульных тестах.

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

• Вам не требуется вручную регистрировать ПО промежуточного слоя; рабочий процесс Java автоматически обнаруживает OpenTelemetryInvocationMiddleware.