Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thephpleague/statsd
A library for working with StatsD
https://github.com/thephpleague/statsd
Last synced: 13 days ago
JSON representation
A library for working with StatsD
- Host: GitHub
- URL: https://github.com/thephpleague/statsd
- Owner: thephpleague
- License: mit
- Created: 2013-06-13T09:56:15.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-07-10T17:49:31.000Z (over 2 years ago)
- Last Synced: 2024-05-17T04:43:54.947Z (6 months ago)
- Language: PHP
- Homepage:
- Size: 165 KB
- Stars: 350
- Watchers: 15
- Forks: 56
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# StatsD PHP Library
[](https://github.com/thephpleague/statsd/actions?query=workflow%3ACI+branch%3Amaster)
[](https://packagist.org/packages/league/statsd)
[](https://packagist.org/packages/league/statsd)
A library for working with StatsD in PHP.
## Install
Via Composer:
```shell
composer require league/statsd
```
To use the Statsd Service Provider, you must register the provider when bootstrapping your Laravel application.
## Usage
### Configuring
```php
$statsd = new League\StatsD\Client();
$statsd->configure([
'host' => '127.0.0.1',
'port' => 8125,
'namespace' => 'example'
]);
```
OR
```php
$statsd1 = StatsD\Client::instance('server1')->configure([...]);
$statsd2 = StatsD\Client::instance('server2')->configure([...]);
```
The StatsD client wait for `ini_get('default_socket_timeout')` seconds when opening the socket by default. To reduce
this timeout, add `'timeout' => ` to your config.
The StatsD client will throw a `ConnectionException` if it is unable to send data to the StatsD server. You may choose
to disable these exceptions and log a PHP warning instead if you wish. To do so, include the following in your config:
```
'throwConnectionExceptions' => false
```
If omitted, this option defaults to `true`.
### Counters
```php
$statsd->increment('web.pageview');
$statsd->decrement('storage.remaining');
$statsd->increment([
'first.metric',
'second.metric'
], 2);
$statsd->increment('web.clicks', 1, 0.5);
```
### Gauges
```php
$statsd->gauge('api.logged_in_users', 123456);
```
### Sets
```php
$userID = 23;
$statsd->set('api.unique_logins', $userID);
```
### Timers
```php
$statsd->timing('api.response_time', 256);
```
```php
$metrics = array('api.response_time' => 256, 'api.memory' => 4096));
$statsd->timings($metrics);
```
## Timing Blocks
```php
$statsd->time('api.dbcall', function () {
// this code execution will be timed and recorded in ms
});
```
## Tags
***Attention!** That functionality support of tags in Datadog format!*
You may configure it for all the metrics sending by the client.
```php
$statsd->configure([
'tags' => ['some_general_tag' => 'value']
]);
```
Or you may send it for a single metric.
```php
$statsd->increment('web.clicks', 1, 1, ['host' => $_SERVER['HTTP_HOST']]);
```
## Framework integration
Although this library will work with any PHP framework, below are a few ways to
integrate it quickly with the most popular ones via included adapters.
### Laravel 4.x
Find the `providers` key in your `app/config/app.php` and register the Statsd Service Provider.
```php
'providers' => [
// ...
'League\StatsD\Laravel\Provider\StatsdServiceProvider',
]
```
Find the `aliases` key in your `app/config/app.php` and add the Statsd Facade Alias.
```php
'aliases' => [
// ...
'Statsd' => 'League\StatsD\Laravel\Facade\StatsdFacade',
]
```
### Laravel 5.x
If you are using Laravel `>=5.5`, statsd uses [package discovery](https://laravel.com/docs/5.5/packages#package-discovery) to automatically register the service provider and facade.
For older versions of Laravel 5, or if you disable package discovery:
Find the `providers` key in your `config/app.php` and register the Statsd Service Provider.
```php
'providers' => [
// ...
League\StatsD\Laravel5\Provider\StatsdServiceProvider::class,
]
```
Find the `aliases` key in your `app/config/app.php` and add the Statsd Facade Alias.
```php
'aliases' => [
// ...
'Statsd' => League\StatsD\Laravel5\Facade\StatsdFacade::class,
]
```
### Lumen
Register the provider in your boostrap app file ```boostrap/app.php```
Add the following line in the "Register Service Providers" section at the bottom of the file.
```php
$app->register(\League\StatsD\Laravel5\Provider\StatsdServiceProvider::class);
```
Copy the config file ```statsd.php``` manually from the directory ```/vendor/league/statsd/config``` to the directory ```/config ``` (you may need to create this directory).
Package Configuration
In your `.env` file, add the configuration:
```php
STATSD_HOST=127.0.0.1
STATSD_PORT=8125
STATSD_NAMESPACE=
```
## Testing
phpunit
## Contributing
Please see [CONTRIBUTING](https://github.com/thephpleague/statsd/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Marc Qualie](https://github.com/marcqualie)
- [All Contributors](https://github.com/thephpleague/statsd/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/thephpleague/statsd/blob/master/LICENSE) for more information.