Add OTEL tracing support for Wiremock + automatic OTEL for Aspire integration (#1418)

* Update aspire to 13.1 (examples + code)

Allows usage of aspire CLI which is very useful for dev in codespaces (for my next PR).

* Add OTEL support

* Initial PR feedback

* PR feedback

* PR feedback

* PR feedback

* Cleanup.

* Cleanup

* Fix

* Fix

* Rename stuff around to be more accurate

* PR feedback

* Update WireMock.Net.OpenTelemetry.csproj

Update <Authors>

* PR feedback parser

* PR feedback package versions

* Status code feedback.

* Update preprocessor directives to to Activity Tracing instead of OpenTelemetry. Is more descriptive.

* Add tests

* Improve tests

---------

Co-authored-by: Stef Heyenrath <Stef.Heyenrath@gmail.com>
This commit is contained in:
Petr Houška
2026-01-18 17:22:36 +01:00
committed by GitHub
parent abe996671e
commit 4525c61847
38 changed files with 2057 additions and 9 deletions

View File

@@ -10,6 +10,9 @@ using WireMock.Exceptions;
using WireMock.Logging;
using WireMock.Server;
using WireMock.Settings;
#if OPENTELEMETRY_SUPPORTED
using WireMock.OpenTelemetry;
#endif
namespace WireMock.Net.StandAlone;
@@ -37,6 +40,39 @@ public static class StandAloneApp
return server;
}
#if OPENTELEMETRY_SUPPORTED
/// <summary>
/// Start WireMock.Net standalone Server based on the WireMockServerSettings with OpenTelemetry tracing.
/// </summary>
/// <param name="settings">The WireMockServerSettings</param>
/// <param name="openTelemetryOptions">The OpenTelemetry options for exporting traces.</param>
[PublicAPI]
public static WireMockServer Start(WireMockServerSettings settings, OpenTelemetryOptions? openTelemetryOptions)
{
Guard.NotNull(settings);
// Wire up OpenTelemetry OTLP exporter if options are provided
if (openTelemetryOptions is not null)
{
// Enable activity tracing in settings so middleware creates activities
// Only set ExcludeAdminRequests if not already configured
settings.ActivityTracingOptions ??= new ActivityTracingOptions
{
ExcludeAdminRequests = openTelemetryOptions.ExcludeAdminRequests
};
var existingRegistration = settings.AdditionalServiceRegistration;
settings.AdditionalServiceRegistration = services =>
{
existingRegistration?.Invoke(services);
services.AddWireMockOpenTelemetry(openTelemetryOptions);
};
}
return Start(settings);
}
#endif
/// <summary>
/// Start WireMock.Net standalone Server based on the commandline arguments.
/// </summary>
@@ -71,7 +107,13 @@ public static class StandAloneApp
settings.Logger?.Info("Version [{0}]", Version);
settings.Logger?.Debug("Server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
#if OPENTELEMETRY_SUPPORTED
// Parse OpenTelemetry options separately using the OTEL project parser
OpenTelemetryOptionsParser.TryParseArguments(args, Environment.GetEnvironmentVariables(), out var openTelemetryOptions);
server = Start(settings, openTelemetryOptions);
#else
server = Start(settings);
#endif
return true;
}

View File

@@ -35,6 +35,11 @@
<DefineConstants>USE_ASPNETCORE;NET46</DefineConstants>
</PropertyGroup>
<!-- Enable OpenTelemetry exporter support for .NET 6+ -->
<PropertyGroup Condition="'$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' or '$(TargetFramework)' == 'net8.0'">
<DefineConstants>$(DefineConstants);OPENTELEMETRY_SUPPORTED</DefineConstants>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="PolySharp" Version="1.15.0">
<PrivateAssets>all</PrivateAssets>
@@ -42,4 +47,9 @@
</PackageReference>
<ProjectReference Include="..\WireMock.Net\WireMock.Net.csproj" />
</ItemGroup>
<!-- OpenTelemetry exporter for .NET 6+ -->
<ItemGroup Condition="'$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' or '$(TargetFramework)' == 'net8.0'">
<ProjectReference Include="..\WireMock.Net.OpenTelemetry\WireMock.Net.OpenTelemetry.csproj" />
</ItemGroup>
</Project>