health monitoring webservice
Healthmon is a library that monitors, logs, and sends notifications for one or more Healthsvc webservice endpoints. Additionally, it provides webservice endpoints to examine the latest status and history of healthsvc webservice endpoints.
The following checkboxes describes features that are planned for inclusion in the Healthmon project. Checked items are currently implemented, unchecked items will be available in the future.
Monitoring and Logging
- Background worker to log the response a Healthsvc webservice endpoint.
- Background worker to monitor the logs and determine status of one or more Healthsvc endpoint tests.
- Background worker to monitor the status of one or more Healthsvc endpoint tests and send notifications.
- Webservice endpoint to provide the status of one or more Healthsvc endpoint tests.
- Webservice endpoint to allow a response to notifications.
Notifications
- push message via Amazon SNS
- push message via AMQP (i.e. RabbitMQ)
- SMS Text Message via Twilio Programmable SMS
- SMS Text Message via Amazon SNS Transactional SMS
- Telephone Voice Call via Twilio Programmable Voice
Use Composer to add to an existing project.
composer require katmore/healthmon
Download the project:
git clone https://github.com/katmore/healthmon.git
Update using Composer:
cd healthmon
composer update
coverage.txt
: unit test coverage reportphpunit.xml
: PHPUnit configuration filetests/phpunit
: source code for unit tests
To perform unit tests, execute phpunit located in the vendor/bin
directory.
vendor/bin/phpunit
The tests.sh
wrapper script is provided for convenience.
./tests.sh
"Healthmon" is distributed under the terms of the MIT license or the GPLv3 license.
Copyright (c) 2018, Doug Bird. All rights reserved.