README

这是一个为 Pushprom 提供的 Yii 2 客户端。它在上层提供了 Pushprom PHP 客户端的一个轻量级封装。

安装

您可以通过运行以下命令通过 Composer 安装 Pushprom Yii 2 客户端：

composer require messagebird/pushprom-yii2-client:1.0.0

或者，将以下内容添加到您的 composer.json 文件中：

"require": {
    "messagebird/pushprom-yii2-client": "1.0.0"
}

然后运行以下命令进行安装：

composer update messagebird/pushprom-yii2-client

用法

在您的配置中添加 Pushprom 组件

'pushprom' => [
    'class' => \pushprom\yii2\Component::className(),
    'job' => 'messagebird',
    'url' => 'udp://127.0.0.1:9090'
],

在您的代码中创建和更新指标

$gauge = new \pushprom\Gauge(
    \Yii::$app->pushprom,
    "fish_in_the_sea",
    "The amount of fish in the sea",
    [
        "species" => "Thalassoma noronhanum"
    ]
);
$gauge->set(2000);

辅助工具

该仓库包括常见任务的辅助工具。

例如，我们发现记录 HTTP 响应及其时间是在许多项目中重复的任务。 \Yii::$app->pushprom 包含辅助方法来简化这些操作。您可以使用如下方式使用它们

$config = [
    'components' => [
        'response' => [
            // ...
            'on beforeSend' => function ($event) {
                \Yii::$app->pushprom->logHttpResponse($event->sender->getStatusCode());
                \Yii::$app->pushprom->logResponseTimeMs();
            }
        ]
    ]
];

messagebird / pushprom-yii2-client

维护者

详细信息

README

安装

用法

辅助工具

许可证