Laravel Horizon Prometheus Exporter

https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter
Admin
A Laravel package that exports Laravel Horizon metrics to Prometheus for monitoring and...
Tokens:32,626
Snippets:263
Trust Score:9.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/README.md

Install the package using Composer.

```bash
composer require lkaemmerling/laravel-horizon-prometheus-exporter
```

--------------------------------

### Scrape output example

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-horizon-status.md

Example Prometheus text format output for the gauge with default namespace 'app'.

```text
# HELP app_horizon_status The status of Horizon, -1 = inactive, 0 = paused, 1 = running
# TYPE app_horizon_status gauge
app_horizon_status 1
```

--------------------------------

### Scrape output for app_horizon_jobs_per_minute

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

Example Prometheus text exposition format showing the gauge metric with help text and a sample value.

```text
# HELP app_horizon_jobs_per_minute The number of jobs per minute
# TYPE app_horizon_jobs_per_minute gauge
app_horizon_jobs_per_minute 42
```

--------------------------------

### metrics() method implementation

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/controller.md

Handles GET requests to the configured URL, runs the exporter pipeline, renders metrics, optionally wipes storage, and returns a response with the Prometheus exposition format.

```php
public function metrics()
{
    ExporterRepository::load();
    $renderer = new RenderTextFormat();
    $result = $renderer->render(ExporterRepository::getRegistry()->getMetricFamilySamples());

    if(config('horizon-exporter.wipe_storage_after_render', false)) {
        ExporterRepository::getRegistry()->wipeStorage();
    }

    return new Response($result, Response::HTTP_OK, ["Content-Type" => RenderTextFormat::MIME_TYPE]);
}
```

--------------------------------

### Scrape output example

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-recent-jobs.md

Example Prometheus text format output for the gauge with default namespace 'app'.

```text
# HELP app_horizon_recent_jobs The number of recent jobs
# TYPE app_horizon_recent_jobs gauge
app_horizon_recent_jobs 128
```

--------------------------------

### Scrape output with default namespace

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-mastersupervisors.md

Example Prometheus text format output for the gauge when the namespace is 'app'.

```text
# HELP app_horizon_current_mastersupervisors Number of mastersupervisors
# TYPE app_horizon_current_mastersupervisors gauge
app_horizon_current_mastersupervisors 2
```

--------------------------------

### Scrape output for app_horizon_current_workload

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

Default scrape of GET /metrics with namespace 'app' returns one series per queue, labeled with the queue name and value as the queue's workload.

```text
# HELP app_horizon_current_workload Current workload of all queues
# TYPE app_horizon_current_workload gauge
app_horizon_current_workload{queue="default"} 5
app_horizon_current_workload{queue="emails"} 12
app_horizon_current_workload{queue="high"} 0
```

--------------------------------

### Scrape output for app_horizon_failed_jobs

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-failed-jobs-per-hour.md

Example Prometheus text exposition format showing the gauge with value 3.

```text
# HELP app_horizon_failed_jobs The number of recently failed jobs
# TYPE app_horizon_failed_jobs gauge
app_horizon_failed_jobs 3
```

--------------------------------

### Scrape output for app_horizon_current_processes

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-processes-per-queue.md

Default namespace `app`; a scrape of `GET /metrics` yields one labeled series per queue. The label set is fixed to `queue` by the source.

```text
# HELP app_horizon_current_processes Current processes of all queues
# TYPE app_horizon_current_processes gauge
app_horizon_current_processes{queue="default"} 3
app_horizon_current_processes{queue="emails"} 2
app_horizon_current_processes{queue="high"} 1
```

--------------------------------

### Configure IP whitelist in config/horizon-exporter.php

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Sets the 'ip_whitelist' array in the config file to allow requests from specific IPs or CIDR ranges. With this configuration, GET /metrics from 127.0.0.1 and any 10.0.x.x address succeeds; any other source receives HTTP 403.

```php
// config/horizon-exporter.php
'ip_whitelist' => [
    '127.0.0.1',
    '10.0.0.0/24',
],
```

--------------------------------

### GET metrics()

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/controller.md

Handles the GET request to the configured Prometheus scrape endpoint. It runs the exporter pipeline, renders all metric families into Prometheus text exposition format, optionally wipes storage, and returns the response with the correct content type.

```APIDOC
## [GET] <config('horizon-exporter.url')>

### Description
Handles the GET request to the configured Prometheus scrape endpoint. It runs the exporter pipeline, renders all metric families into Prometheus text exposition format, optionally wipes storage, and returns the response with the correct content type.

### Method
GET

### Endpoint
<config('horizon-exporter.url')>

### Parameters
No parameters.

### Response
#### Success Response (200)
- **Body**: Rendered Prometheus text exposition format of all metric family samples currently in the registry.
- **Content-Type**: `text/plain; version=0.0.4; charset=utf-8`

#### Response Example
```
# HELP metric_name Metric description
# TYPE metric_name counter
metric_name 1
```
```

--------------------------------

### Custom route mounting the same handler

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/controller.md

Defines a GET route at '/prometheus/metrics' that uses the controller's metrics method, protected by the 'auth.basic' middleware.

```php
use Illuminate\Support\Facades\Route;
use LKDevelopment\HorizonPrometheusExporter\Http\Controller\HorizonPrometheusExporterController;

Route::get('/prometheus/metrics', HorizonPrometheusExporterController::class . '@metrics')
    ->middleware('auth.basic');
```

