This project aims to provide a tool for monitoring health of various components belonging to a bigger eco-system (like SOA or Microservice Architecture).

HealthMonitoring offers a standalone, self-hosted tool that:

• offers an HTTP API for registering endpoints and obtaining health information about them,
• monitors (with configurable time periods) registered endpoints,
• offers a HTML dashboard to display the current status of monitored endpoints,
• offers an endpoint detailed HTML page to display endpoint details and health history.

The endpoint configuration and statistics are stored in a MySQL database (http://dev.mysql.com/downloads/mysql).

To build the project, please open a powershell console in project root folder and execute: PS> .\make\make_local.ps1

In order to successfully run all the tests, the following dependencies are required on localhost:

• RabbitMq

After a successful build, the root folder would contain built nuget packages (*.nupkg) that can be used to install Health Monitor or to integrate with it.

The Health Monitoring service is self hosted and consists of 2 parts:

• the HealthMonitoring.SelfHost project is a console application that is responsible for:
  • providing management API,
  • providing HTML UI (web pages),
  • persisting Health Monitor data,
• the HealthMonitoring.Monitors.SelfHost project is a console application that is responsible for running monitors.

The easiest way to install it is to:

1. install a HealthMonitoring.Service-deploy nuget package in target folder for the API/website,

• (optionally) edit HealthMonitoring.SelfHost.exe.config to customise API host settings

2. install a HealthMonitoring.Monitors.Service-deploy nuget package in target folder for the monitor process,

• make a monitors directory in target folder where HealthMonitoring.Monitors.SelfHost.exe is,
• install one or more HealthMonitoring.Monitors.XXX-deploy monitor packages in monitors directory,
• edit HealthMonitoring.Monitors.SelfHost.exe.config and specify proper URL for HealthMonitoringUrl setting (if changed),
• (optionally) edit HealthMonitoring.Monitors.SelfHost.exe.config and add monitor specific configuration,

3. run HealthMonitoring.SelfHost.exe to start a console application for API or run install_service.cmd (located in API instalation folder) to register the health monitor API as a windows service
4. run HealthMonitoring.Monitors.SelfHost.exe to start a console application for monitors or run install_service.cmd (located in monitor instalation folder) to register the health monitor API as a windows service

If health monitor is installed with default settings and it is running, it's home page would be available at http://localhost:9000/ address. It will display home page of the Health Monitor as well as provide urls to:

• API documentation (with ability to execute API commands),
• to the dashboard,
• to project site (this page).

The endpoint registration has to be done via WEB API and it can be done via API documentation page (http://localhost:9000/swagger/ui/index) or any tool (like powershell command, or curl) that allows to make HTTP requests.

A POST /api/endpoints/register operation allows to do that. Below, there is an example request body to register a monitoring for http://google.com

{
  "Name": "Google",
  "Address": "http://google.com",
  "MonitorType": "http",
  "Group": "My group"
}

Please note that MonitorType value has to be one of supported monitors (they are installed as plugins), so in this scenario the HealthMonitoring.Monitors.Http monitor plugin has to be installed. To list the currently supported monitors, please use GET /api/monitors

Jasmine based tests are located in %project-root%/HealthMonitoring.UI.UnitTests/ project. You can run them in several ways:

1. In VisualStudio open Resharper tab > Options > Tools > Unit Testing.
2. Select browser you want and save changes.
3. Run jasmine tests from UnitTest Explorer (Ctrl+Alt+U) and observe results in browser.

1. Install NodeJS server (also by default will be installed npm and modified PATH variable).
2. In cmd or powershell go to %project-root%/HealthMonitoring.UI.UnitTests.
3. Execute command: npm install --save-dev
4. Execute command: karma start

Results of tests will be stored to %project-root%/reports/UI_Unit_Tests.xml|html and coverage report to %project-root%/reports/ui-coverage/.

(You can override reports dirs in %project-root%/HealthMonitoring.UI.UnitTests/karma.conf.js )

At last you can simply call PS> .\make\make_local.ps1. It will run all tests in project and save results to %project-root%/reports/.

Any kind of contribution is welcome :)

To contribute please:

• fork the repo,
• write code, unit tests and acceptance tests (if applicable),
• add nuspec file for the new plugin (if applicable) and ensure that it is being packaged with PS> .\make\make_local.ps1,
• ensure that PS> .\make\make_local.ps1 finish successfuly,
• update README.MD if necesarry,
• make a pull request.

To see more details, please visit the Wiki page of the project.