PHPackages                             nepda/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. nepda/laravel-prometheus-exporter

ActiveLibrary

nepda/laravel-prometheus-exporter
=================================

A prometheus exporter for Laravel

v5.0.0(3y ago)122MITPHPPHP ^8.1

Since Jul 27Pushed 3y agoCompare

[ Source](https://github.com/landinsicht/laravel-prometheus-exporter)[ Packagist](https://packagist.org/packages/nepda/laravel-prometheus-exporter)[ RSS](/packages/nepda-laravel-prometheus-exporter/feed)WikiDiscussions main Synced yesterday

READMEChangelog (3)Dependencies (5)Versions (13)Used By (0)

A prometheus exporter for Laravel
=================================

[](#a-prometheus-exporter-for-laravel)

[![Build Status](https://camo.githubusercontent.com/3183206e0afb6ea6e7e8880187e6e1c0e1b61c16bcd589a2f54da64d9332f87f/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6c616e64696e73696368742f6c61726176656c2d70726f6d6574686575732d6578706f727465722f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/landinsicht/laravel-prometheus-exporter)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Packagist Version](https://camo.githubusercontent.com/0e1dcfd24e24c08168753fec62476e5d0c06df814edfd93325eec051f056c59f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f746f7562697a2f6c61726176656c2d70726f6d6574686575732d6578706f727465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/toubiz/laravel-prometheus-exporter)[![Total Downloads](https://camo.githubusercontent.com/888004d2a5d971cdf745aecfcb175802bf4c19bc626c9d4713f9d39074b94f1d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f746f7562697a2f6c61726176656c2d70726f6d6574686575732d6578706f727465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/toubiz/laravel-prometheus-exporter)

This package is a wrapper bridging [promphp/prometheus\_client\_php](https://github.com/promphp/prometheus_client_php) into Laravel.

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

[](#installation)

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

Register the service provider in app.php

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

Register the facade in app.php

```
'aliases' => [
    // ...
    'Prometheus' => Superbalist\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=memory

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="Superbalist\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 `memory` adapter is enabled by default, meaning data will only be persisted across the current request. We recommend using the `redis` or `apc` adapter in production environments.

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

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`.

### 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(\Superbalist\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

33

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity79

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~199 days

Recently: every ~207 days

Total

10

Last Release

1420d ago

Major Versions

1.0.5 → v2.0.02020-11-09

v2.0.0 → 3.0.02020-12-03

3.0.0 → 4.0.02021-01-13

4.0.0 → v5.0.02022-06-22

PHP version history (4 changes)1.0.0PHP &gt;=5.6.0

v2.0.0PHP &gt;=7.3

4.0.0PHP ^7.3|^8.0

v5.0.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/791aed3afcdbc490d6c78359811a940abfafa7d36c1e765d801953eae403416e?d=identicon)[nepda](/maintainers/nepda)

---

Top Contributors

[![matthewgoslett](https://avatars.githubusercontent.com/u/1571743?v=4)](https://github.com/matthewgoslett "matthewgoslett (14 commits)")[![nepda](https://avatars.githubusercontent.com/u/531753?v=4)](https://github.com/nepda "nepda (11 commits)")[![nicja](https://avatars.githubusercontent.com/u/2102143?v=4)](https://github.com/nicja "nicja (5 commits)")[![stefanbauer](https://avatars.githubusercontent.com/u/3192662?v=4)](https://github.com/stefanbauer "stefanbauer (1 commits)")[![janwehner](https://avatars.githubusercontent.com/u/1687426?v=4)](https://github.com/janwehner "janwehner (1 commits)")[![zoidyzoidzoid](https://avatars.githubusercontent.com/u/2572493?v=4)](https://github.com/zoidyzoidzoid "zoidyzoidzoid (1 commits)")[![lucacri](https://avatars.githubusercontent.com/u/2913531?v=4)](https://github.com/lucacri "lucacri (1 commits)")[![nope7777](https://avatars.githubusercontent.com/u/8977306?v=4)](https://github.com/nope7777 "nope7777 (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[barryvdh/laravel-debugbar

PHP Debugbar integration for Laravel

19.1k124.3M624](/packages/barryvdh-laravel-debugbar)[spatie/laravel-prometheus

Export Laravel metrics to Prometheus

2651.3M6](/packages/spatie-laravel-prometheus)[api-platform/laravel

API Platform support for Laravel

59126.4k6](/packages/api-platform-laravel)[bjuppa/laravel-blog

Add blog functionality to your Laravel project

483.3k2](/packages/bjuppa-laravel-blog)

PHPackages © 2026

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