StatsD PHP Library
A library for working with StatsD in PHP.
Install
Via Composer:
composer require league/statsd
To use the Statsd Service Provider, you must register the provider when bootstrapping your Laravel application.
Usage
Configuring
$statsd = new League\StatsD\Client();
$statsd->configure([
'host' => '127.0.0.1',
'port' => 8125,
'namespace' => 'example'
]);
OR
$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
$statsd->increment('web.pageview');
$statsd->decrement('storage.remaining');
$statsd->increment([
'first.metric',
'second.metric'
], 2);
$statsd->increment('web.clicks', 1, 0.5);
Gauges
$statsd->gauge('api.logged_in_users', 123456);
Sets
$userID = 23;
$statsd->set('api.unique_logins', $userID);
Timers
$statsd->timing('api.response_time', 256);
$metrics = array('api.response_time' => 256, 'api.memory' => 4096));
$statsd->timings($metrics);
Timing Blocks
$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.
$statsd->configure([
'tags' => ['some_general_tag' => 'value']
]);
Or you may send it for a single metric.
$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.
'providers' => [
// ...
'League\StatsD\Laravel\Provider\StatsdServiceProvider',
]
Find the aliases key in your app/config/app.php and add the Statsd Facade Alias.
'aliases' => [
// ...
'Statsd' => 'League\StatsD\Laravel\Facade\StatsdFacade',
]
Laravel 5.x
If you are using Laravel >=5.5, statsd uses 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.
'providers' => [
// ...
League\StatsD\Laravel5\Provider\StatsdServiceProvider::class,
]
Find the aliases key in your app/config/app.php and add the Statsd Facade Alias.
'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.
$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:
STATSD_HOST=127.0.0.1
STATSD_PORT=8125
STATSD_NAMESPACE=
Testing
phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
![Call to undefined method [package]](https://avatars.githubusercontent.com/u/10206110?v=4)
175 Nov 28, 2022
5 Dec 5, 2022
3 Dec 14, 2022
8 Dec 14, 2022
1 Jan 3, 2022
19 Oct 30, 2022
7 Dec 10, 2021
143 Nov 18, 2022
1 Jan 26, 2022
21 Dec 15, 2022
14 Mar 12, 2022
1.4k Dec 26, 2022
2 Oct 7, 2022
11 Jun 2, 2023
6 Jun 11, 2023
474 Dec 31, 2022
464 Dec 28, 2022
5 Aug 15, 2022
7 Aug 21, 2022