筛选 .NET、Java、Node.js和 Python 应用程序的 OpenTelemetry

许多检测库都提供筛选选项。 有关指导，请查看相应的 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 跟踪

以下示例演示如何使用 HTTP/HTTPS 监控库排除被跟踪的某个 URL：

// Import the distro API and supporting instrumentation types.
import { useMicrosoftOpenTelemetry } from "@microsoft/opentelemetry";
import type { HttpInstrumentationConfig } from "@opentelemetry/instrumentation-http";

// Define which HTTP requests to exclude.
const httpOptions: HttpInstrumentationConfig = {
    enabled: true,

    // Exclude incoming OPTIONS requests.
    ignoreIncomingRequestHook: (request) => request.method === "OPTIONS",

    // Exclude outgoing requests to the /test path.
    ignoreOutgoingRequestHook: (request) => request.path === "/test",
};

// Initialize the Microsoft OpenTelemetry Distro.
useMicrosoftOpenTelemetry({
    azureMonitor: {
        azureMonitorExporterOptions: {
            connectionString: process.env.APPLICATIONINSIGHTS_CONNECTION_STRING,
        },
    },
    instrumentationOptions: {
        http: httpOptions,
    },
});

以下示例演示如何使用 OTEL_PYTHON_EXCLUDED_URLS 环境变量排除跟踪某个 URL：

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

这样做将排除以下 Flask 示例中所示的终结点：

...
# Import Flask and the Microsoft OpenTelemetry Distro.
import flask
from microsoft.opentelemetry import use_microsoft_opentelemetry

# Configure OpenTelemetry to use Azure Monitor with the specified connection string.
use_microsoft_opentelemetry(
    enable_azure_monitor=True,
    azure_monitor_connection_string="<ConnectionString>",
)

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


# Exclude this route through OTEL_PYTHON_EXCLUDED_URLS.
@app.route("/ignore")
def ignore():
    return "Request received but not tracked."


...

1. 使用自定义处理器：

   提示

   在添加 Azure Monitor 之前，请添加此处显示的处理器。

   使用 Span 处理器筛选遥测

   // Import the Microsoft OpenTelemetry Distro and supporting APIs.
   using Microsoft.OpenTelemetry;
   using OpenTelemetry.Trace;
   
   // Create the application builder.
   var builder = WebApplication.CreateBuilder(args);
   
   builder.Services.AddOpenTelemetry()
     .WithTracing(tracing => tracing
   
       // Collect spans from the application activity source.
       .AddSource("ActivitySourceName")
   
       // Run the custom processor before exporting spans.
       .AddProcessor(new ActivityFilteringProcessor()))
   
     // Configure the Microsoft OpenTelemetry Distro.
     .UseMicrosoftOpenTelemetry(options =>
     {
       options.Exporters = ExportTarget.AzureMonitor;
     });
   
   // Build the application with the configured telemetry services.
   var app = builder.Build();
   
   // Run the application and its telemetry providers.
   app.Run();
   

2. 使用以下代码将 ActivityFilteringProcessor.cs 添加到你的项目：

   using System.Diagnostics;
   using OpenTelemetry;
   
   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. 使用自定义处理器：

   // Import the Microsoft OpenTelemetry Distro and supporting APIs.
   using Microsoft.OpenTelemetry;
   using OpenTelemetry;
   using OpenTelemetry.Trace;
   
   // Create the SDK and keep its providers alive until application shutdown.
   using var sdk = OpenTelemetrySdk.Create(telemetry =>
   {
     telemetry.WithTracing(tracing => tracing
   
       // Collect spans from the application activity source.
       .AddSource("OTel.AzureMonitor.Demo")
   
       // Run the custom processor before exporting spans.
       .AddProcessor(new ActivityFilteringProcessor()))
   
       // Configure the Microsoft OpenTelemetry Distro.
       .UseMicrosoftOpenTelemetry(options =>
       {
         options.Exporters = ExportTarget.AzureMonitor;
       });
   });
   

   在应用程序生存期内保持 sdk 活动状态，并在关闭时将其释放。

