Question 1

How do I create a custom health checker with dimiro1/health?

Accepted Answer

Implement the Checker interface with a Check() method that returns a Health struct. The README provides an example for a disk space checker, showing how to add custom logic and info like free space thresholds.

Question 2

dimiro1/health vs go-health: which Go health check library is better?

Accepted Answer

dimiro1/health is more lightweight and focuses on extensibility with a stable API, while go-health might offer more built-in checkers. Choose based on whether you prioritize simplicity and custom checks or broader out-of-the-box support.

Question 3

How can I test health checks using this library?

Accepted Answer

Install test dependencies like go-sqlmock and redigomock with `go get -t`, as mentioned in the Testing section, to mock database and Redis connections for reliable unit testing.

Question 4

Does dimiro1/health support health checks for PostgreSQL?

Accepted Answer

No, it only has built-in support for MySQL. For PostgreSQL, you need to implement a custom checker using the database/sql package or similar, which requires additional development effort.

Question 5

How to set up a health check endpoint with multiple dependencies?

Accepted Answer

Use composite checkers to group checkers hierarchically, add them to a handler, and expose via HTTP. The example shows adding URL, MySQL, and Redis checkers to a handler for organized monitoring.

Question 6

What HTTP status codes does dimiro1/health return?

Accepted Answer

It returns HTTP 200 OK when all checks are UP and 503 Service Unavailable if any check is DOWN, with detailed JSON responses that include error info for troubleshooting.

health

What is health?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions