README

⚠️ This bundle is still in heavy development and not ready to be used!!! ⚠️

Introduction

This bundle provides a simple health check endpoint for your Symfony application. It can be used to check the status of your application and its services.

This bundle provides two endpoints: /ping for general health check /health-check for more detailed health check for configured services.

Error messages currently ask you to check logs, this has NOT been implemented yet.

Requirements

• PHP version (e.g., PHP 8.3 or higher)
• Symfony version (e.g., Symfony 6.4 or higher)

Doctrine Health Check

Requires symfony/orm-pack package.

Mailer Health Check

Requires symfony/mailer package.

Installation

Run the following command to install the package:

composer require zucommunications/health-check-bundle

Configuration

⚠️ Flex is currently not setup, so you need to manually enable the bundle. ⚠️ If you have symfony/flex installed, the bundle should be automatically enabled and you can skip this step.

If not, you can manually enable the bundle by adding the following line to your config/bundles.php file:

return [
    ...
    Zu\HealthCheckBundle\ZuHealthCheckBundle::class => ['all' => true],
    ...
];

Next you need to register the routes for the health check endpoints. You can do this by adding the following to your config/routes.yaml file:

...
zu_health_check_bundle:
  resource: '@ZuHealthCheckBundle/config/routes.yaml'
...

To configure the services to be checked, you can add the following configuration to your zu_health_check.yaml in the config/packages directory found at the root if your project:

zu_health_check:
    type:
        smtp: false
        doctrine: false

Development

• In order to run this bundle in a Symfony application, you need to clone this repository and add it to your Symfony application as a local package. https://aschmelyun.com/blog/installing-a-local-composer-package-in-your-php-project/
• If you are using docker (compose) for developement, you will need to volumne mount the directory to gain access to the code from within the contianer.

Tests

Run php bin/phpunit to run the tests or XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-text to see text coverage report.

We want to keep the test coverage as high as possible, so please make sure to write tests for any new code you write.