/// <summary>
/// Add Thread Dump actuator endpoint to OWIN Pipeline
/// </summary>
/// <param name="builder">OWIN <see cref="IAppBuilder" /></param>
/// <param name="config"><see cref="IConfiguration"/> of application for configuring thread dump endpoint</param>
/// <param name="loggerFactory">For logging within the middleware</param>
/// <param name="version">MediaTypeVersion for endpoint response</param>
/// <returns>OWIN <see cref="IAppBuilder" /> with Thread Dump Endpoint added</returns>
public static IAppBuilder UseThreadDumpActuator(this IAppBuilder builder, IConfiguration config, ILoggerFactory loggerFactory, MediaTypeVersion version)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (config == null)
{
throw new ArgumentNullException(nameof(config));
}
var options = new ThreadDumpEndpointOptions(config);
if (version == MediaTypeVersion.V2 && options.Id == "dump")
{
options.Id = "threaddump";
}
var mgmtOptions = ManagementOptions.Get(config);
foreach (var mgmt in mgmtOptions)
{
mgmt.EndpointOptions.Add(options);
}
var threadDumper = new ThreadDumper(options, loggerFactory?.CreateLogger <ThreadDumper>());
return(builder.UseThreadDumpActuator(options, threadDumper, loggerFactory, version));
}
public void ThreadDumpEndpointMiddleware_PathAndVerbMatching_ReturnsExpected()
{
var actOptions = new ActuatorManagementOptions()
{
Path = "/",
Exposure = new Exposure {
Include = new List <string> {
"*"
}
}
};
var opts = new ThreadDumpEndpointOptions();
actOptions.EndpointOptions.Add(opts);
ThreadDumper obs = new ThreadDumper(opts);
var ep = new ThreadDumpEndpoint(opts, obs);
var middle = new ThreadDumpEndpointMiddleware(null, ep, new List <IManagementOptions> {
actOptions
});
Assert.True(middle.RequestVerbAndPathMatch("GET", "/dump"));
Assert.False(middle.RequestVerbAndPathMatch("PUT", "/dump"));
Assert.False(middle.RequestVerbAndPathMatch("GET", "/badpath"));
}
public void UseThreadDumpActuator_ThrowsIfOptionsNull()
{
IAppBuilder builder = new AppBuilder();
var threadDumper = new ThreadDumper(new ThreadDumpOptions());
var exception = Assert.Throws <ArgumentNullException>(() => builder.UseThreadDumpActuator(null, threadDumper));
Assert.Equal("options", exception.ParamName);
}
public void ThreadDumpEndpointMiddleware_PathAndVerbMatching_ReturnsExpected()
{
var opts = new ThreadDumpOptions();
ThreadDumper obs = new ThreadDumper(opts);
var ep = new ThreadDumpEndpoint(opts, obs);
var middle = new ThreadDumpEndpointMiddleware(null, ep);
Assert.True(middle.RequestVerbAndPathMatch("GET", "/dump"));
Assert.False(middle.RequestVerbAndPathMatch("PUT", "/dump"));
Assert.False(middle.RequestVerbAndPathMatch("GET", "/badpath"));
}
public void ThreadDumpEndpointMiddleware_PathAndVerbMatching_ReturnsExpected()
{
var opts = new ThreadDumpEndpointOptions();
var mgmtOptions = TestHelpers.GetManagementOptions(opts);
ThreadDumper obs = new ThreadDumper(opts);
var ep = new ThreadDumpEndpoint(opts, obs);
var middle = new EndpointOwinMiddleware <List <ThreadInfo> >(null, ep, mgmtOptions);
Assert.True(middle.RequestVerbAndPathMatch("GET", "/cloudfoundryapplication/dump"));
Assert.False(middle.RequestVerbAndPathMatch("PUT", "/cloudfoundryapplication/dump"));
Assert.False(middle.RequestVerbAndPathMatch("GET", "/cloudfoundryapplication/badpath"));
}
/// <summary>
/// Add Thread Dump actuator endpoint to OWIN Pipeline
/// </summary>
/// <param name="builder">OWIN <see cref="IAppBuilder" /></param>
/// <param name="config"><see cref="IConfiguration"/> of application for configuring thread dump endpoint</param>
/// <param name="loggerFactory">For logging within the middleware</param>
/// <returns>OWIN <see cref="IAppBuilder" /> with Thread Dump Endpoint added</returns>
public static IAppBuilder UseThreadDumpActuator(this IAppBuilder builder, IConfiguration config, ILoggerFactory loggerFactory = null)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (config == null)
{
throw new ArgumentNullException(nameof(config));
}
var options = new ThreadDumpOptions(config);
var threadDumper = new ThreadDumper(options, loggerFactory?.CreateLogger <ThreadDumper>());
return(builder.UseThreadDumpActuator(options, threadDumper, loggerFactory));
}
public void IsDumpRequest_ReturnsExpected()
{
var opts = new ThreadDumpOptions();
ThreadDumper obs = new ThreadDumper(opts);
var ep = new ThreadDumpEndpoint(opts, obs);
var middle = new ThreadDumpEndpointMiddleware(null, ep);
var context = CreateRequest("GET", "/dump");
Assert.True(middle.IsThreadDumpRequest(context));
var context2 = CreateRequest("PUT", "/dump");
Assert.False(middle.IsThreadDumpRequest(context2));
var context3 = CreateRequest("GET", "/badpath");
Assert.False(middle.IsThreadDumpRequest(context3));
}
public async void HandleThreadDumpRequestAsync_ReturnsExpected()
{
if (Environment.OSVersion.Platform == PlatformID.Win32NT)
{
var opts = new ThreadDumpOptions();
ThreadDumper obs = new ThreadDumper(opts);
var ep = new ThreadDumpEndpoint(opts, obs);
var middle = new ThreadDumpEndpointMiddleware(null, ep);
var context = CreateRequest("GET", "/dump");
await middle.HandleThreadDumpRequestAsync(context);
context.Response.Body.Seek(0, SeekOrigin.Begin);
StreamReader rdr = new StreamReader(context.Response.Body);
string json = await rdr.ReadToEndAsync();
Assert.StartsWith("[", json);
Assert.EndsWith("]", json);
}
}
public async void HandleThreadDumpRequestAsync_ReturnsExpected()
{
if (Platform.IsWindows)
{
var opts = new ThreadDumpEndpointOptions();
var mgmtOptions = new ActuatorManagementOptions();
mgmtOptions.EndpointOptions.Add(opts);
ThreadDumper obs = new ThreadDumper(opts);
var ep = new ThreadDumpEndpoint(opts, obs);
var middle = new ThreadDumpEndpointMiddleware(null, ep, mgmtOptions);
var context = CreateRequest("GET", "/dump");
await middle.HandleThreadDumpRequestAsync(context);
context.Response.Body.Seek(0, SeekOrigin.Begin);
var rdr = new StreamReader(context.Response.Body);
var json = await rdr.ReadToEndAsync();
Assert.StartsWith("[", json);
Assert.EndsWith("]", json);
}
}
