healthcheck

README

healthcheck - A Go package for healthcheck

Installation

To install the package, run:

go get github.com/go-zoox/healthcheck

Getting Started

package main

import (
	"context"

	"github.com/go-zoox/healthcheck"
)

func main() {
	// HTTP
	ok, err := healthcheck.HTTP("https://github.com")
	if err != nil {
		panic(err)
	}
	fmt.Println("HTTP => https://github.com", ok)

	// TCP
	ok, err = healthcheck.TCP("127.0.0.1", 443)
	if err != nil {
		panic(err)
	}
	fmt.Println("TCP => 127.0.0.1:443", ok)

	// Ping
	ok, err = healthcheck.Ping("github.com")
	if err != nil {
		panic(err)
	}
	fmt.Println("Ping => github.com", ok)

	// Keyword in HTTP response
	ok, err = healthcheck.Keyword("https://github.com", "GitHub")
	if err != nil {
		panic(err)
	}
	fmt.Println("Keyword => https://github.com", ok)
}

License

GoZoox is released under the MIT License.

Documentation

Index

• Variables
• func HTTP(url string, opts ...*HTTPOptions) (ok bool, err error)
• func Keyword(url, keyword string, opts ...*KeywordOptions) (bool, error)
• func Ping(domain string, timeout ...time.Duration) (ok bool, err error)
• func TCP(ip string, port int, timeout ...time.Duration) (ok bool, err error)
• func UDP(ip string, port int, timeout ...time.Duration) (ok bool, err error)
• type HTTPOptions
• type HealthCheck
  • func New() HealthCheck
• type KeywordOptions

Variables

var Version = "1.3.2"

Version is the current version of the i18n package.

Functions

func HTTP

func HTTP(url string, opts ...*HTTPOptions) (ok bool, err error)

HTTP checks if the given url is healthy (reachable) via HTTP

func Keyword

func Keyword(url, keyword string, opts ...*KeywordOptions) (bool, error)

Keyword checks if the given url is healthy (reachable) via HTTP and contains the given keyword

func Ping

func Ping(domain string, timeout ...time.Duration) (ok bool, err error)

Ping checks if a domain is reachable.

func TCP

func TCP(ip string, port int, timeout ...time.Duration) (ok bool, err error)

TCP checks if the given ip and port is healthy (reachable) via TCP

func UDP

func UDP(ip string, port int, timeout ...time.Duration) (ok bool, err error)

UDP checks if the given ip and port is healthy (reachable) via UDP

Types

type HTTPOptions

type HTTPOptions struct {
	Timeout time.Duration
	//
	Method string
	Header map[string]string
	Query  map[string]string
	Body   any
	//
	OkStatusCodes []int
	//
	Ok func(response *fetch.Response) bool
}

HTTPOptions is the options for the HTTP health check

type HealthCheck

type HealthCheck interface {
	// HTTP checks if the given url is healthy (reachable) via HTTP
	HTTP(url string, opts ...*HTTPOptions) (ok bool, err error)

	// TCP checks if the given ip and port is healthy (reachable) via TCP
	TCP(ip string, port int, timeout ...time.Duration) (ok bool, err error)

	// UDP checks if the given ip and port is healthy (reachable) via UDP
	UDP(ip string, port int, timeout ...time.Duration) (ok bool, err error)

	// Ping checks if the given domain is healthy (reachable) via ICMP
	Ping(domain string, timeout ...time.Duration) (ok bool, err error)

	// Keyword checks if the given url is healthy (reachable) via HTTP and contains the given keyword
	Keyword(url, keyword string, opts ...*KeywordOptions) (bool, error)
}

HealthCheck is the interface for health check

func New

func New() HealthCheck

New returns a new HealthCheck

type KeywordOptions

type KeywordOptions struct {
	HTTPOptions
}

KeywordOptions is the options for keyword health check