Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.36 KB

README.md

File metadata and controls

76 lines (56 loc) · 2.36 KB
Raw

Healtcheck

Monitor the health of your web applications, web servers, and other resources

Why?

I use it like this in my Dockerfile

HEALTHCHECK --interval=30s CMD ./node_modules/.bin/healthcheck localhost/liveness:8080

Or, perhaps you need a readiness check with a JSON search.

healthcheck localhost/readiness:8080 --type json --search ready=true;

Install

npm install @jwerre/healthcheck

Usage

const healthcheck = require('healtcheck');

const res = async healthcheck({
	url: 'https://google.com',
	method: 'GET',
	type: 'html',
	search: /^<!doctype html*/,
	timeout: 2000,
})

Options

Option Type Description
url String Request url (required).
method String Request port (default: 'GET').
timeout Number Request timeout in milliseconds (default: 800).
type String Type of healthcheck either status, header, html or json (default: status).
search * Search string to find in the response. If type is 'status' provide the status code you expect. If type is 'html' use a string or Regular Expression. If type is 'header' or 'json' provide a key and value as an array [key, value]. For nested values use dot syntax for the key e.g.: ['author.name.first', 'brian'

CLI

$ healthcheck --help

Monitor the health of your web applications, web servers, and other resources

Usage: 
healthcheck https://www.example.com
healthcheck --type html --search "^<!doctype html.*" https://www.example.com
healthcheck --method HEAD --type header --search "content-type=text/html; charset=UTF-8" https://www.example.com
healthcheck --type json --search key=value http://echo.jsontest.com/key/value
healthcheck --type json --search author.name.first=brian https://www.example.com


Options:
-m, --method		Request port (default: 'GET')
-t, --timeout		Request timeout in milliseconds (default: 800)
-T, --type			Type of healthcheck either status, headers, html or json (default: status)
-s, --search		Search string to find in the response. If type is 'status' 
					provide the status code you expect. If type is 'html' use a 
					string or Regular Expression. If type is 'header' or 'json' 
					provide a key and value as an array [key, value]. For nested 
					values use dot syntax for the key e.g.: ['author.name.first', 'brian']
-v, --verbose		Verbose output.
-h, --help			Show help.