macpaw / symfony-health-check-bundle Goto Github PK

View Code? Open in Web Editor NEW

41.0 9.0 5.0 196 KB

Symfony Health Check Bundle Monitoring Project Status

Home Page: https://github.com/MacPaw/symfony-health-check-bundle

License: MIT License

PHP 100.00%

php symfony-bundle check health-check healthcheck symfony-health-check symfony monitoring bundle health

symfony-health-check-bundle's Introduction

Symfony Health Check Bundle

Version	Build Status	Code Coverage
`master`
`develop`

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute:

composer require macpaw/symfony-health-check-bundle

Applications that don't use Symfony Flex

enable the bundle by adding it to the list of registered bundles in config/bundles.php

// config/bundles.php
<?php

return [
            SymfonyHealthCheckBundle\SymfonyHealthCheckBundle::class => ['all' => true],

        // ...
    ];

Create Symfony Health Check Bundle Config:

Configurating health check - all available you can see here.

# config/packages/symfony_health_check.yaml`
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_check
    ping_checks:
        - id: symfony_health_check.status_up_check

Change response code:

default response code is 200.
determine your custom response code in case of some check fails (Response code must be a valid HTTP status code)

symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_check
    ping_checks:
        - id: symfony_health_check.status_up_check
    ping_error_response_code: 500
    health_error_response_code: 404

Create Symfony Health Check Bundle Routing Config:

config/routes/symfony_health_check.yaml

health_check:
    resource: '@SymfonyHealthCheckBundle/Resources/config/routes.xml'

Step 3: Configuration

Security Optional:

If you are using symfony/security and your health check is to be used anonymously, add a new firewall to the configuration

# config/packages/security.yaml
    firewalls:
        healthcheck:
            pattern: ^/health
            security: false
        ping:
            pattern: ^/ping
            security: false

Step 4: Additional settings

Add Custom Check:

It is possible to add your custom health check:

<?php

declare(strict_types=1);

namespace YourProject\Check;

use SymfonyHealthCheckBundle\Dto\Response;

class CustomCheck implements CheckInterface
{
    public function check(): Response
    {
        return new Response('status', true, 'up');
    }
}

Then we add our custom health check to collection

symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_check
        - id: custom_health_check // custom service check id

How Change Route:

You can change the default behavior with a light configuration, remember to modify the routes.

# config/routes/symfony_health_check.yaml
health:
    path: /your/custom/url
    methods: GET
    controller: SymfonyHealthCheckBundle\Controller\HealthController::check
    
ping:
    path: /your/custom/url
    methods: GET
    controller: SymfonyHealthCheckBundle\Controller\PingController::check

How To Use Healthcheck In Docker

HEALTHCHECK --start-period=15s --interval=5s --timeout=3s --retries=3 CMD curl -sS {{your host}}/health || exit 1

symfony-health-check-bundle's People

Contributors

Stargazers

Watchers

Forkers

lol768 tkachenko jpvdw86 oparshyna tacman

symfony-health-check-bundle's Issues

Add new parameter fail-fast: (bool)

fail-fast = true -> if 1 check failed -> return result
fail-fast = false -> all check run then return result

Deprecation message autowiring alias ContainerInterface

Using Symfony 5.3 the profiler shows the following deprecation message:

Since symfony/dependency-injection 5.1: The "Symfony\Component\DependencyInjection\ContainerInterface" autowiring alias is deprecated. Define it explicitly in your app if you want to keep using it. It is being referenced by the "symfony_health_check.doctrine_check" service.
Show context    Hide trace
{▼
  /app/vendor/symfony/dependency-injection/Compiler/ResolveReferencesToAliasesPass.php:68 {▼
    Symfony\Component\DependencyInjection\Compiler\ResolveReferencesToAliasesPass->getDefinitionId(string $id, ContainerBuilder $container): string …
    ›     $deprecation = $alias->getDeprecation($id);
    ›     trigger_deprecation($deprecation['package'], $deprecation['version'], rtrim($deprecation['message'], '. ').'. It is being referenced by the "%s" '.($container->hasDefinition($this->currentId) ? 'service.' : 'alias.'), $this->currentId);
    › }
  }
  /app/vendor/symfony/dependency-injection/Compiler/ResolveReferencesToAliasesPass.php:51 {▼
    › 
    › $defId = $this->getDefinitionId($id = (string) $value, $this->container);
    › 
  }
}

