OpenTelemetry

Dieses Feature erfordert das NuGet-Paket "Microsoft.Testing.Extensions.OpenTelemetry ".

Diese Erweiterung integriert OpenTelemetry in Microsoft.Testing.Platform (MTP), sodass Testläufe Ablaufverfolgungen und Metriken über das standardmäßige OpenTelemetry SDK ausgeben können.

Registration

var builder = await TestApplication.CreateBuilderAsync(args);

builder.AddOpenTelemetryProvider(
    withTracing: tracing => tracing
        .AddTestingPlatformInstrumentation()
        .AddConsoleExporter(),
    withMetrics: metrics => metrics
        .AddTestingPlatformInstrumentation()
        .AddConsoleExporter()
);

using var app = await builder.BuildAsync();
return await app.RunAsync();

Um die Instrumentierung, Ressourcenattribute und einen OTLP-Exporter anhand der standardmäßigen Umgebungsvariablen OTEL_* zu konfigurieren, rufen Sie Folgendes auf:

builder.AddOpenTelemetryProviderFromEnvironment();

Die Methode fügt die Instrumentierung nur hinzu, wenn Sie einen Exporter konfigurieren oder einen Konfigurationsrückruf übergeben, sodass Sie die Registrierung in der Anwendung verlassen können, wenn einige Umgebungen keine Telemetrie exportieren.

API

AddOpenTelemetryProvider

Registriert den OpenTelemetry-Anbieter auf ITestApplicationBuilder. Akzeptiert zwei optionale Rückrufe:

• withTracing: konfiguriert die TracerProviderBuilder für die verteilte Ablaufverfolgung.
• withMetrics: konfiguriert das MeterProviderBuilder zur Sammlung von Metriken.

AddTestingPlatformInstrumentation

Rufen Sie TracerProviderBuilder oder MeterProviderBuilder auf, um die integrierte Microsoft.Testing.Platform Aktivitätsquelle und den -zähler zu abonnieren.

AddTestingPlatformResource

Rufen Sie ResourceBuilder auf, um Testassembly-, Host-, Betriebssystem- und Runtimeattribute hinzuzufügen. Der Detektor identifiziert auch CI-Anbieter, Pipeline, Zweig und Commit-Informationen für GitHub Actions, Azure Pipelines, GitLab CI und Jenkins.

AddOpenTelemetryProviderFromEnvironment

Registriert Tracing, Metriken, Ressourcenerkennung und einen OTLP-Exporter anhand der standardmäßigen OpenTelemetry-Umgebungsvariablen. OTEL_SDK_DISABLED=true deaktiviert die Integration. Konfigurieren OTEL_TRACES_EXPORTER, , OTEL_METRICS_EXPORTERoder OTEL_EXPORTER_OTLP_ENDPOINT zum Aktivieren des Exports.

Aktivitätsquelle und -meter

Die Erweiterung sendet Telemetrie unter:

• Aktivitätsquelle: Microsoft.Testing.Platform
• Messgerät: Microsoft.Testing.Platform

Semantische Konventionen

MTP emittiert standardisierte OpenTelemetry-Test- und Codeattribute, für die eine Konvention existiert, einschließlich test.case.name, test.case.result.status, test.suite.name, code.function.name, code.line.number, code.file.path, code.stacktrace und error.type. Fehlgeschlagene Tests setzen den Span-Status auf Error und fügen ein exception-Ereignis hinzu.

MTP erweitert die Konventionen mit zusätzlichen Ergebniszuständen (skipped, error, timeout, cancelledund unknown) und Testattributen für Konzepte, die OpenTelemetry nicht definiert. Um vorhandene Dashboards beizubehalten, bleiben veraltete Attribut- und Instrumentnamen standardmäßig aktiviert.

Wenn der Startprozess TRACEPARENT und TRACESTATE bereitstellt, ordnet MTP den Testlauf dieser Trace zu, anstatt eine nicht zusammenhängende Root-Trace zu starten.

Ausgegebene Metriken

Umgebungskonfiguration