orca-services/cakephp-heartbeat

A CakePHP plugin providing an application heartbeat status page with configurable sensors

2.1.0 2019-06-26 12:17 UTC

README

Heartbeat

A CakePHP plugin providing an application heartbeat status page with configurable sensors.

Compatibility

Plugin Version CakePHP Compatibility Branch Status
2.x 3.7+ cakephp-3.x Supported
1.x 2.x cakephp-2.x Supported
0.x 2.x - EOL

Note:

  • There is no plugin version for CakePHP 3.0-3.5.
  • Previous versions of the plugin that supported previous versions of CakePHP are not supported anymore

Security

If you've found a security vulnerability, please follow the procedure described in SECURITY.md.

Installation

See the installation documentation .

Configuration

See the configuration documentation .

How to use

See the usage guide and how to write heartbeat sensors.

Versioning

The releases of this plugin are versioned using SemVer.

Contributing

See CONTRIBUTING.md

Changelog

See CHANGELOG.md

Security

If you've found a security vulnerability, please follow the procedure described in SECURITY.md.

TODOs

  • Add badges
  • Fix & extend Unit Tests
  • Add Console application incl. related docs
  • Support for separate status text
  • Add flexible routing
  • CI integrations
  • Update screenshots in How to Use with new cache indicator
  • See the issues

License

This plugin is licensed under the MIT License.