Microsoft.Extensions.Diagnostics.HealthChecks

A simple implementation of which uses a provided delegate to implement the check.

Create an instance of from the specified delegate.

A delegate which provides the code to execute when the health check is run.

Runs the health check, returning the status of the component being checked.

A context object associated with the current execution. A that can be used to cancel the health check. A that completes when the health check has finished, yielding the status of the component being checked.

Creates a new instance of with the provided name.

The name of the health check being executed.

Options for the default service that executes instances.

Creates a new instance of .

Gets or sets the initial delay applied after the application starts before executing instances. The delay is applied once at startup, and does not apply to subsequent iterations. The default value is 5 seconds.

Gets or sets the period of execution. The default value is 30 seconds.

The cannot be set to a value lower than 1 second.

Gets or sets a predicate that is used to filter the set of health checks executed.

If is null, the health check publisher service will run all registered health checks - this is the default behavior. To run a subset of health checks, provide a function that filters the set of checks. The predicate will be evaluated each period.

Gets or sets the timeout for executing the health checks an all instances. Use to execute with no timeout. The default value is 30 seconds.

A service which can be used to check the status of instances registered in the application.

The default implementation of is registered in the dependency injection container as a singleton service by calling . The returned by provides a convenience API for registering health checks. implementations can be registered through extension methods provided by .

Runs all the health checks in the application and returns the aggregated status.

A which can be used to cancel the health checks. A which will complete when all the health checks have been run, yielding a containing the results.

Runs the provided health checks and returns the aggregated status

A predicate that can be used to include health checks based on user-defined criteria. A which can be used to cancel the health checks. A which will complete when all the health checks have been run, yielding a containing the results.

Options for the default implementation of

Gets the health check registrations.

Provides basic extension methods for registering instances in an .

Adds a new health check with the specified name and implementation.

The . The name of the health check. An instance. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used to filter health checks. The .

Adds a new health check with the specified name and implementation.

The health check implementation type. The . The name of the health check. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used to filter health checks. The . This method will use to create the health check instance when needed. If a service of type is registered in the dependency injection container with any lifetime it will be used. Otherwise an instance of type will be constructed with access to services from the dependency injection container.

Adds a new health check with the specified name and implementation.

The health check implementation type. The . The name of the health check. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used to filter health checks. An optional representing the timeout of the check. The . This method will use to create the health check instance when needed. If a service of type is registered in the dependency injection container with any lifetime it will be used. Otherwise an instance of type will be constructed with access to services from the dependency injection container.

Adds a new type activated health check with the specified name and implementation.

The health check implementation type. The . The name of the health check. Additional arguments to provide to the constructor. The . This method will use to create the health check instance when needed. Additional arguments can be provided to the constructor via .

Adds a new type activated health check with the specified name and implementation.

The health check implementation type. The . The name of the health check. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. Additional arguments to provide to the constructor. The . This method will use to create the health check instance when needed. Additional arguments can be provided to the constructor via .

Adds a new type activated health check with the specified name and implementation.

The health check implementation type. The . The name of the health check. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used to filter health checks. Additional arguments to provide to the constructor. The . This method will use to create the health check instance when needed. Additional arguments can be provided to the constructor via .

Adds a new type activated health check with the specified name and implementation.

The health check implementation type. The . The name of the health check. The that should be reported when the health check reports a failure. If the provided value is null, then will be reported. A list of tags that can be used to filter health checks. Additional arguments to provide to the constructor. A representing the timeout of the check. The . This method will use to create the health check instance when needed. Additional arguments can be provided to the constructor via .

Provides extension methods for registering delegates with the .

Adds a new health check with the specified name and implementation.

The . The name of the health check. A list of tags that can be used to filter health checks. A delegate that provides the health check implementation. The .

Adds a new health check with the specified name and implementation.

The . The name of the health check. A list of tags that can be used to filter health checks. A delegate that provides the health check implementation. An optional representing the timeout of the check. The .

Adds a new health check with the specified name and implementation.

The . The name of the health check. A list of tags that can be used to filter health checks. A delegate that provides the health check implementation. The .

Adds a new health check with the specified name and implementation.

The . The name of the health check. A list of tags that can be used to filter health checks. A delegate that provides the health check implementation. The .

Adds a new health check with the specified name and implementation.

The . The name of the health check. A list of tags that can be used to filter health checks. A delegate that provides the health check implementation. The .

Adds a new health check with the specified name and implementation.

Provides extension methods for registering in an .

Adds the to the container, using the provided delegate to register health checks.

This operation is idempotent - multiple invocations will still only result in a single instance in the . It can be invoked multiple times in order to get access to the in multiple places. The to add the to. An instance of from which health checks can be registered.

A builder used to register health checks.

Adds a for a health check.

The .

Gets the into which instances should be registered.

Throws an if is null.

The reference type argument to validate as non-null. The name of the parameter with which corresponds.

Throws an if is null or empty.

The argument to validate as non-null and non-empty. The name of the parameter with which corresponds.

Indicates that the specified method requires the ability to generate new code at runtime, for example through .

This allows tools to understand which methods are unsafe to call when compiling ahead of time.

Initializes a new instance of the class with the specified message.

A message that contains information about the usage of dynamic code.

Gets a message that contains information about the usage of dynamic code.

Gets or sets an optional URL that contains more information about the method, why it requires dynamic code, and what options a consumer has to deal with it.

Indicates that the specified method requires dynamic access to code that is not referenced statically, for example through .

