PHPackages                             aranyasen/laravel-prometheus-exporter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. aranyasen/laravel-prometheus-exporter

ActiveLibrary[Logging & Monitoring](/categories/logging)

aranyasen/laravel-prometheus-exporter
=====================================

A prometheus exporter for Laravel

v2.0.1(1y ago)011.6k—10%MITPHPPHP >=8.1

Since Oct 14Pushed 1y ago1 watchersCompare

[ Source](https://github.com/senaranya/laravel-prometheus-exporter)[ Packagist](https://packagist.org/packages/aranyasen/laravel-prometheus-exporter)[ RSS](/packages/aranyasen-laravel-prometheus-exporter/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (7)Dependencies (5)Versions (8)Used By (0)

laravel-prometheus-exporter
===========================

[](#laravel-prometheus-exporter)

A prometheus exporter for Laravel.

[![Build Status](https://camo.githubusercontent.com/8b0258989bb5e8ac4a6271bf1b12ea7362d492fcae2f10f320d3e3516092c83c/68747470733a2f2f7472617669732d63692e6f72672f73656e6172616e79612f6c61726176656c2d70726f6d6574686575732d6578706f727465722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/senaranya/laravel-prometheus-exporter)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Packagist Version](https://camo.githubusercontent.com/c5f4cbb7c4e25c1a764df7a0e481bd8c849d8ab21742ea72c8ebf860025ccfff/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6172616e796173656e2f6c61726176656c2d70726f6d6574686575732d6578706f727465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/aranyasen/laravel-prometheus-exporter)[![Total Downloads](https://camo.githubusercontent.com/26f33785792f3ed658cab23318625e2bfb8f38229008917ca8f9d15c2afbd449/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6172616e796173656e2f6c61726176656c2d70726f6d6574686575732d6578706f727465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/aranyasen/laravel-prometheus-exporter)[![Author](https://camo.githubusercontent.com/3d30f1e20fa2b7f26547410a2bbea4bb9ae9448dea9d5914f7c8fd225c552af7/687474703a2f2f696d672e736869656c64732e696f2f62616467652f617574686f722d4073656e6172616e79612d626c75652e7376673f7374796c653d666c61742d737175617265)](https://twitter.com/senaranya)

Installation
------------

[](#installation)

```
composer require aranyasen/laravel-prometheus-exporter
```

Register the service provider in app.php

```
'providers' => [
    // ...
    Aranyasen\LaravelPrometheusExporter\PrometheusServiceProvider::class,
]
```

Register the facade in app.php

```
'aliases' => [
    // ...
    'Prometheus' => Aranyasen\LaravelPrometheusExporter\PrometheusFacade::class,
]
```

Configuration
-------------

[](#configuration)

The package has a default configuration which uses the following environment variables.

```
PROMETHEUS_NAMESPACE=app

PROMETHEUS_METRICS_ROUTE_ENABLED=true
PROMETHEUS_METRICS_ROUTE_PATH=metrics
PROMETHEUS_METRICS_ROUTE_MIDDLEWARE=null

PROMETHEUS_STORAGE_ADAPTER=redis

REDIS_HOST=localhost
REDIS_PORT=6379
PROMETHEUS_REDIS_PREFIX=PROMETHEUS_

```

To customize the configuration file, publish the package configuration using Artisan.

```
php artisan vendor:publish --provider="Aranyasen\LaravelPrometheusExporter\PrometheusServiceProvider"
```

You can then edit the generated config at `app/config/prometheus.php`.

### Storage Adapters

[](#storage-adapters)

The storage adapter is used to persist metrics across requests.

The `PROMETHEUS_STORAGE_ADAPTER` env var is used to specify the storage adapter.

The `memory` adapter lets data persist only across the current request. For production, `redis` or `apc` are recommended.

If `redis` is used, the `REDIS_HOST` and `REDIS_PORT` vars also need to be configured.

### Exporting Metrics

[](#exporting-metrics)

The package adds a `/metrics` end-point, enabled by default, which exposes all metrics gathered by collectors.

This can be turned on/off using the `PROMETHEUS_METRICS_ROUTE_ENABLED` var, and can also be changed using the `PROMETHEUS_METRICS_ROUTE_PATH` var.

If you would like to protect this end-point, you can write any custom middleware and enable it using `PROMETHEUS_METRICS_ROUTE_MIDDLEWARE`. Multiple middleware can be supplied as comma-separated values, e.g. `PROMETHEUS_METRICS_ROUTE_MIDDLEWARE=auth.basic,superadmin`

### Collectors

[](#collectors)

A collector is a class, implementing the [CollectorInterface](src/CollectorInterface.php), which is responsible for collecting data for one or many metrics.

Please see the [ExampleCollector](src/ExampleCollector.php) included in this repository.

You can auto-load your collectors by adding them to the `collectors` array in the prometheus.php config.

Usage
-----

[](#usage)

```
// retrieve the exporter
$exporter = app(\Aranyasen\LaravelPrometheusExporter::class);
// or
$exporter = app('prometheus');
// or
$exporter = Prometheus::getFacadeRoot();

// register a new collector
$collector = new \My\New\Collector();
$exporter->registerCollector($collector);

// retrieve all collectors
var_dump($exporter->getCollectors());

// retrieve a collector by name
$collector = $exporter->getCollector('user');

// export all metrics
// this is called automatically when the /metrics end-point is hit
var_dump($exporter->export());

// the following methods can be used to create and interact with counters, gauges and histograms directly
// these methods will typically be called by collectors, but can be used to register any custom metrics directly,
// without the need of a collector

// create a counter
$counter = $exporter->registerCounter('search_requests_total', 'The total number of search requests.');
$counter->inc(); // increment by 1
$counter->incBy(2);

// create a counter (with labels)
$counter = $exporter->registerCounter('search_requests_total', 'The total number of search requests.', ['request_type']);
$counter->inc(['GET']); // increment by 1
$counter->incBy(2, ['GET']);

// retrieve a counter
$counter = $exporter->getCounter('search_requests_total');

// create a gauge
$gauge = $exporter->registerGauge('users_online_total', 'The total number of users online.');
$gauge->inc(); // increment by 1
$gauge->incBy(2);
$gauge->dec(); // decrement by 1
$gauge->decBy(2);
$gauge->set(36);

// create a gauge (with labels)
$gauge = $exporter->registerGauge('users_online_total', 'The total number of users online.', ['group']);
$gauge->inc(['staff']); // increment by 1
$gauge->incBy(2, ['staff']);
$gauge->dec(['staff']); // decrement by 1
$gauge->decBy(2, ['staff']);
$gauge->set(36, ['staff']);

// retrieve a gauge
$counter = $exporter->getGauge('users_online_total');

// create a histogram
$histogram = $exporter->registerHistogram(
    'response_time_seconds',
    'The response time of a request.',
    [],
    [0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0]
);
// the buckets must be in asc order
// if buckets aren't specified, the default 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0 buckets will be used
$histogram->observe(5.0);

// create a histogram (with labels)
$histogram = $exporter->registerHistogram(
    'response_time_seconds',
    'The response time of a request.',
    ['request_type'],
    [0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0]
);
// the buckets must be in asc order
// if buckets aren't specified, the default 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0 buckets will be used
$histogram->observe(5.0, ['GET']);

// retrieve a histogram
$counter = $exporter->getHistogram('response_time_seconds');
```

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance32

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~225 days

Recently: every ~336 days

Total

7

Last Release

692d ago

Major Versions

v1.0.4 → v2.0.02023-02-28

PHP version history (2 changes)v1.0.0PHP >=7.4

v2.0.0PHP >=8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/16dd57009f577d06da0eb45b9020ed46e7da99b2e26eda5dde49da9f74e66612?d=identicon)[senaranya](/maintainers/senaranya)

---

Top Contributors

[![senaranya](https://avatars.githubusercontent.com/u/5471894?v=4)](https://github.com/senaranya "senaranya (16 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/aranyasen-laravel-prometheus-exporter/health.svg)

```
[![Health](https://phpackages.com/badges/aranyasen-laravel-prometheus-exporter/health.svg)](https://phpackages.com/packages/aranyasen-laravel-prometheus-exporter)
```

###  Alternatives

[lkaemmerling/laravel-horizon-prometheus-exporter

A small package to gain and export long time information from Laravel & Horizon for Prometheus.

1602.0M](/packages/lkaemmerling-laravel-horizon-prometheus-exporter)[masterro/laravel-mail-viewer

Easily view in browser outgoing emails.

6392.1k](/packages/masterro-laravel-mail-viewer)[arquivei/laravel-prometheus-exporter

A Prometheus exporter for Laravel and Lumen

20807.4k1](/packages/arquivei-laravel-prometheus-exporter)[melihovv/laravel-log-viewer

A Laravel log viewer

1231.5k1](/packages/melihovv-laravel-log-viewer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)