--------------------------------

### Sample Prometheus metrics response body

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/endpoints.md

Example response body in Prometheus text exposition format with default namespace 'app'. Shows gauge metrics for mastersupervisors, jobs per minute, status, and workload with queue labels.

```text
# HELP app_horizon_current_mastersupervisors Number of mastersupervisors
# TYPE app_horizon_current_mastersupervisors gauge
app_horizon_current_mastersupervisors 2
# HELP app_horizon_jobs_per_minute The number of jobs per minute
# TYPE app_horizon_jobs_per_minute gauge
app_horizon_jobs_per_minute 42
# HELP app_horizon_status The status of Horizon, -1 = inactive, 0 = paused, 1 = running
# TYPE app_horizon_status gauge
app_horizon_status 1
# HELP app_horizon_current_workload Current workload of all queues
# TYPE app_horizon_current_workload gauge
app_horizon_current_workload{queue="default"} 5
app_horizon_current_workload{queue="emails"} 12
```

--------------------------------

### Direct invocation of HorizonPrometheusExporterController::metrics()

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/controller.md

Instantiates the controller and calls metrics() to get a Prometheus exposition response. The response status is 200, Content-Type is 'text/plain; version=0.0.4; charset=utf-8', and the body contains exposition text like '# HELP app_horizon_status ...'.

```php
use LKDevelopment\HorizonPrometheusExporter\Http\Controller\HorizonPrometheusExporterController;

$controller = new HorizonPrometheusExporterController();
$response = $controller->metrics();

echo $response->getStatusCode();        // 200
echo $response->headers->get('Content-Type'); // text/plain; version=0.0.4; charset=utf-8
echo $response->getContent();          // exposition text like "# HELP app_horizon_status ..."
```

--------------------------------

### Prometheus scrape_configs YAML for laravel-horizon job

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/endpoints.md

Example Prometheus scrape configuration targeting the Laravel Horizon exporter metrics endpoint. The metrics_path must match config('horizon-exporter.url') if changed; the default target is 'app:80'.

```yaml
scrape_configs:
  - job_name: 'laravel-horizon'
    metrics_path: /metrics          # must match config('horizon-exporter.url') if changed
    static_configs:
      - targets: ['app:80']
```

--------------------------------

### GET /metrics

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/endpoints.md

The Prometheus scrape endpoint that returns all registered Horizon metrics in the Prometheus text exposition format. It is the only HTTP endpoint exposed by the package and is subject to the configured middleware.

```APIDOC
## [GET] /metrics

### Description
The Prometheus scrape endpoint that returns all registered Horizon metrics in the Prometheus text exposition format. It is the only HTTP endpoint exposed by the package and is subject to the configured middleware.

### Method
GET

### Endpoint
`/metrics` (default; path is configurable via `config('horizon-exporter.url')`)

### Parameters
#### Query Parameters
None read by the handler; the controller takes no request argument.

#### Request Body
None (GET).

#### Headers
None required.

### Request Example
No request body or query parameters are required.

### Response
#### Success Response (200)
- **Status**: `Response::HTTP_OK` (200)
- **Content-Type**: `text/plain; version=0.0.4; charset=utf-8` (from `RenderTextFormat::MIME_TYPE`)
- **Body**: Prometheus text exposition format of `ExporterRepository::getRegistry()->getMetricFamilySamples()`

#### Response Example
```text
# HELP app_horizon_current_mastersupervisors Number of mastersupervisors
# TYPE app_horizon_current_mastersupervisors gauge
app_horizon_current_mastersupervisors 2
# HELP app_horizon_jobs_per_minute The number of jobs per minute
# TYPE app_horizon_jobs_per_minute gauge
app_horizon_jobs_per_minute 42
# HELP app_horizon_status The status of Horizon, -1 = inactive, 0 = paused, 1 = running
# TYPE app_horizon_status gauge
app_horizon_status 1
# HELP app_horizon_current_workload Current workload of all queues
# TYPE app_horizon_current_workload gauge
app_horizon_current_workload{queue="default"} 5
app_horizon_current_workload{queue="emails"} 12
```

#### Error Response (403 Forbidden)
- **Status**: 403
- **Condition**: `config('horizon-exporter.ip_whitelist')` is non-empty **and** `IpUtils::checkIp($request->ip(), config('horizon-exporter.ip_whitelist'))` returns `false`

#### Error Response (5xx)
- **Status**: 500 (default for uncaught exceptions)
- **Condition**: Uncaught exceptions during the exporter pipeline (invalid exporter class, unresolvable Horizon contract, `promphp` registry exceptions) bubble up and are rendered by Laravel's exception handler.

### Authentication
No token/session-based authentication is built in. Access control is handled entirely by the configured middleware chain:
- Default `IPWhitelistingMiddleware`: allow-list matching (empty `ip_whitelist` → allow all; otherwise `IpUtils::checkIp` against exact IPs and CIDR ranges).
- Replaceable via `config('horizon-exporter.middleware')` with any middleware class or array, applied to the route group by the service provider.
```

--------------------------------

### Route definition for GET /metrics in routes/api.php

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/endpoints.md

