Фильтрация Azure Monitor OpenTelemetry для приложений .NET, Java, Node.js и Python

Многие библиотеки инструментирования предоставляют вариант фильтрования. Чтобы получить рекомендации, ознакомьтесь с соответствующими файлами readme:

• ASP.NET Core
• HttpClient
• Sqlclient

Многие библиотеки инструментирования предоставляют вариант фильтрования. Чтобы получить рекомендации, ознакомьтесь с соответствующими файлами readme:

• ASP.NET
• HttpClient
• SqlClient

Отключайте определенные данные автоматически собираемой телеметрии, используя параметры конфигурации или переменные среды.

{
  "instrumentation": {
	"azureSdk": {
	  "enabled": false
	},
	"cassandra": {
	  "enabled": false
	},
	"jdbc": {
	  "enabled": false
	},
	"jms": {
	  "enabled": false
	},
	"kafka": {
	  "enabled": false
	},
	"logging": {
	  "enabled": false
	},
	"micrometer": {
	  "enabled": false
	},
	"mongo": {
	  "enabled": false
	},
	"quartz": {
	  "enabled": false
	},
	"rabbitmq": {
	  "enabled": false
	},
	"redis": {
	  "enabled": false
	},
	"springScheduling": {
	  "enabled": false
	}
  }
}

Вы также можете подавить инструментирование, установив следующие переменные среды на false:

• APPLICATIONINSIGHTS_INSTRUMENTATION_AZURE_SDK_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_CASSANDRA_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_JDBC_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_JMS_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_KAFKA_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_LOGGING_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_MICROMETER_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_MONGO_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_RABBITMQ_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_REDIS_ENABLED
• APPLICATIONINSIGHTS_INSTRUMENTATION_SPRING_SCHEDULING_ENABLED

Эти переменные имеют приоритет над включенными переменными, указанными в конфигурации JSON.

Отключение автособранной телеметрии не поддерживается в нативных функциях Java. Чтобы отфильтровать данные телеметрии, обратитесь к соответствующей внешней документации:

• Spring Boot - стартер Spring Boot
• Quarkus - Использование трассировки OpenTelemetry

В следующем примере показано, как исключить определенный URL-адрес из отслеживания с помощью библиотеки инструментирования HTTP/HTTPS:

// Import the useAzureMonitor function and the ApplicationInsightsOptions class from the @azure/monitor-opentelemetry package.
const { useAzureMonitor, ApplicationInsightsOptions } = require("@azure/monitor-opentelemetry");

// Import the HttpInstrumentationConfig class from the @opentelemetry/instrumentation-http package.
const { HttpInstrumentationConfig }= require("@opentelemetry/instrumentation-http");

// Import the IncomingMessage and RequestOptions classes from the http and https packages, respectively.
const { IncomingMessage } = require("http");
const { RequestOptions } = require("https");

// Create a new HttpInstrumentationConfig object.
const httpInstrumentationConfig: HttpInstrumentationConfig = {
    enabled: true,
    ignoreIncomingRequestHook: (request: IncomingMessage) => {
    // Ignore OPTIONS incoming requests.
    if (request.method === 'OPTIONS') {
        return true;
    }
    return false;
    },
    ignoreOutgoingRequestHook: (options: RequestOptions) => {
    // Ignore outgoing requests with the /test path.
    if (options.path === '/test') {
        return true;
    }
    return false;
    }
};

// Create a new ApplicationInsightsOptions object.
const config: ApplicationInsightsOptions = {
    instrumentationOptions: {
    http: {
        httpInstrumentationConfig
    }
    }
};

// Enable Azure Monitor integration using the useAzureMonitor function and the ApplicationInsightsOptions object.
useAzureMonitor(config);

В следующем примере показано, как исключить определенный URL-адрес из отслеживания с помощью переменной OTEL_PYTHON_EXCLUDED_URLS среды:

export OTEL_PYTHON_EXCLUDED_URLS="http://localhost:8080/ignore"

Это исключает конечную точку, показанную в следующем примере Flask:

...
# Import the Flask and Azure Monitor OpenTelemetry SDK libraries.
import flask
from azure.monitor.opentelemetry import configure_azure_monitor