This allows tools to understand which methods are unsafe to call when removing unreferenced code from an application.

Initializes a new instance of the class with the specified message.

A message that contains information about the usage of unreferenced code.

Gets a message that contains information about the usage of unreferenced code.

Gets or sets an optional URL that contains more information about the method, why it requires unreferenced code, and what options a consumer has to deal with it.

Suppresses reporting of a specific rule violation, allowing multiple suppressions on a single code artifact.

is different than in that it doesn't have a . So it is always preserved in the compiled assembly.

Initializes a new instance of the class, specifying the category of the tool and the identifier for an analysis rule.

The category for the attribute. The identifier of the analysis rule the attribute applies to.

Gets the category identifying the classification of the attribute.

The property describes the tool or tool analysis category for which a message suppression attribute applies.

Gets the identifier of the analysis tool rule to be suppressed.

Concatenated together, the and properties form a unique check identifier.

Gets or sets the scope of the code that is relevant for the attribute.

The Scope property is an optional argument that specifies the metadata scope for which the attribute is relevant.

Gets or sets a fully qualified path that represents the target of the attribute.

The property is an optional argument identifying the analysis target of the attribute. An example value is "System.IO.Stream.ctor():System.Void". Because it is fully qualified, it can be long, particularly for targets such as parameters. The analysis tool user interface should be capable of automatically formatting the parameter.

Gets or sets an optional argument expanding on exclusion criteria.

The property is an optional argument that specifies additional exclusion where the literal metadata target is not sufficiently precise. For example, the cannot be applied within a method, and it may be desirable to suppress a violation against a statement in the method that will give a rule violation, but not against all statements in the method.

Gets or sets the justification for suppressing the code analysis message.

States a dependency that one member has on another.

This can be used to inform tooling of a dependency that is otherwise not evident purely from metadata and IL, for example a member relied on via reflection.

Initializes a new instance of the class with the specified signature of a member on the same type as the consumer.

The signature of the member depended on.

Initializes a new instance of the class with the specified signature of a member on a .

The signature of the member depended on. The containing .

Initializes a new instance of the class with the specified signature of a member on a type in an assembly.

The signature of the member depended on. The full name of the type containing the specified member. The assembly name of the type containing the specified member.

Initializes a new instance of the class with the specified types of members on a .

The types of members depended on. The containing the specified members.

Initializes a new instance of the class with the specified types of members on a type in an assembly.

The types of members depended on. The full name of the type containing the specified members. The assembly name of the type containing the specified members.

Gets the signature of the member depended on.

Either must be a valid string or must not equal , but not both.

Gets the which specifies the type of members depended on.

Either must be a valid string or must not equal , but not both.

Gets the containing the specified member.

If neither nor are specified, the type of the consumer is assumed.

Gets the full name of the type containing the specified member.

If neither nor are specified, the type of the consumer is assumed.

Gets the assembly name of the specified type.

is only valid when is specified.

Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".

Indicates that certain members on a specified are accessed dynamically, for example through .

This allows tools to understand which members are being accessed during the execution of a program. This attribute is valid on members whose type is or . When this attribute is applied to a location of type , the assumption is that the string represents a fully qualified type name. When this attribute is applied to a class, interface, or struct, the members specified can be accessed dynamically on instances returned from calling on instances of that class, interface, or struct. If the attribute is applied to a method it's treated as a special case and it implies the attribute should be applied to the "this" parameter of the method. As such the attribute should only be used on instance methods of types assignable to System.Type (or string, but no methods will use it there).

Initializes a new instance of the class with the specified member types.

The types of members dynamically accessed.

Gets the which specifies the type of members dynamically accessed.

Specifies the types of members that are dynamically accessed. This enumeration has a attribute that allows a bitwise combination of its member values.

Specifies no members.

Specifies the default, parameterless public constructor.

Specifies all public constructors.

Specifies all non-public constructors.

Specifies all public methods.

Specifies all non-public methods.

Specifies all public fields.

Specifies all non-public fields.

Specifies all public nested types.

Specifies all non-public nested types.

Specifies all public properties.

Specifies all non-public properties.

Specifies all public events.

Specifies all non-public events.

Specifies all interfaces implemented by the type.

Specifies all members.

Specifies that null is allowed as an input even if the corresponding type disallows it.

Specifies that null is disallowed as an input even if the corresponding type allows it.

Specifies that an output may be null even if the corresponding type disallows it.

Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.

Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter may be null.

Gets the return value condition.

Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter will not be null.

Gets the return value condition.

Specifies that the output will be non-null if the named parameter is non-null.

Initializes the attribute with the associated parameter name.

The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.

Gets the associated parameter name.

Applied to a method that will never return under any circumstance.

Specifies that the method will not return if the associated Boolean parameter is passed the specified value.

Initializes the attribute with the specified parameter value.

The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value.

Gets the condition parameter value.

Specifies that the method or property will ensure that the listed field and property members have not-null values.

Initializes the attribute with a field or property member.

The field or property member that is promised to be not-null.

Initializes the attribute with the list of field and property members.

The list of field and property members that are promised to be not-null.

Gets field or property member names.

Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.

Initializes the attribute with the specified return value condition and a field or property member.

The return value condition. If the method returns this value, the associated parameter will not be null. The field or property member that is promised to be not-null.

Initializes the attribute with the specified return value condition and list of field and property members.

The return value condition. If the method returns this value, the associated parameter will not be null. The list of field and property members that are promised to be not-null.

Gets the return value condition.

Gets field or property member names.