Download the PHP package oro/health-check-bundle without Composer

On this page you can find all versions of the php package oro/health-check-bundle. 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 oro/health-check-bundle

Informations about the package health-check-bundle

OroHealthCheckBundle

OroHealthCheckBundle implements a set of health checks for applications built on OroPlatform. Based on the Liip Monitor Bundle, it provides a way to perform the checks using the same configuration and environment that the application uses.

Table of Contents

Purpose

With OroHealthCheckBundle, you can learn about the environment and configuration health check results via the web UI, API and CLI. It helps you to ensure that the application environment is configured correctly, the external services integrated with the application are alive and accessible from the application.

It checks the following:

Basic usage

You can use the health check via:

If all health checks were successful, the bin/console monitor:health --env=prod command returns the 0 code. If at least one check has failed, the 1 code is returned.

Note: For an OroCommerce application, make sure that the %web_backend_prefix% parameter is used before health check urls. This parameter has /admin value by default. For example:

HealthCheck under Maintenance mode

Keep in mind that you will NOT be able to use any http request to your web server if it has the configured maintenance page. In this case, you can use only CLI commands illustrated in the Basic usage section.

When using healthcheck, you typically receive either the 200 or 502 http status codes. However, if you have any of the configurations listed below, you receive the 503 http status code.

For the Apache web server (in the .htaccess file)

For the Nginx web server (in the host configuration)

Built-in checks

Database server connection

Verifies the connection to the database via the application config.

Elasticsearch server connection

Verifies if Elasticsearch server is accessible and may be connected via the application functionality.

FileStorage state

Verifies if specific directories are accessible for writing:

Mail Transport connection

Verifies if the mail transport is configured correctly and is accessible.

RabbitMQ server connection

Verifies the connection to the RabbitMQ server via the application config.

Redis server connection

Verifies the connection to the Redis server via the application config.

WebSocket server connection

Verifies if the service is configured correctly and is running.

Maintenance Mode state

With OroHealthCheckBundle, the maintenance mode undergoes the following changes:

Health checks in the maintenance mode

The bundle configuration keeps the /healthcheck/http_status_checks path whitelisted as the endpoint for the API calls. If all health checks were successful, the /healthcheck/http_status_checks request returns the 200 response code. If at least one check has failed, the 502 response code is returned. The /healthcheck/http_status_check/<some_check_id> path is used for an individual check, with the same response codes.

The following example illustrates the configuration which can be used in config.yml to change the behavior of the maintenance mode:

Build your own check

Each health check class must implement the Laminas\Diagnostics\Check\CheckInterface interface.

This class must be defined as a Symfony service and tagged as liip_monitor.check in order to be picked up by the health check runner.

Alternatively, if you need to run various checks inside one service, implement the Laminas\Diagnostics\Check\CheckCollectionInterface interface. The getChecks() method of this interface returns an array of checks that need to be executed.

Then, tag it as a liip_monitor.check_collection.

Resources

All versions of health-check-bundle with dependencies

PHP Build Version
Package Version
Requires oro/platform-enterprise Version 6.0.*
liip/monitor-bundle Version 2.*
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 oro/health-check-bundle contains the following files

Loading the files please wait ....