# Configure OpenTelemetry to use Azure Monitor with the specified connection string.
# Replace `<your-connection-string>` with the connection string to your Azure Monitor Application Insights resource.
configure_azure_monitor(
    connection_string="<your-connection-string>",
)

# Create a Flask application.
app = flask.Flask(__name__)

# Define a route. Requests sent to this endpoint will not be tracked due to
# flask_config configuration.
@app.route("/ignore")
def ignore():
    return "Request received but not tracked."
...

1. Использование пользовательского процессора:

   Совет

   Добавьте процессор, показанный здесь перед добавлением монитора Azure.

   // Create an ASP.NET Core application builder.
   var builder = WebApplication.CreateBuilder(args);
   
   // Configure the OpenTelemetry tracer provider to add a new processor named ActivityFilteringProcessor.
   builder.Services.ConfigureOpenTelemetryTracerProvider((sp, builder) => builder.AddProcessor(new ActivityFilteringProcessor()));
   // Configure the OpenTelemetry tracer provider to add a new source named "ActivitySourceName".
   builder.Services.ConfigureOpenTelemetryTracerProvider((sp, builder) => builder.AddSource("ActivitySourceName"));
   // Add the Azure Monitor telemetry service to the application. This service will collect and send telemetry data to Azure Monitor.
   builder.Services.AddOpenTelemetry().UseAzureMonitor();
   
   // Build the ASP.NET Core application.
   var app = builder.Build();
   
   // Start the ASP.NET Core application.
   app.Run();
   

2. Добавьте ActivityFilteringProcessor.cs в project с помощью следующего кода:

   public class ActivityFilteringProcessor : BaseProcessor<Activity>
   {
       // The OnStart method is called when an activity is started. This is the ideal place to filter activities.
       public override void OnStart(Activity activity)
       {
           // prevents all exporters from exporting internal activities
           if (activity.Kind == ActivityKind.Internal)
           {
               activity.IsAllDataRequested = false;
           }
       }
   }
   

Если конкретный источник не добавляется явным образом с помощью AddSource("ActivitySourceName"), то никакие действия, созданные с помощью этого источника, не экспортируются.

1. Использование пользовательского процессора:

   // Create an OpenTelemetry tracer provider builder.
   // It is important to keep the TracerProvider instance active throughout the process lifetime.
   using var tracerProvider = Sdk.CreateTracerProviderBuilder()
           .AddSource("OTel.AzureMonitor.Demo") // Add a source named "OTel.AzureMonitor.Demo".
           .AddProcessor(new ActivityFilteringProcessor()) // Add a new processor named ActivityFilteringProcessor.
           .AddAzureMonitorTraceExporter() // Add the Azure Monitor trace exporter.
           .Build();
   

2. Добавьте ActivityFilteringProcessor.cs в project с помощью следующего кода:

   public class ActivityFilteringProcessor : BaseProcessor<Activity>
   {
       // The OnStart method is called when an activity is started. This is the ideal place to filter activities.
       public override void OnStart(Activity activity)
       {
           // prevents all exporters from exporting internal activities
           if (activity.Kind == ActivityKind.Internal)
           {
               activity.IsAllDataRequested = false;
           }
       }
   }
   

Если конкретный источник не добавляется явным образом с помощью AddSource("ActivitySourceName"), то никакие действия, созданные с помощью этого источника, не экспортируются.

Чтобы отфильтровать данные телеметрии из приложений Java, можно использовать переопределения выборки (рекомендуемые) или процессоры телеметрии. Дополнительные сведения см. в следующей документации:

• Переопределения выборки
• Процессоры телеметрии (предварительная версия)
• Примеры обработчика телеметрии

Переопределения выборки и процессоры телеметрии не поддерживаются в собственном коде Java. Чтобы отфильтровать данные телеметрии, обратитесь к соответствующей внешней документации:

• Spring Boot - стартер Spring Boot
• Quarkus - Использование трассировки OpenTelemetry

Для исключения определенных частей трассировки из экспорта можно использовать пользовательский процессор интервалов. Чтобы пометить диапазоны как не подлежащие экспорту, задайте для TraceFlag значение DEFAULT.

Используйте пример свойства custom, но замените следующие строки кода:

// Import the necessary packages.
const { SpanKind, TraceFlags } = require("@opentelemetry/api");
const { ReadableSpan, Span, SpanProcessor } = require("@opentelemetry/sdk-trace-base");

