Hygeia is a modular health checking tool, It is written in Javascript and designed and thought for deploying in many different scenarios such as AWS Lambda, Express Middleware, Hapi Plugin or Moleculer Service.

• Modular: Hygeia was designed to be as configurable as it was possible, its modular design makes it different and it allows you to use several tools for checking the status of services.
• Deployment agnostic: It can be used in many different environments, Javascript allows you to use it on a background process in Node.js, as an endpoint of a RESTful API or as an AWS Lambda function.

Learn how to use Hygeia JS in your projects.

Documentation

You can find the Hygeia documentation on the website.
It is divided into several sections:

• Quick Start
• Advanced Guides
• API Reference
• Tutorial
• Where to Get Support
• Contributing Guide

You can improve it by sending pull requests to this repository.

Examples

We have several examples on the website. Here is the first one to get you started:

const store = new MemoryStore({
  data: [{ name: 'google', health: 'https://www.google.es', method: 'GET' }]
});
const reporters = [new EmailReporter({email: '[email protected]', policy: 'always'})];

const checker = new Checker({store, reporters});

checker.check()
    .then(() => console.log('Status checked for all the services.'))
    .then((err => console.log(err)));

Installation

Hygeia is available as a npm package: hygeia-js on npm.

NPM

npm i hygeia-js --save

YARN

yarn add hygeia-js

Contributing

The main purpose of this repository is to continue to evolve Hygeia core, making it faster and easier to use. Development of Hygeia happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Hygeia.

Code of Conduct

We have adopted a Code of Conduct from Facebook Open Source that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

TODO

<<search for contributing guide>>

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

License

Hygeia is MIT licensed.