Defines the Prometheus scrape endpoint using the URL from config('horizon-exporter.url') and the controller's metrics method. The route is registered only when the exporter is enabled and routes are not cached, and it is wrapped by the configured middleware.

```php
<?php
Route::get(config('horizon-exporter.url'), \LKDevelopment\HorizonPrometheusExporter\Http\Controller\HorizonPrometheusExporterController::class.'@metrics');
```

--------------------------------

### boot() method for HorizonPrometheusExporterServiceProvider

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

Publishes the config file when running in console and registers routes after the application is booted. Route registration is deferred until booted() completes.

```php
public function boot(): void
{
    if ($this->app->runningInConsole()) {
        $this->publishes([
            __DIR__ . '/../config/config.php' => config_path('horizon-exporter.php'),
        ], 'config');
    }
    $this->app->booted(function () {
        $this->routes();
    });
}
```

--------------------------------

### Run Tests

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/README.md

Run the package test suite.

```bash
composer test
```

--------------------------------

### handle(Request $request, \Closure $next)

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Applies the IP whitelist check and either continues the request pipeline or aborts with 403. When the whitelist is empty, all requests pass through.

```APIDOC
## handle(Request $request, \Closure $next)

### Description
Applies the IP whitelist check and either continues the request pipeline or aborts with 403. When the whitelist is empty, all requests pass through.

### Method
handle

### Signature
handle(Request $request, \Closure $next)

### Parameters
- **$request** (Illuminate\Http\Request) - Required - The inbound request; `$request->ip()` determines the client address to check.
- **$next** (\Closure) - Required - The next middleware/handler closure; invoked with `$request` when the client IP is allowed (or the whitelist is empty).

### Return Type
No return type declared. Returns whatever the continuation closure returns (typically Illuminate\Http\Response / Symfony\Component\HttpFoundation\Response).

### Throws
- **Symfony\Component\HttpKernel\Exception\HttpException** (status 403) - When `config('horizon-exporter.ip_whitelist')` is non-empty and `IpUtils::checkIp($request->ip(), config('horizon-exporter.ip_whitelist'))` returns `false`.

### Behavior Details
- Empty whitelist (`[]` - the shipped default) → the check is skipped entirely; all requests pass.
- Whitelist matching uses `Symfony\Component\HttpFoundation\IpUtils::checkIp($clientIp, $ipWhitelist)`, which supports exact IPv4/IPv6 addresses as well as CIDR ranges (e.g. `10.0.0.0/24`).
- Laravel exception handling converts the thrown `HttpException` into a 403 response for the client.
```

--------------------------------

### Sample configuration for laravel-horizon-prometheus-exporter

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/configuration.md

Customize the package by returning an array from config/config.php. Set 'namespace' to prefix metric names, 'enabled' via the HORIZON_PROMETHEUS_EXPORTER_ENABLED environment variable (defaults to true), 'url' for the scrape endpoint, and 'exporters' to list Exporter classes. 'ip_whitelist' restricts access unless 'middleware' replaces the whitelist middleware, and 'wipe_storage_after_render' controls storage cleanup.

```php
<?php

return [
    'namespace' => 'myapp',
    'enabled' => env('HORIZON_PROMETHEUS_EXPORTER_ENABLED', true),
    'url' => 'prometheus/metrics',
    'exporters' => [
        \LKDevelopment\HorizonPrometheusExporter\Exporter\HorizonStatus::class,
        \App\Metrics\HorizonQueueGauge::class, // custom Exporter implementation
    ],
    'ip_whitelist' => ['127.0.0.1', '10.0.0.0/24'],
    'middleware' => \App\Http\Middleware\MetricsTokenAuth::class,
    'wipe_storage_after_render' => false,
];
```

--------------------------------

### Basic usage — scrape as the controller does

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Loads exporters using the default configuration and renders metrics in Prometheus text format. Use this to replicate the controller's scraping behavior.

```php
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;
use Prometheus\RenderTextFormat;

ExporterRepository::load(); // uses config('horizon-exporter.exporters')

$renderer = new RenderTextFormat();
$output = $renderer->render(ExporterRepository::getRegistry()->getMetricFamilySamples());

header('Content-Type: ' . RenderTextFormat::MIME_TYPE);
echo $output;
```

--------------------------------

### Publish configuration with artisan vendor:publish

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

Run this command to copy the package's config/config.php to config/horizon-exporter.php using the config tag.

```bash
php artisan vendor:publish --provider=LKDevelopment\HorizonPrometheusExporter\HorizonPrometheusExporterServiceProvider
```

--------------------------------

### load() method implementation

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Full implementation of the load() method. It uses the provided exporters or falls back to the configured list, lazily creates a CollectorRegistry with an InMemory backend if none exists, then instantiates each exporter class and calls metrics() and collect() synchronously. Misconfiguration can raise Error or TypeError, and duplicate metric names can raise DuplicateMetricNameException.

```php
$_exporters = empty($exporters) ? config('horizon-exporter.exporters') : $exporters;

if (self::getRegistry() === null) {
    self::setRegistry(new CollectorRegistry(new InMemory()));
}
foreach ($_exporters as $exporter) {
    $_exporter = new $exporter();
    /**
     * @var Exporter $_exporter
     */
    $_exporter->metrics(self::$registry);
    $_exporter->collect();
}
```

--------------------------------