2. 使用以下代码将 ActivityFilteringProcessor.cs 添加到你的项目：

   using System.Diagnostics;
   using OpenTelemetry;
   
   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 跟踪

你可以使用自定义范围处理器来排除导出某些范围。 若要取消导出，请将 span 上下文的 traceFlags 设置为 TraceFlags.NONE。

使用 自定义属性示例，但替换以下代码行：

// Import the necessary packages.
import { SpanKind, TraceFlags } from "@opentelemetry/api";
import type { ReadableSpan, Span, SpanProcessor } from "@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: ReadableSpan): void {
        // If the span is an internal span, set the trace flags to NONE.
        if (span.kind == SpanKind.INTERNAL) {
            span.spanContext().traceFlags = TraceFlags.NONE;
        }
    }
}

你可以使用自定义范围处理器来排除导出某些范围。 将 span 上下文的跟踪标志设置为 TraceFlags.DEFAULT。 将以下处理器另存为 span_filtering_processor.py，然后注册实例：

...
# Import the necessary libraries.
from microsoft.opentelemetry import use_microsoft_opentelemetry
from opentelemetry import trace
from span_filtering_processor import SpanFilteringProcessor

# Configure OpenTelemetry to use Azure Monitor with the specified connection string.
use_microsoft_opentelemetry(
    enable_azure_monitor=True,
    azure_monitor_connection_string="<ConnectionString>",
    # Register the processor that filters internal spans.
    span_processors=[SpanFilteringProcessor()],
)

...

使用以下代码 span_filtering_processor.py：

# 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,
            )

有关故障排除信息，请参阅 Troubleshoot OpenTelemetry issues in .NET 和 Troubleshoot missing application telemetry in Azure Monitor Application Insights。

有关故障排除信息，请参阅 Troubleshoot OpenTelemetry issues in .NET 和 Troubleshoot missing application telemetry in Azure Monitor Application Insights。

有关故障排除的信息，请参阅 在 Java 中排除 OpenTelemetry 问题 和 在 Azure Monitor Application Insights 中排除缺少应用程序遥测数据的问题。

有关故障排除的信息，请参阅 排查 Spring Boot 本机映像应用程序中的 OpenTelemetry 问题和排查 Azure Monitor Application Insights 中缺少的应用程序遥测数据。

有关故障排除信息，请参阅 在 Node.js 中排除 OpenTelemetry 问题 和 在 Azure Monitor Application Insights 中排除应用程序遥测缺失的问题。

有关故障排除信息，请参阅 在 Python 中排除 OpenTelemetry 问题的故障 和 在 Azure Monitor Application Insights 中排除缺少应用程序遥测数据的问题。

• 对于 Azure 支持问题，请打开 Azure 支持票证。
• 对于 OpenTelemetry 问题，请直接联系 OpenTelemetry .NET 社区。
• 有关与Azure Monitor导出程序相关的开放问题列表，请参阅 GitHub 问题页。

• 对于 Azure 支持问题，请打开 Azure 支持票证。
• 对于 OpenTelemetry 问题，请直接联系 OpenTelemetry .NET 社区。
• 有关与Azure Monitor导出程序相关的开放问题列表，请参阅 GitHub 问题页。

• 对于 Azure 支持问题，请打开 Azure 支持票证。
• 有关疑难解答的帮助，请参阅疑难解答步骤。
• 有关 OpenTelemetry 问题，请直接与 OpenTelemetry 社区联系。
• 有关与Azure Monitor Java自动结构相关的开放问题列表，请参阅 GitHub 问题页。

• 对于 Azure 支持问题，请打开 Azure 支持票证。
• 有关 OpenTelemetry 问题，请直接与 OpenTelemetry 社区联系。
• 有关 Spring Boot 本机应用程序未解决问题的列表，请参阅 GitHub 问题页。
• 有关 Quarkus 本机应用程序的开放问题列表，请参阅 GitHub 问题页。

