README.md

health-monitor-interface

Provides a shareable health monitoring interface and function to execute a list of checks. This allows applications to implement health checks that can be provided to their users. For example, the lite-for-jdbc library provides a default health check implementation that can be added to an application's list of health checks.

HealthCheckAll

healthCheckAll executes checks for a list of monitors asynchronously. Any error thrown by a check will be caught and transformed to an unhealthy response.

Gradle Setup

repositories {
    mavenCentral()
}

dependencies {
    api("com.target:health-monitor-interface:1.2.0")
}

Development

Building

Health Monitor Interface uses standard gradle tasks

./gradlew clean build

Discussions

We're using GitHub Discussions, so please chat with us there to talk about any questions, ideas, or changes you're thinking about.

Issues

Please report issues in the issues section of the repository

Contributing

Fork the repository and submit a pull request containing the changes, targeting the main branch. and detail the issue it's meant to address.

Code review standards

Code reviews will look for consistency with existing code standards and naming conventions.

Testing standards

All changes should include sufficient testing to prove it is working as intended.