### handle method with IP whitelist check

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Checks the client IP against the horizon-exporter.ip_whitelist config. If the list is non-empty and the IP is not allowed, aborts with HTTP 403; otherwise continues the pipeline. Empty whitelist allows all requests.

```php
public function handle(Request $request, \Closure $next)
{
    if (!empty(config('horizon-exporter.ip_whitelist'))) {
        $clientIp = $request->ip();
        if (IpUtils::checkIp($clientIp, config('horizon-exporter.ip_whitelist'))) {
            return $next($request);
        } else {
            abort(403);
        }
    } else {
        return $next($request);
    }
}
```

--------------------------------

### Call IPWhitelistingMiddleware directly with error handling

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Demonstrates direct invocation of the middleware's handle method with a simulated request. Catches HttpException to detect when the IP is blocked (status 403) and allows custom logging or alerting.

```php
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use LKDevelopment\HorizonPrometheusExporter\Http\Middleware\IPWhitelistingMiddleware;

$middleware = new IPWhitelistingMiddleware();

try {
    $response = $middleware->handle(
        Request::create('http://localhost/metrics', 'GET', [], [], [], ['REMOTE_ADDR' => '203.0.113.7']),
        function (Request $request) {
            return new Response('metrics body');
        }
    );
    // reachable only when the IP is allowed
    echo $response->getContent();
} catch (\Symfony\Component\HttpKernel\Exception\HttpException $e) {
    // 403 -> blocked by the whitelist
    if ($e->getStatusCode() === 403) {
        // log / alert
    }
}
```

--------------------------------

### Apply IPWhitelistingMiddleware to a route

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Shows how to attach the IPWhitelistingMiddleware to a custom route using the middleware method. The route will be protected by the IP whitelist defined in the config.

```php
use Illuminate\Support\Facades\Route;
use LKDevelopment\HorizonPrometheusExporter\Http\Middleware\IPWhitelistingMiddleware;

Route::get('/private/metrics', function () {
    return 'ok';
})->middleware(IPWhitelistingMiddleware::class);
```

--------------------------------

### Import path for IPWhitelistingMiddleware

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Fully qualified class name for the middleware, used when referencing or replacing it via the horizon-exporter.middleware config key.

```text
LKDevelopment\HorizonPrometheusExporter\Http\Middleware\IPWhitelistingMiddleware
```

--------------------------------

### metrics() method

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-horizon-status.md

Registers the gauge with the collector registry. Uses getOrRegisterGauge with namespace, name 'horizon_status', and help text. No labels.

```php
public function metrics(CollectorRegistry $collectorRegistry): void
{
    $this->gauge = $collectorRegistry->getOrRegisterGauge(
        config('horizon-exporter.namespace'),
        'horizon_status',
        'The status of Horizon, -1 = inactive, 0 = paused, 1 = running'
    );
}
```

--------------------------------

### load() method signature

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Declares the static load method that runs the scrape pipeline for given or configured exporters. The $exporters parameter defaults to an empty array, in which case config('horizon-exporter.exporters') is used.

```php
public static function load(array $exporters = []): void
```

--------------------------------

### load(array $exporters = []): void

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Runs the full scrape pipeline for the given (or configured) exporters. It lazily creates a registry if none exists, instantiates each exporter class, and calls its metrics() and collect() methods.

```APIDOC
## load(array $exporters = []): void

### Description
Runs the full scrape pipeline for the given (or configured) exporters. It lazily creates a registry if none exists, instantiates each exporter class, and calls its metrics() and collect() methods.

### Method
load

### Signature
public static function load(array $exporters = []): void

### Parameters
- **$exporters** (array) - Optional - Default: [] - List of exporter class names. When empty, the value of `config('horizon-exporter.exporters')` is used.

### Return Type
void

### Behavior
- Registry lazily created on first call with an `InMemory` storage backend.
- Each entry of the array is treated as a class name and instantiated with `new $exporter()` (no constructor arguments).
- Each instance gets `metrics(self::$registry)` then `collect()` called synchronously in array order.
- Throws: none declared by this package. Because entries are instantiated via `new $exporter()` and must implement the exporter lifecycle, misconfiguration surfaces as framework-level exceptions: a class-string that is not an autoloadable class raises `Error` on instantiation, and an object that does not implement the two interface methods raises `Error`/`TypeError` when the methods are invoked. The registry can additionally surface `promphp/prometheus_client_php` exceptions (`DuplicateMetricNameException` when two exporters register the same metric name in the same namespace) — note again that the built-in exporters avoid this by using `getOrRegisterGauge()`.
```

--------------------------------

### Import path for CurrentWorkload

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

Namespace import path for the CurrentWorkload exporter class.

```text
LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentWorkload
```

--------------------------------

### PromQL alert expression for zero throughput

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

PromQL query that alerts when the metric equals zero for 10 minutes.

```promql
# Alert when job throughput drops to zero for 10 minutes
app_horizon_jobs_per_minute == 0
```

--------------------------------

### PromQL query for top busy queues

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

Returns the top 3 queues by current workload using the metric app_horizon_current_workload.

```promql
topk(3, app_horizon_current_workload)
```

--------------------------------

### Import path for ExporterRepository

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Namespace used to import the ExporterRepository class.

```text
LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository
```

--------------------------------

### metrics() method for CurrentWorkload

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

