README

此套餐能够与 healthchecks.io 集成。

待办事项

• 实现并发请求

安装

1. 在您的 composer.json 中要求 prgtw/healthchecks-bundle 套餐包，并更新您的依赖项。

   composer require prgtw/healthchecks-bundle

2. 将 HealthchecksBundle 添加到您的应用程序内核中

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

配置

示例配置

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]

用法

$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']);

在运行时提供检查数据

要在运行时提供检查数据，您必须创建自己的解析器，并且您必须配置套餐使用此解析器而不是默认解析器

例如

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