library prometheus-client

krenor/prometheus-client

A PHP Client for Prometheus

A Prometheus client library for PHP

Monitor your PHP applications using Prometheus., _(*1)

![Packagist][icon-version] ![icon-php] ![Quality][icon-code-quality] ![License][icon-license], _(*2)

Features

• Support for Counters, Gauges, Histograms, Summaries and custom metrics
• Various storage repositories
• Easy usage in style of Laravels Eloquent ORM
• Initialization of Metrics without labels
• Support of float values
• Push Gateway
• State exporters (for fpm_get_status() or opcache_get_status())

Planned features

• PHP 7.4 rewrite
• Laravel integration

Project State

This library is currently under development.

As long as it's not tagged in a >= 1.* version I could commit incompatible changes!, _(*3)

Quickstart

<?php

use Krenor\Prometheus\Metrics\Metric;
use Krenor\Prometheus\Metrics\Counter;
use Krenor\Prometheus\CollectorRegistry;
use Krenor\Prometheus\Renderer\TextRenderer;
use Krenor\Prometheus\Storage\StorageManager;
use Krenor\Prometheus\Storage\Repositories\InMemoryRepository;
use Krenor\Prometheus\Tests\Stubs\MultipleLabelsCounterStub as ExampleCounter;

Metric::storeUsing(new StorageManager(new InMemoryRepository));

$registry = new CollectorRegistry;

/** @var Counter $counter */
$counter = $registry->register(new ExampleCounter);

$counter->increment(['some', 'label', 'values']);
$counter->incrementBy(3, ['foo', 'bar', 'baz']);

$samples = $registry->collect();
$metrics = (new TextRenderer)->render($samples);

A more detailed documentation can be found here., _(*4)

Note: Since this project is in the works, some parts may lack documentation.
You can orient yourself on the tests if something's unclear., _(*5)

Contributing

Please see CONTRIBUTING for more information., _(*6)

Licence

The MIT License. Please see LICENSE for more information., _(*7)