README

此包提供简单的方法与 healthchecks.io API 进行交互。

安装

composer require henrywhitaker3/healthchecks-io

用法

此包提供两个类供您使用

Healthchecks

此类仅用于更新 healthchecks.io 终端。

要创建一个新实例，您需要传递要更新的终端的 UUID

$hc = new Healthchecks('SAMPLE-UUID-HERE');

一旦创建了新实例，就有 3 个方法可以使用

$hc->success(); // sends a 'success' signal
$hc->fail(); // sends a 'fail' signal
$hc->start(); // sends a 'start' signal

HealthchecksManager

此类可用于与 healthchecks.io 管理API 交互。创建新实例很简单

$hm = new HealthchecksManager('SAMPLE-API-KEY');

现在您可以使用以下方法

$hm->listChecks(); // lists all checks
$hm->getCheck('UUID'); // get info for a specific check
$hm->pauseCheck('UUID'); // pauses a check
$hm->resumeCheck('UUID'); // pings a check to resume it
$hm->deleteCheck('UUID'); // deletes the check
$hm->getCheckPings('UUID'); // gets a list of pings for the check
$hm->getCheckStatusChanges('UUID'); // returns a list of "flips" this check has experienced
$hm->createCheck($args); // create a new check
$hm->updateCheck('UUID', $args); // update an existing check
$hm->integrations(); // get a list of integrations (i.e. slack, discord etc.)

贡献

欢迎贡献，但请为所添加的内容编写测试。在 tests/tests 目录中创建一个新文件，结构如下

<?php

namespace Henrywhitaker3\Healthchecks\Tests;

class NewTest extends Test
{
    //
}

由于这些测试需要有效的凭据和 UUID，您需要设置一个 .env 文件才能成功运行测试。只需将 .env.example 复制到 .env 并填写相关信息。

henrywhitaker3 / healthchecks-io

维护者

详情

README

安装

用法

Healthchecks

HealthchecksManager

贡献