https://github.com/orca-services/cakephp-heartbeat
A CakePHP plugin providing an application heartbeat status page with configurable sensors
https://github.com/orca-services/cakephp-heartbeat
cakephp cakephp-plugin cakephp2 hacktoberfest heartbeat status-dashboard status-page statuspage
Last synced: 12 days ago
JSON representation
A CakePHP plugin providing an application heartbeat status page with configurable sensors
- Host: GitHub
- URL: https://github.com/orca-services/cakephp-heartbeat
- Owner: orca-services
- License: mit
- Created: 2017-04-04T17:06:52.000Z (almost 9 years ago)
- Default Branch: cakephp-4.x
- Last Pushed: 2025-12-15T14:32:05.000Z (about 1 month ago)
- Last Synced: 2025-12-18T18:49:01.112Z (about 1 month ago)
- Topics: cakephp, cakephp-plugin, cakephp2, hacktoberfest, heartbeat, status-dashboard, status-page, statuspage
- Language: PHP
- Homepage:
- Size: 407 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Heartbeat
A CakePHP plugin providing an application heartbeat status page with configurable sensors.
## Compatibility
| Plugin Version | CakePHP Compatibility | Branch | Status |
|----------------|-----------------------|-------------| --------- |
| 3.x | 4.6+ | cakephp-4.x | Supported |
| 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](.github/SECURITY.md).
## Installation
See the [installation documentation](docs/Installation.md) .
## Configuration
See the [configuration documentation](docs/Configuration.md) .
## How to use
See the [usage guide](docs/Usage.md) and [how to write heartbeat sensors](docs/Sensors.md).
## Versioning
The releases of this plugin are versioned using [SemVer](http://semver.org/).
## Contributing
See [CONTRIBUTING.md](.github/CONTRIBUTING.md)
## Changelog
See [CHANGELOG.md](CHANGELOG.md)
## Security
If you've found a security vulnerability, please follow the procedure
described in [SECURITY.md](.github/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](docs/Usage.md) with new cache indicator
- See [the issues](https://github.com/orca-services/cakephp-heartbeat/issues)
## License
This plugin is licensed under the [MIT License](LICENSE).