Download the PHP package ovenlab/cakephp-health without Composer

On this page you can find all versions of the php package ovenlab/cakephp-health. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ovenlab/cakephp-health

Informations about the package cakephp-health

CakePHP Health

CI Latest Stable Version License

Health checks and readiness/liveness probes for CakePHP 5 applications.

Ship your app with the endpoints load balancers, Kubernetes, and uptime monitors expect — plus a CLI probe with a meaningful exit code — driven by a small set of pluggable checks.

Requirements

Installation

Load the plugin (or add it to Application::bootstrap()):

Configuration

Copy the example config and adjust it:

The plugin auto-loads config/health.php during bootstrap.

The detailed endpoint guard

GET /health/live and GET /health/ready are always public and only ever return status strings. GET /health also returns check messages and data, so it is guarded. Access is granted when:

  1. no guard is configured (handy for local dev), or
  2. the client IP is in guard.allowIp, or
  3. the request carries a matching token via the X-Health-Token header or the ?token= query string.

Built-in checks

Check Class Key options
Database Health\Check\DatabaseCheck connection
Cache Health\Check\CacheCheck config
Disk space Health\Check\DiskSpaceCheck path, warningThreshold, criticalThreshold

Writing a custom check

Implement Health\Check\HealthCheckInterface and return a Result:

Then register it in config/health.php:

A check should never throw — report failures as Result::critical(). If one does throw, the runner catches it and reports the check as critical, so a single broken check can never take down the whole probe.

Kubernetes example

CLI

License

MIT © Vinicius Arantes

All versions of cakephp-health with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
cakephp/cakephp Version ^5.0
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ovenlab/cakephp-health contains the following files

Loading the files please wait ...