Registers a gauge with the 'queue' label using getOrRegisterGauge.

```php
public function metrics(CollectorRegistry $collectorRegistry): void
{
    $this->gauge = $collectorRegistry->getOrRegisterGauge(
        config('horizon-exporter.namespace'),
        'horizon_current_workload',
        'Current workload of all queues',
        ['queue']
    );
}
```

--------------------------------

### Programmatic usage of CurrentWorkload exporter

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

Loads the CurrentWorkload exporter into the repository and retrieves the gauge samples, one per queue with a 'queue' label.

```php
use LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentWorkload;
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;

ExporterRepository::load([CurrentWorkload::class]);

$gauge = ExporterRepository::getRegistry()->getGauge(
    'app',
    'horizon_current_workload'
);
$samples = $gauge->getSamples(); // one sample per queue, each with 'queue' label
```

--------------------------------

### PromQL alert for Horizon not running

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-horizon-status.md

PromQL query that triggers when the horizon_status metric is less than 1 (i.e., paused or inactive).

```promql
app_horizon_status < 1
```

--------------------------------

### getRegistry() method signature

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Declares the static getRegistry method that returns the current static registry or null if none has been set. No parameters are accepted.

```php
public static function getRegistry()
```

--------------------------------

### getRegistry()

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Returns the current static registry, or null if no registry has been set (e.g., before the first load() call).

```APIDOC
## getRegistry()

### Description
Returns the current static registry, or null if no registry has been set (e.g., before the first load() call).

### Method
getRegistry

### Signature
public static function getRegistry()

### Parameters
None.

### Return Type
Prometheus\CollectorRegistry (or null)
```

--------------------------------

### Programmatic exporter usage with ExporterRepository

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-processes-per-queue.md

Loads `CurrentProcessesPerQueue` via `ExporterRepository::load()`, then retrieves the `app` `horizon_current_processes` gauge and its samples. Each sample corresponds to one queue and carries a `queue` label.

```php
use LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentProcessesPerQueue;
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;

ExporterRepository::load([CurrentProcessesPerQueue::class]);

$gauge = ExporterRepository::getRegistry()->getGauge(
    'app',
    'horizon_current_processes'
);
$samples = $gauge->getSamples(); // one sample per queue, each with 'queue' label
```

--------------------------------

### register() method for HorizonPrometheusExporterServiceProvider

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

Merges the package config file into the 'horizon-exporter' config key so config('horizon-exporter.*') works before publishing.

```php
public function register(): void
{
    $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'horizon-exporter');
}
```

--------------------------------

### Import path for HorizonStatus

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-horizon-status.md

Namespace used to import the HorizonStatus exporter class.

```php
LKDevelopment\HorizonPrometheusExporter\Exporter\HorizonStatus
```

--------------------------------

### Default exporters list

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/configuration.md

The default 'exporters' array in config/config.php lists the seven built-in exporter classes. Comment out entries to disable them or add your own Exporter implementations.

```php
"exporters" => [
    \LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentMasterSupervisors::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\JobsPerMinute::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentWorkload::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentProcessesPerQueue::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\FailedJobsPerHour::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\HorizonStatus::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\RecentJobs::class
],
```

--------------------------------

### collect() method for CurrentWorkload

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

Writes one gauge sample per queue, handling split_queues structure.

```php
public function collect(): void
{
    $workloadRepository = app(WorkloadRepository::class);
    $workloads = collect($workloadRepository->get())->sortBy('name')->values();

    $workloads->each(function ($workload) {
        if (isset($workload['split_queues']) && $workload['split_queues']) {
            $workload['split_queues']->each(function ($queue) {
                $this->gauge->set($queue['length'], [$queue['name']]);
            });

            return;
        }

        $this->gauge->set($workload['length'], [$workload['name']]);
    });
}
```

--------------------------------

### Error-handling: replace the registry to isolate failure state

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Catches exceptions during `load()` and resets the registry to a fresh in-memory instance to avoid continuing from a half-populated state. Use this to isolate failure state.

```php
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;
use Prometheus\CollectorRegistry;
use Prometheus\Storage\InMemory;

try {
    ExporterRepository::load();
} catch (\Throwable $e) {
    // Reset to a fresh in-memory registry so a subsequent scrape
    // does not continue from a half-populated state.
    ExporterRepository::setRegistry(new CollectorRegistry(new InMemory()));
    report($e);
}
```

--------------------------------

### Loading a custom exporter set programmatically

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Loads a specific set of exporters by passing an array of exporter class names to `load()`. Use this when you need to customize which exporters are registered.

```php
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;
use App\Metrics\HorizonQueueGauge;

ExporterRepository::load([HorizonQueueGauge::class]);
```

--------------------------------

### PromQL query for queues with a single process

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-processes-per-queue.md

Selects series where `app_horizon_current_processes` equals 1, i.e., queues running exactly one process.

```promql
app_horizon_current_processes == 1
```

--------------------------------

### Import path for JobsPerMinute

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

Fully qualified class name for the JobsPerMinute exporter.

```text
LKDevelopment\HorizonPrometheusExporter\Exporter\JobsPerMinute
```

--------------------------------

### Class signature for CurrentWorkload

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-workload.md

PHP class declaration with a typed property for the gauge.

