LaravelPrometheusExporter

KO | EN

gitlite — search

#javascript #python #typescript #golang #machine-learning #deep-learning #linux #macos #java #awesome #cli #kubernetes #mcp #openai

LaravelPrometheusExporter

(★ 26)

A laravel service provider to export metrics for prometheus.

LaravelPrometheusExporter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# LaravelPrometheusExporter

[![Software license][ico-license]](https://raw.githubusercontent.com/triadev/LaravelPrometheusExporter/master/LICENSE)
[![Travis][ico-travis]][link-travis]
[![Coveralls](https://coveralls.io/repos/github/triadev/LaravelPrometheusExporter/badge.svg?branch=master)](https://coveralls.io/github/triadev/LaravelPrometheusExporter?branch=master)
[![CodeCov](https://codecov.io/gh/triadev/LaravelPrometheusExporter/branch/master/graph/badge.svg)](https://codecov.io/gh/triadev/LaravelPrometheusExporter)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/triadev/LaravelPrometheusExporter/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/triadev/LaravelPrometheusExporter/?branch=master)
[![Latest stable][ico-version-stable]][link-packagist]
[![Monthly installs][ico-downloads-monthly]][link-downloads]
[![Total Downloads](https://img.shields.io/packagist/dt/triadev/laravel-prometheus-exporter.svg?style=flat-square)](https://packagist.org/packages/triadev/laravel-prometheus-exporter)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/triadev/LaravelPrometheusExporter.svg)](http://isitmaintained.com/project/triadev/LaravelPrometheusExporter "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/triadev/LaravelPrometheusExporter.svg)](http://isitmaintained.com/project/triadev/LaravelPrometheusExporter "Percentage of issues still open")

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

## Supported laravel versions
[![Laravel 5.6][icon-l56]][link-laravel]
[![Laravel 5.7][icon-l57]][link-laravel]
[![Laravel 5.8][icon-l58]][link-laravel]
[![Laravel 6.0][icon-l60]][link-laravel]

## Supported lumen versions
[![Lumen 5.6][icon-lumen56]][link-lumen]
[![Lumen 5.7][icon-lumen57]][link-lumen]
[![Lumen 5.8][icon-lumen58]][link-lumen]
[![Lumen 6.0][icon-lumen60]][link-lumen]

## Main features
- Metrics with APC
- Metrics with Redis
- Metrics with InMemory
- Metrics with the push gateway
- Request per route middleware (total and duration metrics)

## Installation

### Composer
> composer require triadev/laravel-prometheus-exporter

### Application

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
php artisan vendor:publish --provider="Triadev\PrometheusExporter\Provider\PrometheusExporterServiceProvider" --tag="config"
```

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

## Configuration
| Key        | Env | Value           | Description  | Default |
|:-------------:|:-------------:|:-------------:|:-----:|:-----:|
| adapter | PROMETHEUS_ADAPTER | STRING | apc, redis, inmemory or push | apc |
| namespace | --- | STRING | default: app | app |
| namespace_http | --- | STRING | namespace for "RequestPerRoute-Middleware metrics" | http |
| redis.host | PROMETHEUS_REDIS_HOST, REDIS_HOST | STRING | redis host | 127.0.0.1
| redis.port | PROMETHEUS_REDIS_PORT, REDIS_PORT | INTEGER | redis port | 6379 |
| redis.password | PROMETHEUS_REDIS_PASSWORD, REDIS_PASSWORD | STRING | redis password | null |
| redis.timeout | --- | FLOAT | redis timeout | 0.1 |
| redis.read_timeout | --- | INTEGER | redis read timeout | 10 |
| push_gateway.address | PROMETHEUS_PUSH_GATEWAY_ADDRESS | STRING | push gateway address | localhost:9091 |
| buckets_per_route | --- | STRING | histogram buckets for "RequestPerRoute-Middleware" | --- |

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

## Usage

### Get metrics

#### Laravel
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'
);
```

#### Lumen
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'
);
```

### Middleware

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

##### Alias
>lpe.requestPerRoute

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

##### Example
```php
$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

## Roadmap
- histogram buckets per route (RequestPerRoute)

## Reporting Issues
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. :)

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

## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits
- [Christopher Lorke][link-author]
- [All Contributors][link-contributors]

## Other

### Project related links
- [Wiki](https://github.com/triadev/LaravelPrometheusExporter/wiki)
- [Issue tracker](https://github.com/triadev/LaravelPrometheusExporter/issues)

### Author
- [Christopher Lorke](mailto:christopher.lorke@gmx.de)

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

[ico-license]: https://img.shields.io/github/license/triadev/LaravelPrometheusExporter.svg?style=flat-square
[ico-version-stable]: https://img.shields.io/packagist/v/triadev/laravel-prometheus-exporter.svg?style=flat-square
[ico-downloads-monthly]: https://img.shields.io/packagist/dm/triadev/laravel-prometheus-exporter.svg?style=flat-square
[ico-travis]: https://travis-ci.org/triadev/LaravelPrometheusExporter.svg?branch=master

[link-packagist]: https://packagist.org/packages/triadev/laravel-prometheus-exporter
[link-downloads]: https://packagist.org/packages/triadev/laravel-prometheus-exporter/stats
[link-travis]: https://travis-ci.org/triadev/LaravelPrometheusExporter
[link-scrutinizer]: https://scrutinizer-ci.com/g/triadev/LaravelPrometheusExporter/badges/quality-score.png?b=master

[icon-l56]: https://img.shields.io/badge/Laravel-5.6-brightgreen.svg?style=flat-square
[icon-l57]: https://img.shields.io/badge/Laravel-5.7-brightgreen.svg?style=flat-square
[icon-l58]: https://img.shields.io/badge/Laravel-5.8-brightgreen.svg?style=flat-square
[icon-l60]: https://img.shields.io/badge/Laravel-6.0-brightgreen.svg?style=flat-square

[icon-lumen56]: https://img.shields.io/badge/Lumen-5.6-brightgreen.svg?style=flat-square
[icon-lumen57]: https://img.shields.io/badge/Lumen-5.7-brightgreen.svg?style=flat-square
[icon-lumen58]: https://img.shields.io/badge/Lumen-5.8-brightgreen.svg?style=flat-square
[icon-lumen60]: https://img.shields.io/badge/Lumen-6.0-brightgreen.svg?style=flat-square

[link-laravel]: https://laravel.com
[link-lumen]: https://lumen.laravel.com
[link-author]: https://github.com/triadev
[link-contributors]: ../../contributors

LaravelPrometheusExporter

LaravelPrometheusExporter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

LaravelPrometheusExporter

LaravelPrometheusExporter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README