README

这是 cronbuzz API 的官方 PHP 客户端。使用此客户端可以轻松管理您的 cronbuzz 监视器或从 cron 作业发送 pings。

安装

此软件包可以使用 composer 安装。

composer require binarybuilds/cronbuzz-php

从 cron 作业发送 pings

使用以下代码自动向 cronbuzz 发送正确的 pings。

\BinaryBuilds\CronBuzzPHP\CronBuzzTask::run('your-monitor-uuid', function (){

    // Add your code here
        
});

上述代码将

• 向 cronbuzz 发送一个 ping，通知 cron 作业已开始执行
• 将您的代码包装在 try catch 块中
• 当您的代码执行完成时发送 ping。
• 如果您的代码执行期间发生任何异常，catch 块将捕获执行，并向 cronbuzz 发送 ping，通知 cron 作业执行失败。它还将包含错误消息。
• 重新抛出异常，因此您可以像通常一样处理异常。

如果上述代码在您的情况下不起作用，或者您更愿意手动发送 pings，请使用以下代码。

$run = new \BinaryBuilds\CronBuzzPHP\Run( 'your-monitor-uuid' );
$run->start();

try{
   
    // Add your code here

    $run->complete();

}catch (\Exception $exception){

    $run->fail( $exception->getMessage() );
    
    // Handle your exceptions here    
}

使用 API

授权

在您对 API 发出任何请求之前，您必须使用您的 API 密钥进行身份验证。

此步骤对于从 cron 作业发送 pings 不是必需的。

在您的代码开头添加以下行。

\BinaryBuilds\CronBuzzPHP\CronBuzzAPI::setTeamKey('your-team-key');
\BinaryBuilds\CronBuzzPHP\CronBuzzAPI::setApiKey('your-api-token');

您可以从 团队设置 页面获取团队密钥，并从 个人资料 页面获取 API 令牌。

监视器

列出监视器

\BinaryBuilds\CronBuzzPHP\Monitor::list();

显示监视器

\BinaryBuilds\CronBuzzPHP\Monitor::get( 'monitor id');

创建监视器

\BinaryBuilds\CronBuzzPHP\Monitor::create(
    'monitor name', 
    'schedule', 
    'max execution', 
    'notification lists', 
    'tags'
);

更新监视器

\BinaryBuilds\CronBuzzPHP\Monitor::update( 'monitor id', 'fields');

删除监视器

\BinaryBuilds\CronBuzzPHP\Monitor::delete( 'monitor id');

暂停监视器

\BinaryBuilds\CronBuzzPHP\Monitor::pause( 'monitor id');

恢复监视器

\BinaryBuilds\CronBuzzPHP\Monitor::resume( 'monitor id');

通知列表

列出通知列表

\BinaryBuilds\CronBuzzPHP\NotificationList::list();

显示通知列表

\BinaryBuilds\CronBuzzPHP\NotificationList::get( 'list id');

创建通知列表

\BinaryBuilds\CronBuzzPHP\NotificationList::create( 'list name', 'channels');

通知通道格式

[
    [ 'type' => 'EMAIL', 'yourname@yourcompany.com'],
    [ 'type' => 'WEBHOOK', 'https://your-webhook-url.com/'],
]

更新通知列表

\BinaryBuilds\CronBuzzPHP\NotificationList::update( 'list id', 'new name');

删除通知列表

\BinaryBuilds\CronBuzzPHP\NotificationList::delete( 'list id');

标签

列出标签

\BinaryBuilds\CronBuzzPHP\Tag::list();

显示标签

\BinaryBuilds\CronBuzzPHP\Tag::get( 'tag id');

创建标签

\BinaryBuilds\CronBuzzPHP\Tag::create( 'tag name');

更新标签

\BinaryBuilds\CronBuzzPHP\Tag::update( 'tag id', 'new name');

删除标签

\BinaryBuilds\CronBuzzPHP\Tag::delete( 'tag id');

安全漏洞

如果您在此软件包中发现了安全漏洞，请不要使用问题跟踪器。相反，请发送电子邮件至 support@cronbuzz.com。所有安全漏洞都将得到及时处理。

许可协议

此软件包是开源软件，受 MIT 许可协议 许可。