health_check_module library

Classes

HealthCheckModule: HealthCheckModule is a Serinus module that provides a health check endpoint and service.
HealthCheckService: The HealthCheckService is responsible for executing all registered health indicators and compiling their results into a comprehensive health report. It also handles error logging based on the specified style when any health check fails.
HealthController: The controller responsible for handling health check requests. It defines a GET endpoint that triggers the health check process and returns the results.
HealthIndicator: The skeleton of an indicator injectable in the HealthCheckModule. Each indicator must implement the pingCheck method, which performs the actual health check and returns a HealthIndicatorCheck containing the status and any relevant details.

ErrorLogStyle: Style of error logging for health check failures.
HealthStatus: A module that provides a health check endpoint and service for Serinus applications. It allows you to define custom health indicators and specify how errors should be logged when a health check fails.

HealthIndicatorCheck = ({Map<String, dynamic>? details, HealthStatus status}): A record type representing the result of a health indicator check, containing the status and optional details about the check.