Class ManagementHostBuilderExtensions

Inheritance

System.Object

ManagementHostBuilderExtensions

Namespace: Steeltoe.Management.Endpoint

Assembly: Steeltoe.Management.EndpointCore.dll

Syntax

public static class ManagementHostBuilderExtensions : object

Methods

| Edit this page View Source

ActivateActuatorEndpoints(IServiceCollection, Action<IEndpointConventionBuilder>)

Registers an that will map all configured actuators, initialize health

Declaration

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

Parameters

Type	Name	Description
IServiceCollection	collection	that has actuators to activate
Action<IEndpointConventionBuilder>	configureEndpoints	IEndpointConventionBuilder customizations (such as auth policy customization)

| Edit this page View Source

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

Adds all standard actuators to the application

Declaration

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

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder
Action<IEndpointConventionBuilder>	configureEndpoints	Customize endpoint behavior. Useful for tailoring auth requirements
MediaTypeVersion	mediaTypeVersion	Specify the media type version to use in the response
Action<CorsPolicyBuilder>	buildCorsPolicy	Customize the CORS policy.

Returns

Type	Description
IHostBuilder

Remarks

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

| Edit this page View Source

AddCloudFoundryActuator(IHostBuilder)

Adds the Cloud Foundry actuator to the application

Declaration

public static IHostBuilder AddCloudFoundryActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddDbMigrationsActuator(IHostBuilder)

Adds the Database Migrations actuator to the application

Declaration

public static IHostBuilder AddDbMigrationsActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddEnvActuator(IHostBuilder)

Adds the Environment actuator to the application

Declaration

public static IHostBuilder AddEnvActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddHealthActuator(IHostBuilder)

Adds the Health actuator to the application

Declaration

public static IHostBuilder AddHealthActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddHealthActuator(IHostBuilder, IHealthAggregator, Type[])

Adds the Health actuator to the application

Declaration

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

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder
IHealthAggregator	aggregator	Custom health aggregator
Type[]	contributors	Types that contribute to the overall health of the app

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddHealthActuator(IHostBuilder, Type[])

Adds the Health actuator to the application

Declaration

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

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder
Type[]	contributors	Types that contribute to the overall health of the app

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddHeapDumpActuator(IHostBuilder)

Adds the HeapDump actuator to the application

Declaration

public static IHostBuilder AddHeapDumpActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddHypermediaActuator(IHostBuilder)

Adds the Hypermedia actuator to the application

Declaration

public static IHostBuilder AddHypermediaActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddInfoActuator(IHostBuilder)

Adds the Info actuator to the application

Declaration

public static IHostBuilder AddInfoActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddInfoActuator(IHostBuilder, IInfoContributor[])

Adds the Info actuator to the application

Declaration

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

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder
IInfoContributor[]	contributors	Contributors to application information

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddLoggersActuator(IHostBuilder)

Adds the Loggers actuator to the application

Declaration

public static IHostBuilder AddLoggersActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddMappingsActuator(IHostBuilder)

Adds the Mappings actuator to the application

Declaration

public static IHostBuilder AddMappingsActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddMetricsActuator(IHostBuilder)

Adds the Metrics actuator to the application

Declaration

public static IHostBuilder AddMetricsActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddRefreshActuator(IHostBuilder)

Adds the Refresh actuator to the application

Declaration

public static IHostBuilder AddRefreshActuator(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddThreadDumpActuator(IHostBuilder, MediaTypeVersion)

Adds the ThreadDump actuator to the application

Declaration

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

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder
MediaTypeVersion	mediaTypeVersion	Specify the media type version to use in the response

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddTraceActuator(IHostBuilder, MediaTypeVersion)

Adds the Trace actuator to the application

Declaration

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

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your HostBuilder
MediaTypeVersion	mediaTypeVersion	Specify the media type version to use in the response

Returns

Type	Description
IHostBuilder

| Edit this page View Source

AddWavefrontMetrics(IHostBuilder)

Add wavefront metrics to the application

Declaration

public static IHostBuilder AddWavefrontMetrics(this IHostBuilder hostBuilder)

Parameters

Type	Name	Description
IHostBuilder	hostBuilder	Your Hostbuilder

Returns

Type	Description
IHostBuilder	The updated HostBuilder