Table of Contents

Class ManagementHostBuilderExtensions

Namespace
Steeltoe.Management.Endpoint
Assembly
Steeltoe.Management.EndpointCore.dll
public static class ManagementHostBuilderExtensions
Inheritance
ManagementHostBuilderExtensions
Inherited Members

Methods

ActivateActuatorEndpoints(IServiceCollection, Action<IEndpointConventionBuilder>)

Registers an IStartupFilter that will map all configured actuators, initialize health

public static void ActivateActuatorEndpoints(this IServiceCollection collection, Action<IEndpointConventionBuilder> configureEndpoints = null)

Parameters

collection IServiceCollection

Microsoft.Extensions.DependencyInjection.IServiceCollection that has actuators to activate

configureEndpoints Action<IEndpointConventionBuilder>

IEndpointConventionBuilder customizations (such as auth policy customization)

AddAllActuators(IHostBuilder, Action<IEndpointConventionBuilder>, MediaTypeVersion, Action<CorsPolicyBuilder>)

Adds all standard actuators to the application

public static IHostBuilder AddAllActuators(this IHostBuilder hostBuilder, Action<IEndpointConventionBuilder> configureEndpoints = null, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2, Action<CorsPolicyBuilder> buildCorsPolicy = null)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

configureEndpoints Action<IEndpointConventionBuilder>

Customize endpoint behavior. Useful for tailoring auth requirements

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

buildCorsPolicy Action<CorsPolicyBuilder>

Customize the CORS policy.

Returns

IHostBuilder

Remarks

Does not add platform specific features (like for Cloud Foundry or Kubernetes)

AddCloudFoundryActuator(IHostBuilder)

Adds the Cloud Foundry actuator to the application

public static IHostBuilder AddCloudFoundryActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddDbMigrationsActuator(IHostBuilder)

Adds the Database Migrations actuator to the application

public static IHostBuilder AddDbMigrationsActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddEnvActuator(IHostBuilder)

Adds the Environment actuator to the application

public static IHostBuilder AddEnvActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddHealthActuator(IHostBuilder)

Adds the Health actuator to the application

public static IHostBuilder AddHealthActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddHealthActuator(IHostBuilder, IHealthAggregator, Type[])

Adds the Health actuator to the application

public static IHostBuilder AddHealthActuator(this IHostBuilder hostBuilder, IHealthAggregator aggregator, Type[] contributors)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

aggregator IHealthAggregator

Custom health aggregator

contributors Type[]

Types that contribute to the overall health of the app

Returns

IHostBuilder

AddHealthActuator(IHostBuilder, Type[])

Adds the Health actuator to the application

public static IHostBuilder AddHealthActuator(this IHostBuilder hostBuilder, Type[] contributors)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

contributors Type[]

Types that contribute to the overall health of the app

Returns

IHostBuilder

AddHeapDumpActuator(IHostBuilder)

Adds the HeapDump actuator to the application

public static IHostBuilder AddHeapDumpActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddHypermediaActuator(IHostBuilder)

Adds the Hypermedia actuator to the application

public static IHostBuilder AddHypermediaActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddInfoActuator(IHostBuilder)

Adds the Info actuator to the application

public static IHostBuilder AddInfoActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddInfoActuator(IHostBuilder, IInfoContributor[])

Adds the Info actuator to the application

public static IHostBuilder AddInfoActuator(this IHostBuilder hostBuilder, IInfoContributor[] contributors)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

contributors IInfoContributor[]

Contributors to application information

Returns

IHostBuilder

AddLoggersActuator(IHostBuilder)

Adds the Loggers actuator to the application

public static IHostBuilder AddLoggersActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddMappingsActuator(IHostBuilder)

Adds the Mappings actuator to the application

public static IHostBuilder AddMappingsActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddMetricsActuator(IHostBuilder)

Adds the Metrics actuator to the application

public static IHostBuilder AddMetricsActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddRefreshActuator(IHostBuilder)

Adds the Refresh actuator to the application

public static IHostBuilder AddRefreshActuator(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

Returns

IHostBuilder

AddThreadDumpActuator(IHostBuilder, MediaTypeVersion)

Adds the ThreadDump actuator to the application

public static IHostBuilder AddThreadDumpActuator(this IHostBuilder hostBuilder, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

Returns

IHostBuilder

AddTraceActuator(IHostBuilder, MediaTypeVersion)

Adds the Trace actuator to the application

public static IHostBuilder AddTraceActuator(this IHostBuilder hostBuilder, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2)

Parameters

hostBuilder IHostBuilder

Your HostBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

Returns

IHostBuilder

AddWavefrontMetrics(IHostBuilder)

Add wavefront metrics to the application

public static IHostBuilder AddWavefrontMetrics(this IHostBuilder hostBuilder)

Parameters

hostBuilder IHostBuilder

Your Hostbuilder

Returns

IHostBuilder

The updated HostBuilder