promphp / prometheus_client_php
Prometheus instrumentation library for PHP applications.
Installs: 14 107 749
Dependents: 82
Suggesters: 3
Security: 0
Stars: 430
Watchers: 5
Forks: 95
Open Issues: 51
Requires
- php: ^7.2|^8.0
- ext-json: *
Requires (Dev)
- guzzlehttp/guzzle: ^6.3|^7.0
- phpstan/extension-installer: ^1.0
- phpstan/phpstan: ^1.5.4
- phpstan/phpstan-phpunit: ^1.1.0
- phpstan/phpstan-strict-rules: ^1.1.0
- phpunit/phpunit: ^9.4
- squizlabs/php_codesniffer: ^3.6
- symfony/polyfill-apcu: ^1.6
Suggests
- ext-apc: Required if using APCu.
- ext-pdo: Required if using PDO.
- ext-redis: Required if using Redis.
- promphp/prometheus_push_gateway_php: An easy client for using Prometheus PushGateway.
- symfony/polyfill-apcu: Required if you use APCu on PHP8.0+
- dev-main
- v2.11.0
- v2.10.0
- v2.9.0
- v2.8.0
- v2.7.2
- v2.7.1
- v2.7.0
- v2.6.2
- v2.6.1
- v2.6.0
- v2.5.0
- v2.4.0
- v2.3.0
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.1
- v2.1.0
- v2.0.1
- v2.0.0
- v1.0.3
- 1.0.1
- v1.0.0
- v0.9.1
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.0
- v0.5.1
- v0.5.0
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
- v0.3.0
- v0.2.1
- v0.2.0
- v0.1.0
- dev-remove-usage-of-apcu_inc
- dev-test-on-php-8
This package is auto-updated.
Last update: 2024-10-05 08:23:43 UTC
README
This library uses Redis or APCu to do the client side aggregation. If using Redis, we recommend running a local Redis instance next to your PHP workers.
How does it work?
Usually PHP worker processes don't share any state. You can pick from four adapters. Redis, APC, APCng, or an in-memory adapter. While the first needs a separate binary running, the second and third just need the APC extension to be installed. If you don't need persistent metrics between requests (e.g. a long running cron job or script) the in-memory adapter might be suitable to use.
Installation
Add as Composer dependency:
composer require promphp/prometheus_client_php
Usage
A simple counter:
\Prometheus\CollectorRegistry::getDefault() ->getOrRegisterCounter('', 'some_quick_counter', 'just a quick measurement') ->inc();
Write some enhanced metrics:
$registry = \Prometheus\CollectorRegistry::getDefault(); $counter = $registry->getOrRegisterCounter('test', 'some_counter', 'it increases', ['type']); $counter->incBy(3, ['blue']); $gauge = $registry->getOrRegisterGauge('test', 'some_gauge', 'it sets', ['type']); $gauge->set(2.5, ['blue']); $histogram = $registry->getOrRegisterHistogram('test', 'some_histogram', 'it observes', ['type'], [0.1, 1, 2, 3.5, 4, 5, 6, 7, 8, 9]); $histogram->observe(3.5, ['blue']); $summary = $registry->getOrRegisterSummary('test', 'some_summary', 'it observes a sliding window', ['type'], 84600, [0.01, 0.05, 0.5, 0.95, 0.99]); $summary->observe(5, ['blue']);
Manually register and retrieve metrics (these steps are combined in the getOrRegister...
methods):
$registry = \Prometheus\CollectorRegistry::getDefault(); $counterA = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']); $counterA->incBy(3, ['blue']); // once a metric is registered, it can be retrieved using e.g. getCounter: $counterB = $registry->getCounter('test', 'some_counter') $counterB->incBy(2, ['red']);
Expose the metrics:
$registry = \Prometheus\CollectorRegistry::getDefault(); $renderer = new RenderTextFormat(); $result = $renderer->render($registry->getMetricFamilySamples()); header('Content-type: ' . RenderTextFormat::MIME_TYPE); echo $result;
Change the Redis options (the example shows the defaults):
\Prometheus\Storage\Redis::setDefaultOptions( [ 'host' => '127.0.0.1', 'port' => 6379, 'password' => null, 'timeout' => 0.1, // in seconds 'read_timeout' => '10', // in seconds 'persistent_connections' => false ] );
Using the InMemory storage:
$registry = new CollectorRegistry(new InMemory()); $counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']); $counter->incBy(3, ['blue']); $renderer = new RenderTextFormat(); $result = $renderer->render($registry->getMetricFamilySamples());
Using the APC or APCng storage:
$registry = new CollectorRegistry(new APCng()); or $registry = new CollectorRegistry(new APC());
(see the README.APCng.md
file for more details)
Using the PDO storage:
$registry = new CollectorRegistry(new \PDO('mysql:host=localhost;dbname=prometheus', 'username', 'password')); or $registry = new CollectorRegistry(new \PDO('sqlite::memory:'));
Advanced Usage
Advanced Histogram Usage
On passing an empty array for the bucket parameter on instantiation, a set of default buckets will be used instead. Whilst this is a good base for a typical web application, there is named constructor to assist in the generation of exponential / geometric buckets.
Eg:
Histogram::exponentialBuckets(0.05, 1.5, 10);
This will start your buckets with a value of 0.05, grow them by a factor of 1.5 per bucket across a set of 10 buckets.
Also look at the examples.
PushGateway Support
As of Version 2.0.0 this library doesn't support the Prometheus PushGateway anymore because we want to have this package as small als possible. If you need Prometheus PushGateway support, you could use the companion library: https://github.com/PromPHP/prometheus_push_gateway_php
composer require promphp/prometheus_push_gateway_php
Development
Dependencies
- PHP ^7.2 | ^8.0
- PHP Redis extension
- PHP APCu extension
- Composer
- Redis
Start a Redis instance:
docker-compose up redis
Run the tests:
composer install
# when Redis is not listening on localhost:
# export REDIS_HOST=192.168.59.100
./vendor/bin/phpunit
Black box testing
Just start the nginx, fpm & Redis setup with docker-compose:
docker-compose up
Pick the adapter you want to test.
docker-compose run phpunit env ADAPTER=apc vendor/bin/phpunit tests/Test/
docker-compose run phpunit env ADAPTER=apcng vendor/bin/phpunit tests/Test/
docker-compose run phpunit env ADAPTER=redis vendor/bin/phpunit tests/Test/
Performance testing
This currently tests the APC and APCng adapters head-to-head and reports if the APCng adapter is slower for any actions.
phpunit vendor/bin/phpunit tests/Test/ --group Performance
The test can also be run inside a container.
docker-compose up
docker-compose run phpunit vendor/bin/phpunit tests/Test/ --group Performance