```php
<?php

namespace LKDevelopment\HorizonPrometheusExporter\Exporter;

use Laravel\Horizon\Contracts\WorkloadRepository;
use LKDevelopment\HorizonPrometheusExporter\Contracts\Exporter;
use Prometheus\CollectorRegistry;
use Prometheus\Gauge;

class CurrentWorkload implements Exporter
{
    protected Gauge $gauge;
```

--------------------------------

### IPWhitelistingMiddleware class signature

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/ip-whitelisting-middleware.md

Declares the middleware class with its namespace, imports, and class opening. It is not a Laravel Middleware subclass but a plain class with an handle method.

```php
<?php

namespace LKDevelopment\HorizonPrometheusExporter\Http\Middleware;

use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Symfony\Component\HttpFoundation\IpUtils;

class IPWhitelistingMiddleware
{
```

--------------------------------

### Programmatic usage of HorizonStatus

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-horizon-status.md

Loads the exporter, retrieves the gauge, and checks the status value.

```php
use LKDevelopment\HorizonPrometheusExporter\Exporter\HorizonStatus;
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;

ExporterRepository::load([HorizonStatus::class]);

$gauge = ExporterRepository::getRegistry()->getGauge('app', 'horizon_status');
$status = (int) $gauge->getValue(); // -1, 0 or 1

if ($status === 0) {
    // Horizon is paused
} elseif ($status === -1) {
    // Horizon is not running at all
}
```

--------------------------------

### Import path for CurrentProcessesPerQueue

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-processes-per-queue.md

Namespace used to reference the CurrentProcessesPerQueue exporter class.

```text
LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentProcessesPerQueue
```

--------------------------------

### metrics() method registers gauge

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

Registers the Prometheus gauge with the collector registry using the configured namespace and metric name 'horizon_jobs_per_minute'.

```php
public function metrics(CollectorRegistry $collectorRegistry): void
{
    $this->gauge = $collectorRegistry->getOrRegisterGauge(
        config('horizon-exporter.namespace'),
        'horizon_jobs_per_minute',
        'The number of jobs per minute'
    );
}
```

--------------------------------

### PromQL alert for recent failures

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-failed-jobs-per-hour.md

PromQL query that triggers when the metric is greater than zero.

```promql
# Alert when any failures have been recorded
app_horizon_failed_jobs > 0
```

--------------------------------

### Error handling around the scrape

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/controller.md

Wraps the metrics() call in a try-catch to catch any Throwable. On failure, aborts with HTTP 500 and a message 'Metrics scrape failed: ' plus the exception message, instead of returning an empty 200.

```php
use LKDevelopment\HorizonPrometheusExporter\Http\Controller\HorizonPrometheusExporterController;

$controller = new HorizonPrometheusExporterController();

try {
    $response = $controller->metrics();
} catch (\Throwable $e) {
    // Exporter pipeline failure; surface an HTTP 500 instead of an empty 200.
    abort(500, 'Metrics scrape failed: ' . $e->getMessage());
}
```

--------------------------------

### setRegistry() method signature

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Declares the static setRegistry method that replaces the static registry instance. The $collectorRegistry parameter is required and must be a Prometheus\CollectorRegistry.

```php
public static function setRegistry(CollectorRegistry $collectorRegistry): void
```

--------------------------------

### Error handling pattern in collect()

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-contract.md

Wraps metric setting in try-catch to handle cases where Horizon contracts are unavailable before Horizon is running. Falls back to -1 so Prometheus still receives the time series.

```php
public function collect(): void
{
    try {
        $this->gauge->set(app(\Laravel\Horizon\Contracts\MetricsRepository::class)->jobsProcessedPerMinute());
    } catch (\Throwable $e) {
        // Horizon contracts may be unavailable before Horizon is running;
        // fall back to -1 so Prometheus still receives the time series.
        $this->gauge->set(-1);
    }
}
```

--------------------------------

### Import path for HorizonPrometheusExporterServiceProvider

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

Use this import path to reference the service provider class in your Laravel application.

```php
LKDevelopment\HorizonPrometheusExporter\HorizonPrometheusExporterServiceProvider
```

--------------------------------

### Import path for FailedJobsPerHour

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-failed-jobs-per-hour.md

Namespace import for the FailedJobsPerHour exporter class.

```text
LKDevelopment\HorizonPrometheusExporter\Exporter\FailedJobsPerHour
```

--------------------------------

### Programmatic usage of the exporter

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-mastersupervisors.md

Loads the exporter into the repository and retrieves the gauge value, printing it with echo.

```php
use LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentMasterSupervisors;
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;

ExporterRepository::load([CurrentMasterSupervisors::class]);

$samples = ExporterRepository::getRegistry()->getGauge(
    'app',
    'horizon_current_mastersupervisors'
);
echo $samples->getValue(); // e.g. 2.0
```

--------------------------------

### Import path for CurrentMasterSupervisors

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-mastersupervisors.md

Namespace used to reference the CurrentMasterSupervisors exporter class.

```text
LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentMasterSupervisors
```

--------------------------------

### Exporter with labels and optional behavior

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-contract.md

Shows how to define label names in metrics() and pass label values in collect(). Includes a private helper method for application-specific scoring logic.

