healthchecks-client

• What it does
• Installation
• Usage
  • HTTP Health Check
  • Options
  • Version
• Example
• How it works
• License
• Author

A lightweight CLI tool for monitoring services and reporting to healthchecks.io.

What it does

Performs health checks on your services and automatically reports success/failure to healthchecks.io monitoring service.

Installation

go install github.com/meysam81/healthchecks-client@latest

Usage

HTTP Health Check

healthchecks-client http-check \
  --ping-url https://hc-ping.com/your-uuid \
  --http-target http://your-service.com/health

Options

--ping-url, -p      Your healthchecks.io ping URL (required)
--http-target, -t   Service endpoint to check (required)
--timeout           Request timeout in seconds (default: 5)
--http-method       HTTP method to use (default: GET)
--status-code       Expected HTTP status code (default: 200)

Version

healthchecks-client version

Example

# Monitor a web service
healthchecks-client http-check \
  -p https://hc-ping.com/12345678-1234-1234-1234-123456789abc \
  -t https://api.example.com/health \
  --timeout 10 \
  --status-code 200

How it works

1. Sends a "start" ping to healthchecks.io
2. Performs the health check on your target service
3. Reports success (exit code 0) or failure (exit code 1) back to healthchecks.io

License

Apache License 2.0 - see LICENSE for details.

Author

Meysam Azad