traum-ferienwohnungen/laravel-prometheus-exporter

A prometheus exporter for Laravel & Lumen

0.2.1 2020-09-08 06:27 UTC

Requires

• php: ^7.4
• endclothing/prometheus_client_php: ^1
• fzaninotto/faker: ~1.7
• illuminate/support: ^6

Requires (Dev)

• illuminate/http: ^6
• mockery/mockery: ^1.1
• orchestra/testbench: ^4
• phpunit/phpunit: ^9

MIT

• Till Backhaus

• laravel
• lumen
• prometheus

README

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.

Installation

composer require traum-ferienwohnungen/laravel-prometheus-exporter

Adapters

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

APCu

Ensure apcu-bc 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

Enable the Middleware

In app/Http/Kernel.php

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

Add an endpoint for the metrics

Route::get('metrics', \traumferienwohnungen\PrometheusExporter\LaravelController::class . '@metrics');

Lumen

Register the ServiceProvider

In bootstrap/app.php

$app->register(traumferienwohnungen\PrometheusExporter\LumenServiceProvider::class);

Add an endpoint for the metrics

In bootstrap/app.php

$app->router->get('metrics', ['as' => 'metrics', 'uses'=> 'traumferienwohnungen\PrometheusExporter\LumenController@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