• 对于 Azure 支持问题，请打开 Azure 支持票证。
• 有关 OpenTelemetry 问题，请直接与 OpenTelemetry JavaScript 社区联系。
• 有关与Azure Monitor导出程序相关的开放问题列表，请参阅 GitHub 问题页。

• 对于 Azure 支持问题，请打开 Azure 支持票证。
• 对于 OpenTelemetry 问题，请直接联系 OpenTelemetry Python 社区。
• 有关与 Python Microsoft OpenTelemetry 发行版相关的开放问题列表，请参阅GitHub问题。

• 若要查看源代码，请参阅 适用于 .NET 的 Microsoft OpenTelemetry Distro 存储库。
• 若要查看示例应用程序，请参阅 Microsoft OpenTelemetry Distro for ASP.NET Core。
• 若要安装 NuGet 包、检查更新或查看发行说明，请参阅Microsoft.OpenTelemetry 包。
• 有关仍在使用Azure.Monitor.OpenTelemetry.AspNetCore的应用程序，请参阅Azure Monitor发行版文档。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry .NET GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。

• 若要查看源代码，请参阅 适用于 .NET 的 Microsoft OpenTelemetry Distro 存储库。
• 有关非托管设置，请参阅为控制台应用和后台工具配置 Microsoft OpenTelemetry 发行版。
• 若要安装 NuGet 包、检查更新或查看发行说明，请参阅Microsoft.OpenTelemetry 包。
• 有关使用独立Azure.Monitor.OpenTelemetry.Exporter包的应用程序，请参阅Azure Monitor导出程序文档。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry .NET GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。

• 若要查看配置选项，请参阅 Java 自动探测配置选项。
• 若要查看源代码，请参阅 Azure Monitor Java autoinstrumentation GitHub 存储库。
• 若要查看示例应用程序，请参阅 Application Insights Java Samples。
• 查看GitHub上的 release 注释。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请查看 OpenTelemetry Java GitHub 存储库。
• 若要启用使用体验功能，请查看“启用网络或浏览器用户监视”。

• 若要查看源代码，请参阅 Spring Boot 本机映像 Java 应用程序中的 Azure Monitor OpenTelemetry 发行版和 Quarkus OpenTelemetry Exporter for Azure。
• 若要查看示例应用程序，请参阅 GraalVM 本地映像的遥测。
• 查看GitHub上的 release 注释。
• 在 OpenTelemetry SpringBoot 入门中详细了解 Spring Boot 原生映像应用程序的功能
• 在 Quarkus OpenTelemetry Exporter for Azure 中了解有关 Quarkus 本机应用程序的详细信息。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请查看 OpenTelemetry Java GitHub 存储库。

• 若要查看源代码，请参阅 适用于 Node.js 的 Microsoft OpenTelemetry Distro 存储库。
• 若要查看示例应用程序，请参阅 适用于 Node.js 的 Microsoft OpenTelemetry Distro 示例。
• 若要安装 npm 包并检查更新，请参阅 @microsoft/opentelemetry 包。
• 有关仍在使用@azure/monitor-opentelemetry的应用程序，请参阅Azure Monitor发行版文档。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请参阅 OpenTelemetry JavaScript GitHub存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。

• 若要查看源代码和配置，请参阅 适用于 Python 的 Microsoft OpenTelemetry Distro 存储库。
• 若要查看示例应用程序，请参阅 适用于 Python 的 Microsoft OpenTelemetry 发行版示例。
• 若要安装 PyPI 包并检查更新，请参阅 microsoft-opentelemetry 包。
• 查看GitHub上的 release 注释。
• 有关仍在使用azure-monitor-opentelemetry的应用程序，请参阅Azure Monitor发行版文档。
• 若要查看可用的 OpenTelemetry 检测和组件，请参阅 OpenTelemetry 参与者Python GitHub存储库。
• 若要了解有关 OpenTelemetry 及其社区的详细信息，请查看 OpenTelemetry Python GitHub 存储库。
• 若要启用使用体验， 请启用 Web 或浏览器用户监视。