zucommunications/health-check-bundle

Symfony bundle to provide a health check endpoint

v0.2.0 2024-07-10 16:01 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• symfony/console: 6.4.*
• symfony/dotenv: 6.4.*
• symfony/flex: ^2
• symfony/framework-bundle: 6.4.*
• symfony/property-access: 6.4.*
• symfony/runtime: 6.4.*
• symfony/serializer: 6.4.*
• symfony/yaml: 6.4.*

Requires (Dev)

• doctrine/dbal: ^3
• doctrine/doctrine-bundle: ^2.12
• doctrine/orm: ^3.2
• phpunit/phpunit: ^9.5
• symfony/browser-kit: 6.4.*
• symfony/css-selector: 6.4.*
• symfony/mailer: 6.4.*
• symfony/maker-bundle: ^1.60
• symfony/phpunit-bridge: ^7.1

Conflicts

• symfony/symfony: *

proprietary

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.

To configure the services to be checked, you can add the following configuration to your zu_health_check.yaml file:

zu_health_check:
    type:
        smtp: false
        doctrine: false

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 zu/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 file:

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.
• TODO: You can then run composer require zu/health-check-bundle to install the package.

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.