Download the PHP package ml65/prometheus_client_php without Composer
On this page you can find all versions of the php package ml65/prometheus_client_php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ml65/prometheus_client_php
More information about ml65/prometheus_client_php
Files in ml65/prometheus_client_php
Package prometheus_client_php
Short Description Prometheus instrumentation library for PHP applications.
License Apache-2.0
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 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:
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:
Using the APC or APCng storage:
(see the README.APCng.md
file for more details)
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 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
Development
Dependencies
- PHP ^7.2 | ^8.0
- PHP Redis extension
- PHP APCu extension
- Composer
- Redis
Start a Redis instance:
Run the tests:
Black box testing
Just start the nginx, fpm & Redis setup with docker-compose:
Pick the adapter you want to 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.
The test can also be run inside a container.
All versions of prometheus_client_php with dependencies
ext-json Version *