Skip to content

Fix actuators when used with UsePathBase #1618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bart-vmware merged 5 commits into from
Nov 20, 2025
Merged

Fix actuators when used with UsePathBase #1618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
41d3123
Dispose CapturingLoggerProvider in tests
bart-vmware Nov 17, 2025
80a022a
Remove redundant typeof(...).FullName in string interpolations
bart-vmware Nov 17, 2025
5ec561e
Log warning on configureMiddleware false with custom middleware
bart-vmware Nov 17, 2025
417ff2f
Add support for UsePathBase in actuators
bart-vmware Nov 17, 2025
d7f634d
Apply suggestions from code review
bart-vmware Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Common/test/Hosting.Test/HostBuilderWrapperTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public async Task WebApplicationBuilder_Wraps()
["foo"] = "bar"
};

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));

WebApplicationBuilder builder = TestWebApplicationBuilderFactory.Create();

Expand Down Expand Up @@ -57,7 +57,7 @@ public void HostApplicationBuilder_Wraps()
["foo"] = "bar"
};

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));

HostApplicationBuilder builder = TestHostApplicationBuilderFactory.Create();

Expand Down Expand Up @@ -91,7 +91,7 @@ public void WebHostBuilder_Wraps()
["foo"] = "bar"
};

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));

WebHostBuilder builder = TestWebHostBuilderFactory.Create();

Expand Down Expand Up @@ -128,7 +128,7 @@ public void GenericHostBuilder_Wraps()
["foo"] = "bar"
};

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Test", StringComparison.Ordinal));

HostBuilder builder = TestHostBuilderFactory.CreateWeb();

