kibatic / prometheus-metrics-builder
Library that helps to build prometheus metrics
v1.0.1
2022-11-21 20:19 UTC
Requires
- php: ^8.0.2 || ^7.4.0
Requires (Dev)
- phpstan/phpstan: ^1.9.2
- phpunit/phpunit: ^9.5.11
- squizlabs/php_codesniffer: ^3.7
This package is auto-updated.
Last update: 2024-10-22 00:45:07 UTC
README
This library helps you to build a Prometheus metrics endpoint for your PHP application.
Quick start
Install the library
composer require kibatic/prometheus-metrics-builder
Basic usage
$metricList = new MetricList(); $metricList->addMetric(new Metric('foo', 1)); $metricList->addMetric(new Metric('bar', "NaN")); $metricList->addMetric(new Metric( 'bar', 1.35, [ 'label1' => 'value1', 'label2' => 'value2', ] )); $response = $metricList->getResponseContent(); $metricList->clearMetrics();
The content of the response will be:
foo 1
bar NaN
bar{label1="value1",label2="value2"} 1.35
More advanced usage
attributes
$metric = new Metric( 'my_metric_name', 12, [ 'module' => 'invoice', 'instance' => 'value2', ], new \DateTimeImmutable() )
timestamp with miliseconds
$metric = new Metric( 'foo', 1, [], new \DateTimeImmutable('2020-01-01 00:00:00.012') );
For developpeurs
Run tests
# install all the needed dependencies make composer # run unit tests make test
Roadmap
- no plan for the moment
Versions
2022-11-21 : v1.0.1
- add CI with github actions
2022-11-21 : v1.0.0
- initial version