// Create a new SpanEnrichingProcessor class.
class SpanEnrichingProcessor implements SpanProcessor {
    forceFlush(): Promise<void> {
        return Promise.resolve();
    }

    shutdown(): Promise<void> {
        return Promise.resolve();
    }

    onStart(_span: Span): void {}

    onEnd(span) {
        // If the span is an internal span, set the trace flags to NONE.
        if(span.kind == SpanKind.INTERNAL){
        span.spanContext().traceFlags = TraceFlags.NONE;
        }
    }
}

Для исключения определенных частей трассировки из экспорта можно использовать пользовательский процессор интервалов. Чтобы пометить диапазоны, которые не экспортируются, установите значение TraceFlagDEFAULT:

...
# Import the necessary libraries.
from azure.monitor.opentelemetry import configure_azure_monitor
from opentelemetry import trace

# Configure OpenTelemetry to use Azure Monitor with the specified connection string.
# Replace `<your-connection-string>` with the connection string to your Azure Monitor Application Insights resource.
configure_azure_monitor(
    connection_string="<your-connection-string>",
    # Configure the custom span processors to include span filter processor.
    span_processors=[span_filter_processor],
)

...

Добавьте SpanFilteringProcessor в project с помощью следующего кода:

# Import the necessary libraries.
from opentelemetry.trace import SpanContext, SpanKind, TraceFlags
from opentelemetry.sdk.trace import SpanProcessor

# Define a custom span processor called `SpanFilteringProcessor`.
class SpanFilteringProcessor(SpanProcessor):

    # Prevents exporting spans from internal activities.
    def on_start(self, span, parent_context):
        # Check if the span is an internal activity.
        if span._kind is SpanKind.INTERNAL:
            # Create a new span context with the following properties:
            #   * The trace ID is the same as the trace ID of the original span.
            #   * The span ID is the same as the span ID of the original span.
            #   * The is_remote property is set to `False`.
            #   * The trace flags are set to `DEFAULT`.
            #   * The trace state is the same as the trace state of the original span.
            span._context = SpanContext(
                span.context.trace_id,
                span.context.span_id,
                span.context.is_remote,
                TraceFlags(TraceFlags.DEFAULT),
                span.context.trace_state,
            )

Сведения об устранении неполадок см. в статье "Устранение неполадок с OpenTelemetry" в .NET и устранение неполадок с отсутствующими данными телеметрии приложений в Azure Monitor Application Insights.

Сведения об устранении неполадок см. в статье "Устранение неполадок с OpenTelemetry" в .NET и устранение неполадок с отсутствующими данными телеметрии приложений в Azure Monitor Application Insights.

Сведения об устранении неполадок см. в разделе "Устранение неполадок с OpenTelemetry" в Java и устранение неполадок с отсутствующими данными телеметрии приложений в Azure Monitor Application Insights.

См. сведения об устранении неполадок в статье «Устранение неполадок с OpenTelemetry в приложениях образов Spring Boot» и устранение неполадок с отсутствующими данными телеметрии приложения в Azure Monitor Application Insights.

Сведения об устранении неполадок см. в разделе "Устранение неполадок с OpenTelemetry" в Node.js и в разделе "Устранение неполадок с отсутствующими данными телеметрии приложения в Azure Monitor Application Insights".

Сведения об устранении неполадок см. в статье "Устранение неполадок с OpenTelemetry в Python и устранение неполадок с отсутствующими данными телеметрии приложений в Azure Monitor Application Insights".

• Для проблем с поддержкой Azure откройте запрос в службу поддержки Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу OpenTelemetry .NET .
• Список открытых проблем, связанных с экспортером Azure Monitor, см. на странице проблем GitHub.

• Для проблем с поддержкой Azure откройте запрос в службу поддержки Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу OpenTelemetry .NET .
• Список открытых проблем, связанных с экспортером Azure Monitor, см. на странице проблем GitHub.

• Для проблем с поддержкой Azure откройте запрос в службу поддержки Azure.
• Сведения об устранении неполадок см. в шагах по устранению неполадок.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу OpenTelemetry .
• Чтобы просмотреть список открытых проблем, связанных с автоинструментацией Java для Azure Monitor, посетите страницу проблем на GitHub.