Expand Down
2 changes: 1 addition & 1 deletion src/Common/test/Logging.Test/BootstrapperLoggerFactoryTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public sealed class BootstrapperLoggerFactoryTest
[Fact]
public async Task Upgrades_existing_loggers()
{
var capturingLoggerProvider = new CapturingLoggerProvider(categoryName => categoryName.StartsWith("Test", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(categoryName => categoryName.StartsWith("Test", StringComparison.Ordinal));

var bootstrapLoggerFactory = BootstrapLoggerFactory.CreateEmpty(loggingBuilder =>
{
Expand Down
58 changes: 29 additions & 29 deletions src/Discovery/test/Eureka.Test/Transport/EurekaClientTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ public sealed class EurekaClientTest
[Fact]
public async Task RegisterAsync_ThrowsOnUnreachableServer()
{
var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand Down Expand Up @@ -161,15 +161,15 @@ public async Task RegisterAsync_ThrowsOnUnreachableServer()
IList<string> logMessages = capturingLoggerProvider.GetAll();

logMessages.Should().BeEquivalentTo(
$"DBUG {typeof(EurekaClient).FullName}: Sending POST request to 'http://host-that-does-not-exist.net:9999/apps/FOOBAR' with body: " +
$"DBUG {typeof(EurekaClient)}: Sending POST request to 'http://host-that-does-not-exist.net:9999/apps/FOOBAR' with body: " +
"""{"instance":{"instanceId":"some","app":"FOOBAR","ipAddr":"127.0.0.1","port":{"@enabled":"true","$":8080},"securePort":{"@enabled":"false","$":9090},"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"localhost","overriddenstatus":"UNKNOWN","metadata":{"@class":"java.util.Collections$EmptyMap"},"lastUpdatedTimestamp":"1708427732823","lastDirtyTimestamp":"1708427732823"}}.""",
$"WARN {typeof(EurekaClient).FullName}: Failed to execute HTTP POST request to 'http://host-that-does-not-exist.net:9999/apps/FOOBAR' in attempt 1.");
$"WARN {typeof(EurekaClient)}: Failed to execute HTTP POST request to 'http://host-that-does-not-exist.net:9999/apps/FOOBAR' in attempt 1.");
}

[Fact]
public async Task RegisterAsync_ThrowsOnErrorResponse()
{
var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand Down Expand Up @@ -208,17 +208,17 @@ public async Task RegisterAsync_ThrowsOnErrorResponse()

logMessages.Should().BeEquivalentTo(
[
$"DBUG {typeof(EurekaClient).FullName}: Sending POST request to 'http://localhost:8761/eureka/apps/FOOBAR' with body: " +
$"DBUG {typeof(EurekaClient)}: Sending POST request to 'http://localhost:8761/eureka/apps/FOOBAR' with body: " +
"""{"instance":{"instanceId":"some","app":"FOOBAR","ipAddr":"127.0.0.1","port":{"@enabled":"true","$":8080},"securePort":{"@enabled":"false","$":9090},"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"localhost","overriddenstatus":"UNKNOWN","metadata":{"@class":"java.util.Collections$EmptyMap"},"lastUpdatedTimestamp":"1708427732823","lastDirtyTimestamp":"1708427732823"}}.""",
$"DBUG {typeof(EurekaClient).FullName}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' returned status 404 in attempt 1.",
$"INFO {typeof(EurekaClient).FullName}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' failed with status 404: Sorry!"
$"DBUG {typeof(EurekaClient)}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' returned status 404 in attempt 1.",
$"INFO {typeof(EurekaClient)}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' failed with status 404: Sorry!"
], options => options.WithStrictOrdering());
}

[Fact]
public async Task RegisterAsync_ThrowsOnRetryLimitReached()
{
var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand Down Expand Up @@ -254,10 +254,10 @@ public async Task RegisterAsync_ThrowsOnRetryLimitReached()

logMessages.Should().BeEquivalentTo(
[
$"DBUG {typeof(EurekaClient).FullName}: Sending POST request to 'http://localhost:8761/eureka/apps/FOOBAR' with body: " +
$"DBUG {typeof(EurekaClient)}: Sending POST request to 'http://localhost:8761/eureka/apps/FOOBAR' with body: " +
"""{"instance":{"instanceId":"some","app":"FOOBAR","ipAddr":"127.0.0.1","port":{"@enabled":"true","$":8080},"securePort":{"@enabled":"false","$":9090},"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"localhost","overriddenstatus":"UNKNOWN","metadata":{"@class":"java.util.Collections$EmptyMap"},"lastUpdatedTimestamp":"1708427732823","lastDirtyTimestamp":"1708427732823"}}.""",
$"DBUG {typeof(EurekaClient).FullName}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' returned status 404 in attempt 1.",
$"INFO {typeof(EurekaClient).FullName}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' failed with status 404: "
$"DBUG {typeof(EurekaClient)}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' returned status 404 in attempt 1.",
$"INFO {typeof(EurekaClient)}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' failed with status 404: "
], options => options.WithStrictOrdering());
}

Expand All @@ -266,7 +266,7 @@ public async Task RegisterAsync_LogsWarningOnCloudWithLocalhost()
{
using var scope = new EnvironmentVariableScope("VCAP_APPLICATION", "{}");

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand All @@ -293,13 +293,13 @@ public async Task RegisterAsync_LogsWarningOnCloudWithLocalhost()
IList<string> logMessages = capturingLoggerProvider.GetAll();

logMessages.Should().Contain(
$"WARN {typeof(EurekaClient).FullName}: Registering with hostname 'localhost' in containerized or cloud environments may not be valid. Please configure Eureka:Instance:HostName with a non-localhost address.");
$"WARN {typeof(EurekaClient)}: Registering with hostname 'localhost' in containerized or cloud environments may not be valid. Please configure Eureka:Instance:HostName with a non-localhost address.");
}

[Fact]
public async Task RegisterAsync_SendsRequestToServer()
{
var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

using JsonDocument requestDocument = JsonDocument.Parse("""
{
Expand Down Expand Up @@ -364,16 +364,16 @@ public async Task RegisterAsync_SendsRequestToServer()

logMessages.Should().BeEquivalentTo(
[
$"DBUG {typeof(EurekaClient).FullName}: Sending POST request to 'http://localhost:8761/eureka/apps/FOOBAR' with body: " +
$"DBUG {typeof(EurekaClient)}: Sending POST request to 'http://localhost:8761/eureka/apps/FOOBAR' with body: " +
"""{"instance":{"instanceId":"some","app":"FOOBAR","ipAddr":"127.0.0.1","port":{"@enabled":"true","$":8080},"securePort":{"@enabled":"false","$":9090},"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"localhost","overriddenstatus":"UNKNOWN","metadata":{"@class":"java.util.Collections$EmptyMap"},"lastUpdatedTimestamp":"1708427732823","lastDirtyTimestamp":"1708427732823"}}.""",
$"DBUG {typeof(EurekaClient).FullName}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' returned status 204 in attempt 1."
$"DBUG {typeof(EurekaClient)}: HTTP POST request to 'http://localhost:8761/eureka/apps/FOOBAR' returned status 204 in attempt 1."
], options => options.WithStrictOrdering());
}

[Fact]
public async Task RegisterAsync_TriesSecondServerIfFirstOneFails()
{
var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand Down Expand Up @@ -408,13 +408,13 @@ public async Task RegisterAsync_TriesSecondServerIfFirstOneFails()

logMessages.Should().BeEquivalentTo(
[
$"DBUG {typeof(EurekaClient).FullName}: Sending POST request to 'http://server1:8761/apps/FOOBAR' with body: " +
$"DBUG {typeof(EurekaClient)}: Sending POST request to 'http://server1:8761/apps/FOOBAR' with body: " +
"""{"instance":{"instanceId":"some","app":"FOOBAR","ipAddr":"127.0.0.1","port":{"@enabled":"true","$":8080},"securePort":{"@enabled":"false","$":9090},"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"localhost","overriddenstatus":"UNKNOWN","metadata":{"@class":"java.util.Collections$EmptyMap"},"lastUpdatedTimestamp":"1708427732823","lastDirtyTimestamp":"1708427732823"}}.""",
$"DBUG {typeof(EurekaClient).FullName}: HTTP POST request to 'http://server1:8761/apps/FOOBAR' returned status 404 in attempt 1.",
$"INFO {typeof(EurekaClient).FullName}: HTTP POST request to 'http://server1:8761/apps/FOOBAR' failed with status 404: ",
$"DBUG {typeof(EurekaClient).FullName}: Sending POST request to 'http://server2:8761/apps/FOOBAR' with body: " +
$"DBUG {typeof(EurekaClient)}: HTTP POST request to 'http://server1:8761/apps/FOOBAR' returned status 404 in attempt 1.",
$"INFO {typeof(EurekaClient)}: HTTP POST request to 'http://server1:8761/apps/FOOBAR' failed with status 404: ",
$"DBUG {typeof(EurekaClient)}: Sending POST request to 'http://server2:8761/apps/FOOBAR' with body: " +
"""{"instance":{"instanceId":"some","app":"FOOBAR","ipAddr":"127.0.0.1","port":{"@enabled":"true","$":8080},"securePort":{"@enabled":"false","$":9090},"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"localhost","overriddenstatus":"UNKNOWN","metadata":{"@class":"java.util.Collections$EmptyMap"},"lastUpdatedTimestamp":"1708427732823","lastDirtyTimestamp":"1708427732823"}}.""",
$"DBUG {typeof(EurekaClient).FullName}: HTTP POST request to 'http://server2:8761/apps/FOOBAR' returned status 204 in attempt 2."
$"DBUG {typeof(EurekaClient)}: HTTP POST request to 'http://server2:8761/apps/FOOBAR' returned status 204 in attempt 2."
], options => options.WithStrictOrdering());
}

Expand Down Expand Up @@ -606,7 +606,7 @@ public async Task GetApplicationsAsync_ThrowsOnBrokenJsonResponse()
{
const string jsonResponse = """{"applications": {""";

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand All @@ -630,11 +630,10 @@ public async Task GetApplicationsAsync_ThrowsOnBrokenJsonResponse()

IList<string> logMessages = capturingLoggerProvider.GetAll();

logMessages.Should().BeEquivalentTo(
[
$"DBUG {typeof(EurekaClient).FullName}: Sending GET request to 'http://localhost:8761/eureka/apps' without request body.",
$"DBUG {typeof(EurekaClient).FullName}: HTTP GET request to 'http://localhost:8761/eureka/apps' returned status 200 in attempt 1.",
$"DBUG {typeof(EurekaClient).FullName}: Failed to deserialize HTTP response from GET 'http://localhost:8761/eureka/apps'."
logMessages.Should().BeEquivalentTo([
$"DBUG {typeof(EurekaClient)}: Sending GET request to 'http://localhost:8761/eureka/apps' without request body.",
$"DBUG {typeof(EurekaClient)}: HTTP GET request to 'http://localhost:8761/eureka/apps' returned status 200 in attempt 1.",
$"DBUG {typeof(EurekaClient)}: Failed to deserialize HTTP response from GET 'http://localhost:8761/eureka/apps'."
], options => options.WithStrictOrdering());
}

Expand Down Expand Up @@ -713,7 +712,8 @@ public async Task GetByVipAsync_SendsRequestToServer()
[Fact]
public async Task Redacts_HTTP_headers()
{
var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("System.Net.Http.HttpClient", StringComparison.Ordinal));
using var capturingLoggerProvider =
new CapturingLoggerProvider(category => category.StartsWith("System.Net.Http.HttpClient", StringComparison.Ordinal));

var services = new ServiceCollection();
services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider));
Expand Down
4 changes: 2 additions & 2 deletions src/Discovery/test/HttpClients.Test/RegisterMultipleDiscoveryClientsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ public void MultipleEurekaVCAPs_LogsWarning()
using var appScope = new EnvironmentVariableScope("VCAP_APPLICATION", env1);
using var servicesScope = new EnvironmentVariableScope("VCAP_SERVICES", env2);

var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal));
using var loggerFactory = new LoggerFactory([capturingLoggerProvider]);

var configurationBuilder = new ConfigurationBuilder();
Expand All @@ -434,7 +434,7 @@ public void MultipleEurekaVCAPs_LogsWarning()
IList<string> logMessages = capturingLoggerProvider.GetAll();

logMessages.Should().BeEquivalentTo(
$"WARN {typeof(EurekaCloudFoundryPostProcessor).FullName}: Multiple Eureka service bindings found, which is not supported. Using the first binding from VCAP_SERVICES.");
$"WARN {typeof(EurekaCloudFoundryPostProcessor)}: Multiple Eureka service bindings found, which is not supported. Using the first binding from VCAP_SERVICES.");
}

[Fact]
Expand Down
6 changes: 3 additions & 3 deletions src/Logging/test/DynamicSerilog.Test/HostBuilderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ public async Task CanPreserveDefaultConsoleLoggerProvider()
logOutput.Should().Contain("SERILOG [ERR] TestError");

logOutput.Should().Contain($"""
info: {typeof(HostBuilderTest).FullName}[0]
info: {typeof(HostBuilderTest)}[0]
TestInfo
""");

logOutput.Should().Contain($"""
fail: {typeof(HostBuilderTest).FullName}[0]
fail: {typeof(HostBuilderTest)}[0]
TestError
""");
}
Expand Down Expand Up @@ -376,7 +376,7 @@ public async Task DynamicLevelChangeDoesNotAffectUsageOfNativeSerilogApi()
Log.Logger = new LoggerConfiguration().WriteTo.Console().CreateLogger();
Log.Logger.Information("TestInfoBefore");

var loggerProvider = host.Services.GetRequiredService<IDynamicLoggerProvider>();
using var loggerProvider = host.Services.GetRequiredService<IDynamicLoggerProvider>();
loggerProvider.SetLogLevel(string.Empty, LogLevel.Critical);

Log.Logger.Information("TestInfoAfter");
Expand Down
Loading