Class HeapDumpEndpointAppBuilderExtensions

Namespace

Steeltoe.Management.EndpointOwin.HeapDump

Assembly

Steeltoe.Management.EndpointOwin.dll

public static class HeapDumpEndpointAppBuilderExtensions

Inheritance

object

HeapDumpEndpointAppBuilderExtensions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

UseHeapDumpActuator(IAppBuilder, IConfiguration, string, ILoggerFactory)

Adds actuator endpoint providing Heap Dumps to OWIN pipeline

public static IAppBuilder UseHeapDumpActuator(this IAppBuilder builder, IConfiguration config, string applicationPathOnDisk = null, ILoggerFactory loggerFactory = null)

Parameters

builder IAppBuilder

Your Owin.IAppBuilder

config IConfiguration

IConfiguration for configuring the endpoint

applicationPathOnDisk string

Provide the path to the app directory if heap dumps are failing due to access restrictions

loggerFactory ILoggerFactory

ILoggerFactory for logging inside the middleware and its components

Returns

IAppBuilder

Your Owin.IAppBuilder with Heap Dump middleware attached

UseHeapDumpActuator(IAppBuilder, IHeapDumpOptions, IHeapDumper, ILoggerFactory)

Adds OWIN Middleware for providing Heap Dumps to OWIN pipeline

public static IAppBuilder UseHeapDumpActuator(this IAppBuilder builder, IHeapDumpOptions options, IHeapDumper heapDumper, ILoggerFactory loggerFactory = null)

Parameters

builder IAppBuilder

Your Owin.IAppBuilder

options IHeapDumpOptions

IHeapDumpOptions to configure the endpoint

heapDumper IHeapDumper

HeapDumper or other implementer of IHeapDumper for retrieving a heap dump

loggerFactory ILoggerFactory

ILoggerFactory for logging inside the middleware and its components

Returns

IAppBuilder

Your Owin.IAppBuilder with Heap Dump middleware attached