Download the PHP package katmore/healthsvc without Composer
On this page you can find all versions of the php package katmore/healthsvc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download katmore/healthsvc
More information about katmore/healthsvc
Files in katmore/healthsvc
Package healthsvc
Short Description health webservice
License MIT GPL-3.0+
Homepage https://github.com/katmore/healthsvc
Informations about the package healthsvc
Healthsvc
Healthsvc is a system health status service with a RESTful API interface. It can be used stand-alone or be integrated into existing projects. It is intended to be used conjunction with devops workflows, functional testing, monitoring software, etc.
Usage as Standalone Service
-
Download healthsvc:
-
Update using Composer:
-
Print list of available "host-sanity" tests using the
host-sanity-config.php
command-line utility -
Add a "host-sanity" test with the label "free-space" using the
host-sanity-config.php
command-line utility -
Configure endpoint for use with HTTP server:
-
Dev use only
- start the
webservice
command-line utility
- start the
-
Production or Dev
-
create a symlink to
healthsvc/web
dir in existing http root - --OR--
- use the
healthsvc/web
dir as the http root:
-
-
-
Test the
web/host-sanity.php
webservice endpoint-
For example, using
curl
command-line utility -
Example
web/host-sanity.php
response body when tests in "success" status (200/OK response code) - Example
web/host-sanity.php
response body when one or more tests has "failure" status (500/Internal Server Error response code)
-
Usage in Existing Projects
-
See PHP usage documentation for more details.
- Use Composer to add to an existing project.
Unit Tests
docs/coverage.txt
: unit test coverage reportphpunit.xml.dist
: PHPUnit configuration filetests/phpunit
: source code for unit tests
To perform unit tests, execute phpunit located in the vendor/bin
directory.
The tests.sh
wrapper script is provided for convenience.
Legal
"Healthsvc" is distributed under the terms of the GPLv3 license.
Copyright (c) 2018-2019, Doug Bird. All rights reserved.