Exclude successful responses from logs

Is there any way to remove successful requests from the logs? My log files are flooded with requests (level:200/channel:request) in among all normal routing requests (which I want to retain), I can get around the log analysis by using filters but the log files are huge and it seems counterintuitive to have them both. Any advice would be most welcome.

Add parameter Custom Error Json Response errorResponseCode: int (default: 200);

errorResponseCode: int (default: 200);
If one of check is failed your Json Response Code change to your custom response code.

Release 1.03 is considered higher than 1.1.0

Describe the bug
When installing the package via Composer, the latest version downloaded is 1.03, being considered newer than 1.1.0. I believe this is because version 1.03 is considered "1.3", and thus newer than 1.1.0.

To Reproduce
a. Install the bundle via Symfony Flex
b. Install the package directly
c. Check on packagist that 1.03 is sorted as newer than 1.1.0

Expected behaviour
Version 1.1.0 is installed

Screenshots

Proposed solution
Republish the latest release as 1.4, which would be newer than 1.03. Since the changes in 1.1.0 are not breaking, updating the minor version would no harm, while ensure both users of 1.03and 1.1.0 know of the update.

Create Response Check DTO for standarting response

Response:

{
 'name': (string) 'checkName',
 'result': (bool) 'checkName',
 'message': (string) 'Ok|ErrorMessage'
 'params': (array) [ ] -> free array for addition information
}

Deprecated message autowiring alias ContainerInterface

Using Symfony 5.3 the profiler shows the following deprecation message:

Since symfony/dependency-injection 5.1: The "Symfony\Component\DependencyInjection\ContainerInterface" autowiring alias is deprecated. Define it explicitly in your app if you want to keep using it. It is being referenced by the "symfony_health_check.doctrine_check" service.
Show context    Hide trace
{▼
  /app/vendor/symfony/dependency-injection/Compiler/ResolveReferencesToAliasesPass.php:68 {▼
    Symfony\Component\DependencyInjection\Compiler\ResolveReferencesToAliasesPass->getDefinitionId(string $id, ContainerBuilder $container): string …
    ›     $deprecation = $alias->getDeprecation($id);
    ›     trigger_deprecation($deprecation['package'], $deprecation['version'], rtrim($deprecation['message'], '. ').'. It is being referenced by the "%s" '.($container->hasDefinition($this->currentId) ? 'service.' : 'alias.'), $this->currentId);
    › }
  }
  /app/vendor/symfony/dependency-injection/Compiler/ResolveReferencesToAliasesPass.php:51 {▼
    › 
    › $defId = $this->getDefinitionId($id = (string) $value, $this->container);
    › 
  }
}

Remove automatical create release

because now GitHub have this feature

Doctrine deprecated ping()

In this doctrine/dbal#4119 doctrine deprecated the ping method and is removed in version 3. I think it would be a good idea to reflect this in https://github.com/MacPaw/symfony-health-check-bundle/blob/develop/src/Check/DoctrineCheck.php. Currently the doctrine check return doctrine => false if you're using doctrine 3.

Multiple routes with different check

Hi!

Is it possible to have multiple routes configured to have different checks in different routes?
Use case is kubernetes liveness and readiness probes:

liveness probe is the one we would like to have running pretty often (each 10 sec) and having doctrine check in it is too much.
but readiness probe can be done using longer interval (once per minute) and include doctrine check to make sure everything is setup correctly

Thanks!