```php
<?php

namespace App\Metrics;

use LKDevelopment\HorizonPrometheusExporter\Contracts\Exporter;
use Prometheus\CollectorRegistry;
use Prometheus\Gauge;

class PerQueueGauge implements Exporter
{
    protected Gauge $gauge;

    public function metrics(CollectorRegistry $collectorRegistry): void
    {
        $this->gauge = $collectorRegistry->getOrRegisterGauge(
            'app',
            'queue_health',
            'Health score per queue',
            ['queue'] // label names
        );
    }

    public function collect(): void
    {
        foreach (['low', 'high'] as $queue) {
            $this->gauge->set($this->scoreFor($queue), [$queue]);
        }
    }

    private function scoreFor(string $queue): int
    {
        // application-specific scoring logic
        return 1;
    }
}
```

--------------------------------

### metrics() method of CurrentProcessesPerQueue

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-processes-per-queue.md

Registers a Prometheus gauge named horizon_current_processes with a queue label using the provided collector registry.

```php
public function metrics(CollectorRegistry $collectorRegistry): void
{
    $this->gauge = $collectorRegistry->getOrRegisterGauge(
        config('horizon-exporter.namespace'),
        'horizon_current_processes',
        'Current processes of all queues',
        ['queue']
    );
}
```

--------------------------------

### Minimal custom exporter implementing Exporter contract

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-contract.md

Implements the Exporter contract with metrics() and collect(). Uses getOrRegisterGauge() to keep metrics() idempotent and avoid DuplicateMetricNameException. Register the class in config/horizon-exporter.php under 'exporters' or pass it to ExporterRepository::load().

```php
<?php

namespace App\Metrics;

use LKDevelopment\HorizonPrometheusExporter\Contracts\Exporter;
use Prometheus\CollectorRegistry;
use Prometheus\Gauge;

class HorizonQueueGauge implements Exporter
{
    protected Gauge $gauge;

    public function metrics(CollectorRegistry $collectorRegistry): void
    {
        $this->gauge = $collectorRegistry->getOrRegisterGauge(
            'app',
            'my_widget_count',
            'Number of widgets currently processed'
        );
    }

    public function collect(): void
    {
        $this->gauge->set(\App\Models\Widget::count());
    }
}
```

```php
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;

ExporterRepository::load([
    \App\Metrics\HorizonQueueGauge::class,
]);

$samples = ExporterRepository::getRegistry()->getMetricFamilySamples();
```

--------------------------------

### collect() method of CurrentProcessesPerQueue

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-processes-per-queue.md

Fetches workload data, sorts by queue name, and sets a gauge sample per queue with the process count.

```php
public function collect(): void
{
    $workloadRepository = app(WorkloadRepository::class);
    $workloads = collect($workloadRepository->get())->sortBy('name')->values();

    $workloads->each(function ($workload) {
        $this->gauge->set($workload['processes'], [$workload['name']]);
    });
}
```

--------------------------------

### setRegistry(CollectorRegistry $collectorRegistry): void

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Replaces the static registry instance. The provided registry will be used by subsequent load() calls and returned by getRegistry().

```APIDOC
## setRegistry(CollectorRegistry $collectorRegistry): void

### Description
Replaces the static registry instance. The provided registry will be used by subsequent load() calls and returned by getRegistry().

### Method
setRegistry

### Signature
public static function setRegistry(CollectorRegistry $collectorRegistry): void

### Parameters
- **$collectorRegistry** (Prometheus\CollectorRegistry) - Required - The registry that subsequent `load()` calls will register metrics on and that `getRegistry()` returns.

### Return Type
void
```

--------------------------------

### Programmatic usage of JobsPerMinute

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

Loads the exporter via ExporterRepository and retrieves the gauge value from the registry.

```php
use LKDevelopment\HorizonPrometheusExporter\Exporter\JobsPerMinute;
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;

ExporterRepository::load([JobsPerMinute::class]);

$gauge = ExporterRepository::getRegistry()->getGauge(
    'app',
    'horizon_jobs_per_minute'
);
$value = $gauge->getValue(); // jobs processed per minute at scrape time
```

--------------------------------

### ExporterRepository class signature (PHP)

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-repository.md

Exact class signature from src/Repository/ExporterRepository.php. The class is never instantiated; all members are public static. It holds a static CollectorRegistry and uses Prometheus\Storage\InMemory for in-memory metric storage.

```php
<?php

namespace LKDevelopment\HorizonPrometheusExporter\Repository;

use LKDevelopment\HorizonPrometheusExporter\Contracts\Exporter;
use Prometheus\CollectorRegistry;
use Prometheus\Storage\InMemory;

/**
 * Class ExporterRepository
 * @package LKDevelopment\HorizonPrometheusExporter\Repository
 */
class ExporterRepository
{
    /**
     * @var CollectorRegistry
     */
    protected static $registry;
```

--------------------------------

### Subclass the service provider in a Laravel app

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

Extend the package's service provider by registering it in your own provider's register method. This allows customization while reusing the original provider's functionality.

```php
<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class MetricsServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->register(
            \LKDevelopment\HorizonPrometheusExporter\HorizonPrometheusExporterServiceProvider::class
        );
    }
}
```

--------------------------------

### collect(): void

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-contract.md

Collects and writes metric values to the metric instances captured in metrics(). Must not receive the registry as an argument. Should handle errors gracefully, e.g., by setting a fallback value.

