Class HealthEndpointAppBuilderExtensions

Namespace

Steeltoe.Management.EndpointOwin.Health

Assembly

Steeltoe.Management.EndpointOwin.dll

public static class HealthEndpointAppBuilderExtensions

Inheritance

object

HealthEndpointAppBuilderExtensions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

UseHealthActuator(IAppBuilder, IConfiguration, ILoggerFactory)

Add HealthCheck actuator endpoint to OWIN Pipeline

public static IAppBuilder UseHealthActuator(this IAppBuilder builder, IConfiguration config, ILoggerFactory loggerFactory = null)

Parameters

builder IAppBuilder

OWIN Owin.IAppBuilder

config IConfiguration

IConfiguration of application for configuring health endpoint

loggerFactory ILoggerFactory

For logging within the middleware

Returns

IAppBuilder

OWIN Owin.IAppBuilder with Health Endpoint added

UseHealthActuator(IAppBuilder, IHealthOptions, ILoggerFactory)

Add HealthCheck middleware to OWIN Pipeline

public static IAppBuilder UseHealthActuator(this IAppBuilder builder, IHealthOptions options, ILoggerFactory loggerFactory = null)

Parameters

builder IAppBuilder

OWIN Owin.IAppBuilder

options IHealthOptions

IHealthOptions for configuring Health endpoint

loggerFactory ILoggerFactory

For logging within the middleware

Returns

IAppBuilder

OWIN Owin.IAppBuilder with Health Endpoint added

UseHealthActuator(IAppBuilder, IHealthOptions, IHealthAggregator, ILoggerFactory)

Add HealthCheck middleware to OWIN Pipeline

public static IAppBuilder UseHealthActuator(this IAppBuilder builder, IHealthOptions options, IHealthAggregator aggregator, ILoggerFactory loggerFactory = null)

Parameters

builder IAppBuilder

OWIN Owin.IAppBuilder

options IHealthOptions

IHealthOptions for configuring Health endpoint

aggregator IHealthAggregator

IHealthAggregator for determining how to report aggregate health of the application

loggerFactory ILoggerFactory

For logging within the middleware

Returns

IAppBuilder

OWIN Owin.IAppBuilder with Health Endpoint added

UseHealthActuator(IAppBuilder, IHealthOptions, IHealthAggregator, IEnumerable<IHealthContributor>, ILoggerFactory)

Add HealthCheck middleware to OWIN Pipeline

public static IAppBuilder UseHealthActuator(this IAppBuilder builder, IHealthOptions options, IHealthAggregator aggregator, IEnumerable<IHealthContributor> contributors, ILoggerFactory loggerFactory = null)

Parameters

builder IAppBuilder

OWIN Owin.IAppBuilder

options IHealthOptions

IHealthOptions for configuring Health endpoint

aggregator IHealthAggregator

IHealthAggregator for determining how to report aggregate health of the application

contributors IEnumerable<IHealthContributor>

A list of IHealthContributor to monitor for determining application health

loggerFactory ILoggerFactory

For logging within the middleware

Returns

IAppBuilder

OWIN Owin.IAppBuilder with Health Endpoint added