Download the PHP package caikeal/prometheus_client_php without Composer
On this page you can find all versions of the php package caikeal/prometheus_client_php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download caikeal/prometheus_client_php
More information about caikeal/prometheus_client_php
Files in caikeal/prometheus_client_php
Package prometheus_client_php
Short Description Prometheus instrumentation library for PHP applications.
License MIT
Informations about the package prometheus_client_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 to run 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 three adapters. Redis, APC or an in memory adapter. While the first needs a separate binary running, the second just needs 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:
Usage
A simple counter:
Write some enhanced metrics:
Manually register and retrieve metrics (these steps are combined in the getOrRegister...
methods):
Expose the metrics:
Change the Redis options (the example shows the defaults):
Using the InMemory storage:
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:
This will start your buckets with a value of 1.5, grow them by a factor of 1.5 per bucket across a set of 10 buckets.
Also look at the examples.
Development
Dependencies
- PHP ^7.1
- PHP APCu extension
- Composer
- Redis
Start a Redis instance:
Run the tests:
All versions of prometheus_client_php with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^6.3
illuminate/redis Version ^5.6
symfony/polyfill-apcu Version ^1.6