PHPackages pfinal/prometheus-php-client - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Logging & Monitoring](/categories/logging) 4. / 5. pfinal/prometheus-php-client ActiveLibrary[Logging & Monitoring](/categories/logging) pfinal/prometheus-php-client ============================ Prometheus instrumentation library for PHP applications. v1.0.1(4y ago)04[1 PRs](https://github.com/pfinal/prometheus-php-client/pulls)Apache-2.0PHPPHP ^7.0|^8.0 Since Aug 1Pushed 1y ago1 watchersCompare [ Source](https://github.com/pfinal/prometheus-php-client)[ Packagist](https://packagist.org/packages/pfinal/prometheus-php-client)[ RSS](/packages/pfinal-prometheus-php-client/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (2)Versions (4)Used By (0) A prometheus client library written in PHP ========================================== [](#a-prometheus-client-library-written-in-php) 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? ----------------- [](#how-does-it-work) Usually PHP worker processes don't share any state. You can pick from three adapters. Redis, APC or an in memory adapter. While the first needs a separate binary running, the second just needs the [APC](https://pecl.php.net/package/APCU) 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 ------------ [](#installation) Add as [Composer](https://getcomposer.org/) dependency: ``` composer require pfinal/prometheus-php-client ``` Usage ----- [](#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']); ``` 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()); ``` ### Advanced Usage [](#advanced-usage) #### Advanced Histogram 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](examples). #### PushGateway Support [](#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](https://github.com/PromPHP/prometheus_push_gateway_php) ``` composer require promphp/prometheus_push_gateway_php ``` Development ----------- [](#development) ### Dependencies [](#dependencies) - PHP ^7.0 - PHP APCu extension - [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) - 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 ----------------- [](#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=redis vendor/bin/phpunit tests/Test/ ``` ### Health Score 28 — LowBetter than 54% of packages Maintenance27 Infrequent updates — may be unmaintained Popularity3 Limited adoption so far Community19 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 1750d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/17738136?v=4)[zouyiliang](/maintainers/pfinal)[@pfinal](https://github.com/pfinal) --- Top Contributors [![schnipseljagd](https://avatars.githubusercontent.com/u/289073?v=4)](https://github.com/schnipseljagd "schnipseljagd (110 commits)")[![bracki](https://avatars.githubusercontent.com/u/49786?v=4)](https://github.com/bracki "bracki (98 commits)")[![LKaemmerling](https://avatars.githubusercontent.com/u/4281581?v=4)](https://github.com/LKaemmerling "LKaemmerling (41 commits)")[![NoelDavies](https://avatars.githubusercontent.com/u/572911?v=4)](https://github.com/NoelDavies "NoelDavies (14 commits)")[![rdohms](https://avatars.githubusercontent.com/u/94331?v=4)](https://github.com/rdohms "rdohms (10 commits)")[![martinssipenko](https://avatars.githubusercontent.com/u/598744?v=4)](https://github.com/martinssipenko "martinssipenko (6 commits)")[![buffcode](https://avatars.githubusercontent.com/u/2863518?v=4)](https://github.com/buffcode "buffcode (3 commits)")[![mps-sepetrov](https://avatars.githubusercontent.com/u/24416480?v=4)](https://github.com/mps-sepetrov "mps-sepetrov (3 commits)")[![encero](https://avatars.githubusercontent.com/u/1345022?v=4)](https://github.com/encero "encero (3 commits)")[![carusogabriel](https://avatars.githubusercontent.com/u/16328050?v=4)](https://github.com/carusogabriel "carusogabriel (2 commits)")[![DeyV](https://avatars.githubusercontent.com/u/311626?v=4)](https://github.com/DeyV "DeyV (2 commits)")[![nussjustin-hmmh](https://avatars.githubusercontent.com/u/27724351?v=4)](https://github.com/nussjustin-hmmh "nussjustin-hmmh (1 commits)")[![oraoto](https://avatars.githubusercontent.com/u/24709398?v=4)](https://github.com/oraoto "oraoto (1 commits)")[![seiffert](https://avatars.githubusercontent.com/u/1111118?v=4)](https://github.com/seiffert "seiffert (1 commits)")[![1player](https://avatars.githubusercontent.com/u/690120?v=4)](https://github.com/1player "1player (1 commits)")[![simPod](https://avatars.githubusercontent.com/u/327717?v=4)](https://github.com/simPod "simPod (1 commits)")[![bvisness](https://avatars.githubusercontent.com/u/4707402?v=4)](https://github.com/bvisness "bvisness (1 commits)")[![crazycodr](https://avatars.githubusercontent.com/u/4398521?v=4)](https://github.com/crazycodr "crazycodr (1 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (1 commits)")[![fbhdk](https://avatars.githubusercontent.com/u/10439895?v=4)](https://github.com/fbhdk "fbhdk (1 commits)") ### Embed Badge ![Health badge](/badges/pfinal-prometheus-php-client/health.svg) ``` [![Health](https://phpackages.com/badges/pfinal-prometheus-php-client/health.svg)](https://phpackages.com/packages/pfinal-prometheus-php-client) ``` ### Alternatives [betterde/logger Elasticsearch logger handler 3230.4k](/packages/betterde-logger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)