prgtw/healthchecks-bundle

Bundle for integration with healthchecks.io cron monitoring service

0.9.1 2022-11-03 17:54 UTC

Requires

• php: ^7.0
• ext-json: *
• jms/serializer: ^1.6 || ^2.0 || ^3.0
• jms/serializer-bundle: ^1.5 || ^2.0 || ^3.0
• php-http/client-implementation: ^1.0
• php-http/discovery: ^1.5.1
• php-http/httplug: ^1.0 || ^2.0
• php-http/message-factory: ^1.0
• psr/http-message-implementation: ^1.0
• symfony/config: ^2.8 || ^3.0 || ^4.0
• symfony/console: ^2.8 || ^3.0 || ^4.0
• symfony/dependency-injection: ^2.8,>=2.8.51 || ^3.0,>=3.4.26 || ^4.1,>=4.1.12 || ^4.2,>=4.2.7
• symfony/http-kernel: ^2.8 || ^3.0 || ^4.0
• symfony/options-resolver: ^2.8 || ^3.0 || ^4.0
• symfony/process: ^2.8 || ^3.0 || ^4.0

Requires (Dev)

• guzzlehttp/psr7: ^1.4
• php-http/message: ^1.5
• php-http/mock-client: ^1.0
• roave/security-advisories: dev-master

MIT

• Tomasz Wójcik

• symfony
• bundle
• cron
• monitoring
• healthchecks

README

Bundle enables integration with healthchecks.io.

TODO:

• implement concurrent requests

Installation

1. Require the prgtw/healthchecks-bundle package in your composer.json and update your dependencies.

   composer require prgtw/healthchecks-bundle

2. Add the HealthchecksBundle to your application's kernel:

   public function registerBundles()
   {
   	$bundles = [
   		// ...
   		new prgTW\HealthchecksBundle(),
   		// ...
   	];
   	// ...
   }

Configuration

Example configuration:

healthchecks:
    api:
        clients:
            example: "api-key-here"
    timezone: "Europe/Warsaw" # default timezone to use for checks
    checks:
    	simple:
            client: example
            name: "Simple hourly check"
            timeout: 3600
            tags: [simple, all]
        cron:
            client: example
            name: "Cron-based check"
            schedule: "*/30 * * * *"
            timezone: UTC
            tags: [cron, all]

Usage

$api = $container->get('healthchecks.api');

// setup checks on healthchecks.io side according to configuration
$api->setup('simple');
$api->setupMany(['simple', 'cron']);

// ping check(s)
$api->ping('simple');
$api->pingMany(['simple', 'cron']);

// pause check(s)
$api->pause('simple');
$api->pauseMany(['simple', 'cron']);

Providing checks data at runtime

To provide checks data at runtime you have to create your own resolver, and you have to configure bundle to use this resolver instead of default one

For example:

namespace App\Healthchecks\Resolver;

use prgTW\HealthchecksBundle\Resolver\ResolverInterface;

class CustomResolver implements ResolverInterface
{
	public function resolve()
	{
		// Get the data from your source and map your array in such format: 
		return [
			'backup_task'  => [
				'name'     => 'Backup task',
				'schedule' => '15 2 * * *',
				'client'   => 'dev',
				'tags'     => ['backup', 'devops'],
				'unique'   => ['name', 'tags'],
			],
			'cleanup_task' => [
				'name'     => 'Cleanup task',
				'schedule' => '0 3 * * *',
				'client'   => 'dev',
				'tags'     => ['backup', 'devops'],
				'unique'   => ['name', 'tags'],
			],
		];
	}

	public function resolveNames(): array
	{
		return ['backup_task', 'cleanup_task'];
	}
}

services:
    healthchecks.resolver.custom:
        class: "App\\Healthchecks\\Resolver\\CustomResolver"

healthchecks:
    api:
        clients:
            example: "api-key-here"
    timezone: "Europe/Warsaw" # default timezone to use for checks
    resolver: "healthchecks.resolver.custom" #Service ID of your custom resolver