Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Jimdo/prometheus_client_php
Prometheus instrumentation library for PHP applications
https://github.com/Jimdo/prometheus_client_php
Last synced: 3 months ago
JSON representation
Prometheus instrumentation library for PHP applications
- Host: GitHub
- URL: https://github.com/Jimdo/prometheus_client_php
- Owner: Jimdo
- License: apache-2.0
- Archived: true
- Created: 2016-06-17T10:48:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-06T21:15:22.000Z (about 5 years ago)
- Last Synced: 2024-05-17T18:45:06.779Z (8 months ago)
- Language: PHP
- Homepage: https://prometheus.io/docs/concepts/metric_types/
- Size: 212 KB
- Stars: 281
- Watchers: 74
- Forks: 214
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kubernetes - 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. (Performance)
README
# :exclamation: New project maintainers :exclamation:
This project is no longer maintained here. Please go to https://github.com/endclothing/prometheus_client_php.
# A prometheus client library written in PHP
[](https://travis-ci.org/Jimdo/prometheus_client_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](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.
## Usage
A simple counter:
```php
\Prometheus\CollectorRegistry::getDefault()
->getOrRegisterCounter('', 'some_quick_counter', 'just a quick measurement')
->inc();
```
Write some enhanced metrics:
```php
$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):
```php
$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:
```php
$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):
```php
\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:
```php
$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());
```
Also look at the [examples](examples).
## Development
### Dependencies
* PHP 5.6
* PHP Redis extension
* 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
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/
```