• Для проблем с поддержкой Azure откройте запрос в службу поддержки Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу OpenTelemetry .
• Список открытых проблем с собственными приложениями Spring Boot см. на странице проблем GitHub.
• Список открытых проблем с собственными приложениями Quarkus см. на странице проблем GitHub.

• Для проблем с поддержкой Azure откройте запрос в службу поддержки Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу JavaScript OpenTelemetry .
• Список открытых проблем, связанных с экспортером Azure Monitor, см. на странице проблем GitHub.

• Для проблем с поддержкой Azure откройте запрос в службу поддержки Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу Python OpenTelemetry .
• Список открытых проблем, связанных с дистрибутивом Azure Monitor, см. на странице проблем GitHub.

• Сведения о исходном коде см. в репозитории Azure Monitor ASP.NET Core GitHub.
• Чтобы просмотреть пример приложения, см. статью Azure Monitor OpenTelemetry для ASP.NET Core.
• Чтобы установить пакет NuGet, проверьте наличие обновлений или просмотрите заметки о выпуске, см. страницу Azure Monitor AspNetCore NuGet Package.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry .NET GitHub.
• Чтобы обеспечить пользовательский опыт, включите мониторинг пользователей в Интернете или браузере.

• Сведения о исходном коде см. в репозитории Azure Monitor Exporter GitHub.
• Чтобы просмотреть пример приложения, см. статью Azure Monitor OpenTelemetry для .NET.
• Чтобы установить пакет NuGet, проверить наличие обновлений или просмотреть заметки о выпуске, см. страницу Azure Monitor Exporter NuGet Package.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry .NET GitHub.
• Чтобы обеспечить пользовательский опыт, включите мониторинг пользователей в Интернете или браузере.

• Чтобы просмотреть параметры конфигурации, ознакомьтесь с параметрами конфигурации автоинструментации Java.
• Чтобы просмотреть исходный код, ознакомьтесь с репозиторием Azure Monitor Java autoinstrumentation GitHub.
• Чтобы просмотреть примеры приложений, см. примеры Java Application Insights.
• Просмотрите заметки о выпуске на GitHub.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry Java GitHub.
• Чтобы включить возможности использования, ознакомьтесь со сведениями о включении мониторинга пользователей в Интернете или браузере.

• Сведения о исходном коде см. в статье Azure Monitor OpenTelemetry Distro in Spring Boot native image Java application and Quarkus OpenTelemetry Exporter for Azure.
• Чтобы просмотреть пример приложения, ознакомьтесь с данными телеметрии для собственных образов GraalVM.
• Просмотрите заметки о выпуске на GitHub.
• Узнайте больше о возможностях для приложений на основе образов Spring Boot с помощью стартер OpenTelemetry SpringBoot
• Узнайте больше о возможностях для нативных приложений Quarkus в Quarkus OpenTelemetry Exporter для Azure.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry Java GitHub.

• Чтобы просмотреть исходный код, ознакомьтесь с репозиторием Azure Monitor OpenTelemetry для JavaScript.
• Чтобы просмотреть пример приложения, см. статью Azure Monitor OpenTelemetry для Node.js.
• Чтобы установить пакет npm и проверить наличие обновлений, см. страницу @azure/monitor-opentelemetrynpm Package.
• Чтобы получить дополнительные сведения об OpenTelemetry и соответствующем сообществе, ознакомьтесь с репозиторием JavaScript для OpenTelemetry на GitHub.
• Чтобы обеспечить пользовательский опыт, включите мониторинг пользователей в Интернете или браузере.

• Дополнительные сведения о исходном коде и дополнительной документации см. в репозитории GitHub для Python в Azure Monitor.
• Сведения о примерах приложений см. в статье Azure Monitor OpenTelemetry для Python.
• Чтобы установить пакет PyPI и проверить наличие обновлений, см. страницу пакета PyPI дистрибутива Azure Monitor .
• Просмотрите заметки о выпуске на GitHub.
• Сведения о доступных инструментах и компонентах OpenTelemetry см. в репозитории GitHub участника OpenTelemetry Python.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry Python GitHub.
• Чтобы обеспечить пользовательский опыт, включите мониторинг пользователей в Интернете или браузере.