A laravel and lumen service provider to export metrics for prometheus.

• Metrics with APC
• Metrics with Redis
• Metrics with InMemory
• Metrics with the push gateway
• Request per route middleware (total and duration metrics)

composer require triadev/laravel-prometheus-exporter

The package is registered through the package discovery of laravel and Composer.

https://laravel.com/docs/5.8/packages

Once installed you can now publish your config file and set your correct configuration for using the package.

php artisan vendor:publish --provider="Triadev\PrometheusExporter\Provider\PrometheusExporterServiceProvider" --tag="config"

This will create a file config/prometheus-exporter.php.

'buckets_per_route' => [
    ROUTE-NAME => [10,20,50,100,200],
    ...
]

When you are using laravel you can use the default http endpoint:

triadev/pe/metrics

Of course you can also register your own route. Here is an example:

Route::get(
    ROUTE,
    \Triadev\PrometheusExporter\Controller\LaravelController::class . '@metrics'
);

When you are using lumen you must register the route on your own. Here is an example:

Route::get(
    ROUTE,
    \Triadev\PrometheusExporter\Controller\LumenController::class . '@metrics'
);

A middleware to build metrics for "request_total" and "requests_latency_milliseconds" per route.

lpe.requestPerRoute

1. requests_total (inc)
2. requests_latency_milliseconds (histogram)

$router->get('/test/route', function () {
    return 'valid';
})->middleware('lpe.requestPerRoute');

app_requests_latency_milliseconds_bucket{route="/test/route",method="GET",status_code="200",le="0.005"} 0 ... app_requests_latency_milliseconds_count{route="/test/route",method="GET",status_code="200"} 1 app_requests_latency_milliseconds_sum{route="/test/route",method="GET",status_code="200"} 6 app_requests_total{route="/test/route",method="GET",status_code="200"} 1

• histogram buckets per route (RequestPerRoute)

If you do find an issue, please feel free to report it with GitHub's bug tracker for this project.

Alternatively, fork the project and make a pull request. :)

1. docker-compose up
2. docker exec fpm ./vendor/phpunit/phpunit/phpunit

Please see CONTRIBUTING for details.

• Christopher Lorke
• All Contributors

• Wiki
• Issue tracker

• Christopher Lorke

The code for LaravelPrometheusExporter is distributed under the terms of the MIT license (see LICENSE).