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

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

• ASP.NET Core
• HttpClient
• SqlClient ¹

¹ Мы включили инструментирование SqlClient в наш пакет, пока он еще находится в бета-версии. Когда он достигает стабильного выпуска, мы включаем его в качестве стандартной ссылки на пакет. До тех пор, чтобы настроить инструментирование SQLClient, добавьте OpenTelemetry.Instrumentation.SqlClient ссылку на пакет в проект и используйте его общедоступный API.

dotnet add package --prerelease OpenTelemetry.Instrumentation.SqlClient

builder.Services.AddOpenTelemetry().UseAzureMonitor().WithTracing(builder =>
{
    builder.AddSqlClientInstrumentation(options =>
    {
        options.SetDbStatementForStoredProcedure = false;
    });
});

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

• ASP.NET
• HttpClient
• SqlClient

Начиная с версии 3.0.3 агент Java, можно отключить определенные данные телеметрии автозабора. Дополнительные сведения см. в разделе "Параметры конфигурации: Azure Monitor Application Insights для Java".

Отключение автоматической телеметрии не поддерживается в машинном коде 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 Monitor.

   // 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 в проект, используя следующий код:

   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 в проект, используя следующий код:

   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.

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

// 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;
        }
    }
}

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

...
# 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 в проект, используя следующий код:

# 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 см . в разделе конфигурации OpenTelemetry в Azure Monitor.
• Чтобы просмотреть исходный код, ознакомьтесь с репозиторием GitHub в Azure Monitor AspNetCore.
• Чтобы установить пакет NuGet, проверить наличие обновлений или просмотреть заметки о выпуске, ознакомьтесь со страницей пакета NuGet Для Azure Monitor AspNetCore.
• Дополнительные сведения об Azure Monitor и OpenTelemetry см. в примере приложения Azure Monitor.
• Чтобы получить дополнительные сведения об OpenTelemetry и соответствующем сообществе, ознакомьтесь с репозиторием .NET для OpenTelemetry на GitHub.
• Чтобы включить функции использования, ознакомьтесь со статьей о включении наблюдения за пользователями в Интернете или браузере.
• Чтобы просмотреть часто задаваемые вопросы, действия по устранению неполадок, варианты поддержки или предоставить отзыв о OpenTelemetry, ознакомьтесь со справкой, поддержкой и отзывом по Azure Monitor Application Insights.

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

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

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

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

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