open-telemetry
/
opentelemetry-dotnet-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

AspNetTests: use MockSpansCollector instead of LegacyMockZipkinCollector (#1440)

This commit is contained in:
Robert Pająk 2022-10-18 15:50:04 +02:00 committed by GitHub
parent c4168ec632
commit 3b6643476d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
test/IntegrationTests/AspNetTests.cs
View File

@ -23,7 +23,6 @@ using DotNet.Testcontainers.Builders;
using DotNet.Testcontainers.Containers;
using FluentAssertions;
using IntegrationTests.Helpers;
using IntegrationTests.Helpers.Models;
using Xunit;
using Xunit.Abstractions;
@ -47,28 +46,18 @@ public class AspNetTests : TestHelper
// accessible to the Windows docker container where the test application is executed by binding
// the endpoint to all network interfaces. In order to do that it is necessary to open the port
// on the firewall.
using var agent = await LegacyMockZipkinCollector.Start(Output, host: "*");
using var fwPort = FirewallHelper.OpenWinPort(agent.Port, Output);
var testSettings = new TestSettings
{
TracesSettings = new TracesSettings { Port = agent.Port }
};
using var collector = await MockSpansCollector.Start(Output, host: "*");
using var fwPort = FirewallHelper.OpenWinPort(collector.Port, Output);
collector.Expect("OpenTelemetry.Instrumentation.AspNet.Telemetry");
string collectorUrl = $"http://{DockerNetworkHelper.IntegrationTestsGateway}:{collector.Port}";
SetEnvironmentVariable("OTEL_TRACES_EXPORTER", "otlp");
SetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT", collectorUrl);
var webPort = TcpPortProvider.GetOpenPort();
await using var container = await StartContainerAsync(testSettings, webPort);
await using var container = await StartContainerAsync(webPort);
await CallTestApplicationEndpoint(webPort);
var client = new HttpClient();
var response = await client.GetAsync($"http://localhost:{webPort}");
var content = await response.Content.ReadAsStringAsync();
Output.WriteLine("Sample response:");
Output.WriteLine(content);
agent.SpanFilters.Add(x => x.Name != "healthz");
var spans = await agent.WaitForSpansAsync(1);
Assert.True(spans.Count >= 1, $"Expecting at least 1 span, only received {spans.Count}");
collector.AssertExpectations();
}
[Fact]
@ -83,28 +72,22 @@ public class AspNetTests : TestHelper
// the endpoint to all network interfaces. In order to do that it is necessary to open the port
// on the firewall.
using var collector = await MockMetricsCollector.Start(Output, host: "*");
using var fwPort = FirewallHelper.OpenWinPort(collector.Port, Output);
collector.Expect("OpenTelemetry.Instrumentation.AspNet");
// Helps to reduce noise by enabling only AspNet metrics.
SetEnvironmentVariable("OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS", "AspNet");
using var fwPort = FirewallHelper.OpenWinPort(collector.Port, Output);
var testSettings = new TestSettings
{
MetricsSettings = new MetricsSettings { Port = collector.Port },
};
string collectorUrl = $"http://{DockerNetworkHelper.IntegrationTestsGateway}:{collector.Port}";
SetEnvironmentVariable("OTEL_METRICS_EXPORTER", "otlp");
SetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT", collectorUrl);
SetEnvironmentVariable("OTEL_METRIC_EXPORT_INTERVAL", "1000");
SetEnvironmentVariable("OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS", "AspNet"); // Helps to reduce noise by enabling only AspNet metrics.
var webPort = TcpPortProvider.GetOpenPort();
await using var container = await StartContainerAsync(testSettings, webPort);
var client = new HttpClient();
var response = await client.GetAsync($"http://localhost:{webPort}");
var content = await response.Content.ReadAsStringAsync();
Output.WriteLine("Sample response:");
Output.WriteLine(content);
await using var container = await StartContainerAsync(webPort);
await CallTestApplicationEndpoint(webPort);
collector.AssertExpectations();
}
private async Task<TestcontainersContainer> StartContainerAsync(TestSettings testSettings, int webPort)
private async Task<TestcontainersContainer> StartContainerAsync(int webPort)
{
// get path to test application that the profiler will attach to
string testApplicationName = $"testapplication-{EnvironmentHelper.TestApplicationName.ToLowerInvariant()}";
@ -115,40 +98,19 @@ public class AspNetTests : TestHelper
string logPath = EnvironmentHelper.IsRunningOnCI()
? Path.Combine(Environment.GetEnvironmentVariable("GITHUB_WORKSPACE"), "build_data", "profiler-logs")
: Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), @"OpenTelemetry .NET AutoInstrumentation", "logs");
Directory.CreateDirectory(logPath);
Output.WriteLine("Collecting docker logs to: " + logPath);
var agentPort = testSettings.TracesSettings?.Port ?? testSettings.MetricsSettings?.Port;
var builder = new TestcontainersBuilder<TestcontainersContainer>()
.WithImage(testApplicationName)
.WithCleanUp(cleanUp: true)
.WithOutputConsumer(Consume.RedirectStdoutAndStderrToConsole())
.WithName($"{testApplicationName}-{agentPort}-{webPort}")
.WithName($"{testApplicationName}-{webPort}")
.WithNetwork(networkId, networkName)
.WithPortBinding(webPort, 80)
.WithBindMount(logPath, "c:/inetpub/wwwroot/logs")
.WithBindMount(EnvironmentHelper.GetNukeBuildOutput(), "c:/opentelemetry");
string agentBaseUrl = $"http://{DockerNetworkHelper.IntegrationTestsGateway}:{agentPort}";
string agentHealthzUrl = $"{agentBaseUrl}/healthz";
if (testSettings.TracesSettings != null)
{
string zipkinEndpoint = $"{agentBaseUrl}/api/v2/spans";
Output.WriteLine($"Zipkin Endpoint: {zipkinEndpoint}");
builder = builder.WithEnvironment("OTEL_EXPORTER_ZIPKIN_ENDPOINT", zipkinEndpoint);
}
if (testSettings.MetricsSettings != null)
{
Output.WriteLine($"Otlp Endpoint: {agentBaseUrl}");
builder = builder.WithEnvironment("OTEL_EXPORTER_OTLP_ENDPOINT", agentBaseUrl);
builder = builder.WithEnvironment("OTEL_METRIC_EXPORT_INTERVAL", "1000");
}
foreach (var env in EnvironmentHelper.CustomEnvironmentVariables)
{
builder = builder.WithEnvironment(env.Key, env.Value);
@ -161,7 +123,6 @@ public class AspNetTests : TestHelper
wasStarted.Should().BeTrue($"Container based on {testApplicationName} has to be operational for the test.");
Output.WriteLine($"Container was started successfully.");
PowershellHelper.RunCommand($"docker exec {container.Name} curl -v {agentHealthzUrl}", Output);
var webAppHealthzUrl = $"http://localhost:{webPort}/healthz";
var webAppHealthzResult = await HealthzHelper.TestHealtzAsync(webAppHealthzUrl, "IIS WebApp", Output);
webAppHealthzResult.Should().BeTrue("IIS WebApp health check never returned OK.");
@ -175,5 +136,14 @@ public class AspNetTests : TestHelper
return container;
}
private async Task CallTestApplicationEndpoint(int webPort)
{
var client = new HttpClient();
var response = await client.GetAsync($"http://localhost:{webPort}");
var content = await response.Content.ReadAsStringAsync();
Output.WriteLine("Response:");
Output.WriteLine(content);
}
}
#endif

1
test/test-applications/integrations/TestApplication.AspNet/Dockerfile
View File

@ -9,7 +9,6 @@ ENV COR_ENABLE_PROFILING=1 `
COR_PROFILER_PATH=C:\opentelemetry\win-${platform}\OpenTelemetry.AutoInstrumentation.Native.dll `
OTEL_DOTNET_AUTO_HOME=C:\opentelemetry\ `
OTEL_DOTNET_AUTO_INTEGRATIONS_FILE=C:\opentelemetry\integrations.json `
OTEL_TRACES_EXPORTER=zipkin `
OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_SOURCES=TestApplication.* `
OTEL_SERVICE_NAME=TestApplication.AspNet `
OTEL_DOTNET_AUTO_DEBUG=1 `