```APIDOC
## collect(): void

### Description
Collects and writes metric values to the metric instances captured in metrics(). Must not receive the registry as an argument. Should handle errors gracefully, e.g., by setting a fallback value.

### Method
collect

### Parameters
None

### Return Value
void

### Example
```php
public function collect(): void
{
    try {
        $this->gauge->set(app(\Laravel\Horizon\Contracts\MetricsRepository::class)->jobsProcessedPerMinute());
    } catch (\Throwable $e) {
        // Horizon contracts may be unavailable before Horizon is running;
        // fall back to -1 so Prometheus still receives the time series.
        $this->gauge->set(-1);
    }
}
```
```

--------------------------------

### collect() method

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-horizon-status.md

Computes and sets the gauge value: -1 if no masters, 0 if any master is paused, 1 otherwise. Uses MasterSupervisorRepository.

```php
public function collect(): void
{
    $status = -1;
    if ($masters = app(MasterSupervisorRepository::class)->all()) {
        $status = collect($masters)->contains(function ($master) {
            return $master->status === 'paused';
        }) ? 0 : 1;
    }
    $this->gauge->set($status);
}
```

--------------------------------

### Class signature for HorizonPrometheusExporterServiceProvider

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

The class extends Illuminate\Support\ServiceProvider and defines the package's service provider.

```php
<?php

namespace LKDevelopment\HorizonPrometheusExporter;

use Illuminate\Support\Facades\Route;
use Illuminate\Support\ServiceProvider;

class HorizonPrometheusExporterServiceProvider extends ServiceProvider
{
```

--------------------------------

### collect() method sets gauge value

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

Sets the gauge to the number of jobs processed per minute from the MetricsRepository.

```php
public function collect(): void
{
    $this->gauge->set(app(MetricsRepository::class)->jobsProcessedPerMinute());
}
```

--------------------------------

### collect() sets gauge to master supervisor count

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-mastersupervisors.md

Counts all master supervisors from the repository and sets the gauge value. Throws a binding-resolution exception if the repository is not resolvable.

```php
public function collect(): void
{
    $number = count(app(MasterSupervisorRepository::class)->all());

    $this->gauge->set($number);
}
```

--------------------------------

### Disabling the exporter in config

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-current-mastersupervisors.md

Shows how to comment out the exporter class in the configuration file to disable it.

```php
'exporters' => [
    // \LKDevelopment\HorizonPrometheusExporter\Exporter\CurrentMasterSupervisors::class,
    \LKDevelopment\HorizonPrometheusExporter\Exporter\JobsPerMinute::class,
    // ...
],
```

--------------------------------

### routes() method for HorizonPrometheusExporterServiceProvider

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/service-provider.md

Registers the metrics route inside the configured middleware group only when the exporter is enabled and routes are not cached. Returns early if routes are cached or the exporter is disabled.

```php
protected function routes(): void
{
    if ($this->app->routesAreCached()) {
        return;
    }

    if (config('horizon-exporter.enabled')) {
        Route::middleware(config('horizon-exporter.middleware'))->group(
            __DIR__ . '/../routes/api.php'
        );
    }
}
```

--------------------------------

### Class signature for HorizonPrometheusExporterController

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/controller.md

The class extends Illuminate\Routing\Controller and uses the ExporterRepository and RenderTextFormat. It is the controller for the Prometheus scrape endpoint.

```php
<?php

namespace LKDevelopment\HorizonPrometheusExporter\Http\Controller;

use Illuminate\Http\Response;
use Illuminate\Routing\Controller;
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository;
use Prometheus\RenderTextFormat;

class HorizonPrometheusExporterController extends Controller
{
```

--------------------------------

### metrics(CollectorRegistry $collectorRegistry): void

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-jobs-per-minute.md

Registers a Prometheus gauge metric named `{namespace}_horizon_jobs_per_minute` with the provided collector registry. This method is part of the Exporter contract and is called during exporter loading.

```APIDOC
## metrics(CollectorRegistry $collectorRegistry): void

### Description
Registers a Prometheus gauge metric named `{namespace}_horizon_jobs_per_minute` with the provided collector registry. This method is part of the Exporter contract and is called during exporter loading.

### Method
metrics

### Signature
`public function metrics(CollectorRegistry $collectorRegistry): void`

### Parameters
- **$collectorRegistry** (Prometheus\CollectorRegistry) - Required - The shared registry; `getOrRegisterGauge` is called with `(namespace, name, help)` and no label names.

### Return Type
void

### Registered Metric
- **Type**: gauge
- **Name**: `{namespace}_horizon_jobs_per_minute` (namespace default `app`)
- **Help**: `The number of jobs per minute`
- **Labels**: none

### Example
```php
public function metrics(CollectorRegistry $collectorRegistry): void
{
    $this->gauge = $collectorRegistry->getOrRegisterGauge(
        config('horizon-exporter.namespace'),
        'horizon_jobs_per_minute',
        'The number of jobs per minute'
    );
}
```
```

--------------------------------

### Import path for RecentJobs

Source: https://github.com/lkaemmerling/laravel-horizon-prometheus-exporter/blob/master/_autodocs/api-reference/exporter-recent-jobs.md

Fully qualified class name for the RecentJobs exporter.

```text
LKDevelopment\HorizonPrometheusExporter\Exporter\RecentJobs
```
Tokens:
Raw