PHPackages                             oro/health-check-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. oro/health-check-bundle

ActiveLibrary[Utility & Helpers](/categories/utility)

oro/health-check-bundle
=======================

Oro Health Check Bundle

7.0.1(2mo ago)3248.8k↓34.5%OSL-3.0PHP

Since Jun 13Pushed 1mo ago10 watchersCompare

[ Source](https://github.com/oroinc/OroHealthCheckBundle)[ Packagist](https://packagist.org/packages/oro/health-check-bundle)[ Docs](https://github.com/oroinc/OroHealthCheckBundle.git)[ RSS](/packages/oro-health-check-bundle/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)Dependencies (6)Versions (121)Used By (0)

OroHealthCheckBundle
====================

[](#orohealthcheckbundle)

OroHealthCheckBundle implements a set of health checks for applications built on OroPlatform. Based on the [Liip Monitor Bundle](https://github.com/liip/LiipMonitorBundle), it provides a way to perform the checks using the same configuration and environment that the application uses.

Table of Contents
-----------------

[](#table-of-contents)

- [Purpose](#purpose)
- [Basic usage](#basic-usage)
- [HealthCheck under Maintenance mode](#%D1%80ealthcheck-under-maintenance-mode)
- [Built in checks](#built-in-checks)
- [Build your own check](#build-your-own-check)
- [Links](#links)

Purpose
-------

[](#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:

- Database server connection
- Elasticsearch server connection
- FileStorage state
- Mail Transport connection
- RabbitMQ server connection
- Redis server connection
- WebSocket server connection
- Maintenance Mode state

Basic usage
-----------

[](#basic-usage)

You can use the health check via:

- **CLI**. There are 2 available commands

    - the `bin/console monitor:list --env=prod` command provides a list of configured checks

    ```
    $ bin/console monitor:list --env=prod

    doctrine_dbal Check if Doctrine DBAL is available
    mail_transport Check if Mail Transport is available
    rabbitmq_server Check if RabbitMQ is available in case it is configured
    elasticsearch Check if Elasticsearch is available in case it is configured
    websocket Check if WebSocket server is available
    maintenance_mode Check if Maintenance Mode is running and not expired
    fs_cache_prod Check if "/var/www/var/cache/prod" is writable
    fs_logs Check if "/var/www/var/logs" is writable
    fs_var_data Check if "/var/www/var/data" is writable
    fs_web_media Check if "/var/www/public/media" is writable
    redis_cache Check if Redis cache is available
    redis_doctrine_cache Check if Redis doctrine cache is available
    redis_session_storage Check if Redis session storage is available
    ```

    - the `bin/console monitor:health --env=prod` command performs health checks

    ```
    $ bin/console monitor:health --env=prod

    OK Check if Doctrine DBAL is available
    OK Check if Mail Transport is available
    SKIP Check if RabbitMQ is available in case it is configured: RabbitMQ connection is not configured. Check Skipped.
    OK Check if Elasticsearch is available in case it is configured
    FAIL Check if WebSocket server is available: Not available
    FAIL Check if Maintenance Mode is running and not expired: Expired
    OK Check if "/var/www/var/cache/prod" is writable: The path is a writable directory.
    OK Check if "/var/www/var/logs" is writable: The path is a writable directory.
    OK Check if "/var/www/var/data" is writable: The path is a writable directory.
    OK Check if "/var/www/public/media" is writable: The path is a writable directory.
    OK Check if Redis cache is available
    OK Check if Redis doctrine cache is available
    OK Check if Redis session storage is available
    ```

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.

- **Web Interface**. All configured checks and REST API documentation are available on the page with `/healthcheck` path
- **HTTP Status endpoint**. Pages that send only HTTP status in response
    - `/healthcheck/http_status_checks` can be used to get status after all available checks are executed
    - `/healthcheck/http_status_check/` can be used to get status of a specific check (use `bin/console monitor:list --env=prod` to get check identifiers)
- **REST API**. Docs are available on the page with `/healthcheck` path

**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:

- `/admin/healthcheck`
- `/admin/healthcheck/http_status_check/`
- `/admin/healthcheck/http_status_checks`

HealthCheck under Maintenance mode
----------------------------------

[](#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](#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)

```

    RewriteEngine On

    # Maintenance mode rewrites
    RewriteCond %{DOCUMENT_ROOT}/maintenance.html -f
    RewriteCond %{DOCUMENT_ROOT}/../var/maintenance/maintenance_lock -f
    RewriteCond %{SCRIPT_FILENAME} !maintenance.html
    RewriteRule ^.*$ /maintenance.html [R=503,L]
    ErrorDocument 503 /maintenance.html

```

For the *Nginx* web server (in the host configuration)

```
server {
    location / {
        if (-f /var/www/var/maintenance/maintenance_lock) {
            return 503;
        }
    }

    # Error pages
    error_page 503 /maintenance.html;
    location = /maintenance.html {
        root /var/www/;
    }
}

```

Built-in checks
---------------

[](#built-in-checks)

### Database server connection

[](#database-server-connection)

Verifies the connection to the database via the application config.

### Elasticsearch server connection

[](#elasticsearch-server-connection)

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

### FileStorage state

[](#filestorage-state)

Verifies if specific directories are accessible for writing:

- cache
- logs
- data
- media

### Mail Transport connection

[](#mail-transport-connection)

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

### RabbitMQ server connection

[](#rabbitmq-server-connection)

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

### Redis server connection

[](#redis-server-connection)

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

### WebSocket server connection

[](#websocket-server-connection)

Verifies if the service is configured correctly and is running.

### Maintenance Mode state

[](#maintenance-mode-state)

With OroHealthCheckBundle, the maintenance mode undergoes the following changes:

#### Health checks in the maintenance mode

[](#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/` path is used for an individual check, with the same response codes.

- The `Oro\Bundle\MaintenanceBundle\Drivers\FileDriver` class is used as maintenance driver.

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

```
oro_health_check:
    maintenance_driver:
        options:
            file_path: %kernel.project_dir%/var/maintenance/maintenance_lock
```

Build your own check
--------------------

[](#build-your-own-check)

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

```