messagebird / pushprom-yii2-client
A Yii 2 client for Pushprom
Installs: 66 236
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 13
Forks: 4
Open Issues: 1
Type:yii2-extension
Requires
- ext-bcmath: *
- messagebird/pushprom-php-client: ^1.0.1
- yiisoft/yii2: ~2.0.4
This package is auto-updated.
Last update: 2024-10-15 16:57:23 UTC
README
This is a Yii 2 client for for Pushprom. It provides a thin layer on top of the Pushprom PHP Client.
Installing
You can install the Pushprom Yii 2 client through Composer by running:
composer require messagebird/pushprom-yii2-client:1.0.0
Alternatively, add this to your composer.json
:
"require": { "messagebird/pushprom-yii2-client": "1.0.0" }
And then install by running:
composer update messagebird/pushprom-yii2-client
Usage
In your configuration add the Pushprom component:
'pushprom' => [ 'class' => \pushprom\yii2\Component::className(), 'job' => 'messagebird', 'url' => 'udp://127.0.0.1:9090' ],
Create and update metrics in your code:
$gauge = new \pushprom\Gauge( \Yii::$app->pushprom, "fish_in_the_sea", "The amount of fish in the sea", [ "species" => "Thalassoma noronhanum" ] ); $gauge->set(2000);
Helpers
The repository includes helpers for common tasks.
For example, we've found that logging HTTP responses and their time is something that is repeated amongst projects. \Yii::$app->pushprom
contains helper methods to make it easier to stat them. You can use them like this:
$config = [ 'components' => [ 'response' => [ // ... 'on beforeSend' => function ($event) { \Yii::$app->pushprom->logHttpResponse($event->sender->getStatusCode()); \Yii::$app->pushprom->logResponseTimeMs(); } ] ] ];
License
The Yii 2 client for Pushprom is licensed under The BSD 2-Clause License. Copyright (c) 2016, MessageBird