sahc

module
v0.0.0-...-dfab05a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 26, 2019 License: MIT

README

Service Availability Health Check - SAHC

Go Report Card

About

SAHC aka Service Availability Health Check is a service used to check the availability of services and provide much needed actions and events to handle it. SAHC is a background runner service which will periodically run to check the status of given services.

Features

  • SACH is a stateless application with inbuilt Leveldb for managing the status of services.
  • Provides hot re-loading of configurations.
  • API endpoints to access and update the configurations.
  • YAML support for configurations.
  • TCP streaming for realtime monitoring data and healthz endpoint for health checks.

Configuration

1. YAML

The example of YAML configuration is as follows.

version: 0.1
services:
  - name: localhost:9990
    interval: 10
  - name: localhost:9991
    interval: 11
  - name: localhost:9992
    interval: 16

services describe all the services you need to keep checking.

Services takes in an array and consist of

  • name : The host address.
  • interval: The health check interval in seconds.

Note:
You need to set the env variable SAHC_CONFIG to pass the configuration file name. If not the service will fail running..

[working on documenting better..]

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL