Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/renoki-co/horizon-exporter

Export Laravel Horizon metrics using this Prometheus exporter.
https://github.com/renoki-co/horizon-exporter

broadcast events exporter grafana hacktoberfest horizon jobs laravel php prometheus queue queuing

Last synced: 2 months ago
JSON representation

Export Laravel Horizon metrics using this Prometheus exporter.

Host: GitHub
URL: https://github.com/renoki-co/horizon-exporter
Owner: renoki-co
License: apache-2.0
Created: 2021-09-22T10:13:06.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2023-10-11T07:53:51.000Z (about 1 year ago)
Last Synced: 2024-09-30T08:02:43.742Z (3 months ago)
Topics: broadcast, events, exporter, grafana, hacktoberfest, horizon, jobs, laravel, php, prometheus, queue, queuing
Language: PHP
Homepage:
Size: 77.1 KB
Stars: 25
Watchers: 2
Forks: 6
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        Laravel Horizon Prometheus Exporter

===================================

![CI](https://github.com/renoki-co/horizon-exporter/workflows/CI/badge.svg?branch=master)

[![codecov](https://codecov.io/gh/renoki-co/horizon-exporter/branch/master/graph/badge.svg)](https://codecov.io/gh/renoki-co/horizon-exporter/branch/master)

[![StyleCI](https://github.styleci.io/repos/409155353/shield?branch=master)](https://github.styleci.io/repos/409155353)

[![Latest Stable Version](https://poser.pugx.org/renoki-co/horizon-exporter/v/stable)](https://packagist.org/packages/renoki-co/horizon-exporter)

[![Total Downloads](https://poser.pugx.org/renoki-co/horizon-exporter/downloads)](https://packagist.org/packages/renoki-co/horizon-exporter)

[![Monthly Downloads](https://poser.pugx.org/renoki-co/horizon-exporter/d/monthly)](https://packagist.org/packages/renoki-co/horizon-exporter)

[![License](https://poser.pugx.org/renoki-co/horizon-exporter/license)](https://packagist.org/packages/renoki-co/horizon-exporter)

Export Laravel Horizon metrics using this Prometheus exporter. This package leverages [Exporter Contracts](https://github.com/renoki-co/laravel-exporter-contracts).

## 🤝 Supporting

**If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with [Github Sponsors](https://github.com/sponsors/rennokki). 📦**

[](https://github-content.renoki.org/github-repo/29)

## 🚀 Installation

You can install the package via composer:

```bash

composer require renoki-co/horizon-exporter

```

Publish the config:

```bash

$ php artisan vendor:publish --provider="RenokiCo\HorizonExporter\HorizonExporterServiceProvider" --tag="config"

$ php artisan vendor:publish --provider="RenokiCo\LaravelExporter\LaravelExporterServiceProvider" --tag="config"

```

## 🙌 Usage

This package is pretty straightforward. Upon installing it, it will register the route at `/exporter/group/horizon-metrics` and you can point Prometheus towards it for scraping.

Please keep in mind that the metrics are not calculated by-process, but as a whole across all supervisors. Point your Prometheus scraper to one of the instances for horizontally-scaled environments.

```

# HELP laravel_horizon_master_status That status of the Master Horizon process. 0 = inactive, 1 = paused, 2 = running.

# TYPE laravel_horizon_master_status gauge

laravel_horizon_master_status{name="master-1",pid="10082"} 2

# HELP laravel_horizon_queue_runtime Get total jobs runtime by queue.

# TYPE laravel_horizon_queue_runtime gauge

laravel_horizon_queue_runtime{queue="default"} 41.085

# HELP laravel_horizon_queue_throughput Get total jobs throughput by queue.

# TYPE laravel_horizon_queue_throughput gauge

laravel_horizon_queue_throughput{queue="default"} 4

# HELP laravel_horizon_job_runtime Get total workload runtime by job name.

# TYPE laravel_horizon_job_runtime gauge

laravel_horizon_job_runtime{job="RenokiCo\\HorizonExporter\\Test\\Jobs\\BasicJob"} 53.666666666667

laravel_horizon_job_runtime{job="RenokiCo\\HorizonExporter\\Test\\Jobs\\BasicJob2"} 3.34

# HELP laravel_horizon_job_throughput Get total workload throughput by job name.

# TYPE laravel_horizon_job_throughput gauge

laravel_horizon_job_throughput{job="RenokiCo\\HorizonExporter\\Test\\Jobs\\BasicJob"} 3

laravel_horizon_job_throughput{job="RenokiCo\\HorizonExporter\\Test\\Jobs\\BasicJob2"} 1

# HELP laravel_horizon_jobs_by_type Get total processed jobs into all queues by specific type (i.e. completed, pending, etc.).

# TYPE laravel_horizon_jobs_by_type gauge

laravel_horizon_jobs_by_type{type="completed"} 4

laravel_horizon_jobs_by_type{type="failed"} 1

laravel_horizon_jobs_by_type{type="pending"} 1

laravel_horizon_jobs_by_type{type="recent"} 6

laravel_horizon_jobs_by_type{type="recent_failed"} 1

# HELP php_info Information about the PHP environment.

# TYPE php_info gauge

php_info{version="8.0.10"} 1

```

## 🐛 Testing

``` bash

vendor/bin/phpunit

```

## 🤝 Contributing

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

## 🔒  Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## 🎉 Credits

- [Alex Renoki](https://github.com/rennokki)

- [All Contributors](../../contributors)