laravel-prometheus-exporter

A prometheus exporter for the Laravel and the Lumen web framework.

It tracks latency and request counts by request method, route and response code.

Project State

This is unreleased software. I commit backwards incompatible changes without notice. Heck, I don't even have CI setup yet.

Installation

composer require tback/laravel-prometheus-exporter

Adapters

Then choose from two storage adapters: APCu is the default option. Redis can also be used.

APCu

Ensure apcu (apcu-bc for php7) is installed and enabled.

Redis

Ensure php redis is installed and enabled.

By default it looks for a redis server at localhost:6379. The server can be configured in config/prometheus_exporter.php.

Laravel

Register the ServiceProvider

In config/app.php

'providers' => [
    ...
    Tback\PrometheusExporter\LpeServiceProvider::class,
];

Enable the Middleware

In app/Http/Kernel.php

protected $middleware = [
    ...
    \Tback\PrometheusExporter\Middleware\LaravelResponseTimeMiddleware::class,
];

Add an endpoint for the metrics

Route::get('metrics', \Tback\PrometheusExporter\LpeController::class . '@metrics');

Lumen

Register the ServiceProvider

In bootstrap/app.php

$app->register(\Tback\PrometheusExporter\LpeServiceProvider::class);

Enable the Middleware

In bootstrap/app.php

$app->middleware([
    \Tback\PrometheusExporter\Middleware\LumenResponseTimeMiddleware::class
]);

Add an endpoint for the metrics

In bootstrap/app.php

$app->group(['namespace'=> '\Tback\PrometheusExporter'], function() use ($app){
    $app->get('metrics', ['as' => 'metrics', 'uses'=> 'LpeController@metrics']);
});

Configuration

The configuration can be found in config/prometheus_exporter.php.

name	description
adapter	Storage adapter to use: 'apc' or 'redis' default: 'apc'
namespace	name (prefix) to use in prometheus metrics. default: 'default'
namespace_http_server	name (prefix) to use for http latency in prometheus metrics. default: 'http_server'
redis	array of redis parameters. see prometheus_exporter.php for details

Usage

$manager = app('LpeManager');

$manager->incCounter('NAME', 'HELP', 'NAMESPACE', 'LABELS', 'DATA');

$manager->incByCounter('NAME', 'HELP', 'VALUE', 'NAMESPACE', 'LABELS', 'DATA');