https://github.com/katmore/healthsvc-mon
health monitoring webservice
https://github.com/katmore/healthsvc-mon
Last synced: about 1 month ago
JSON representation
health monitoring webservice
- Host: GitHub
- URL: https://github.com/katmore/healthsvc-mon
- Owner: katmore
- License: mit
- Created: 2018-12-11T20:39:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-04T22:59:36.000Z (over 7 years ago)
- Last Synced: 2025-10-20T12:44:29.179Z (9 months ago)
- Language: Shell
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Healthmon
health monitoring webservice
Healthmon is a library that monitors, logs, and sends notifications for one or more [Healthsvc](https://github.com/katmore/healthsvc) webservice endpoints.
Additionally, it provides webservice endpoints to examine the latest status and history of *healthsvc* webservice endpoints.
## Feature List
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](https://github.com/katmore/healthsvc) webservice endpoint.
- [ ] Background worker to monitor the logs and determine status of one or more [Healthsvc](https://github.com/katmore/healthsvc) endpoint tests.
- [ ] Background worker to monitor the status of one or more [Healthsvc](https://github.com/katmore/healthsvc) endpoint tests and send notifications.
- [ ] Webservice endpoint to provide the status of one or more [Healthsvc](https://github.com/katmore/healthsvc) endpoint tests.
- [ ] Webservice endpoint to allow a response to notifications.
**Notifications**
- [ ] **email**
- [ ] **push message** via [Amazon SNS](https://aws.amazon.com/sns/)
- [ ] **push message** via [AMQP](https://www.amqp.org/) (i.e. [RabbitMQ](https://www.rabbitmq.com/))
- [ ] **SMS Text Message** via [Twilio Programmable SMS](https://www.twilio.com/sms)
- [ ] **SMS Text Message** via [Amazon SNS Transactional SMS](https://aws.amazon.com/sns/sms-pricing/)
- [ ] **Telephone Voice Call** via [Twilio Programmable Voice](https://www.twilio.com/voice)
## Usage in Existing Projects
Use *Composer* to add to an existing project.
```sh
composer require katmore/healthmon
```
## Usage as Standalone Service
Download the project:
```sh
git clone https://github.com/katmore/healthmon.git
```
Update using *Composer*:
```sh
cd healthmon
composer update
```
## Unit Tests
* [`coverage.txt`](./coverage.txt): unit test coverage report
* [`phpunit.xml`](./phpunit.xml): PHPUnit configuration file
* [`tests/phpunit`](./tests/phpunit): source code for unit tests
To perform unit tests, execute phpunit located in the `vendor/bin` directory.
```sh
vendor/bin/phpunit
```
The [`tests.sh`](./tests.sh) wrapper script is provided for convenience.
```sh
./tests.sh
```
## Legal
"Healthmon" is distributed under the terms of the [MIT license](LICENSE) or the [GPLv3](GPLv3) license.
Copyright (c) 2018, Doug Bird. All rights reserved.