Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-prometheus
Export Laravel metrics to Prometheus
https://github.com/spatie/laravel-prometheus
devops laravel measure prometheus
Last synced: about 7 hours ago
JSON representation
Export Laravel metrics to Prometheus
- Host: GitHub
- URL: https://github.com/spatie/laravel-prometheus
- Owner: spatie
- License: mit
- Created: 2023-05-09T15:15:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T13:39:58.000Z (9 months ago)
- Last Synced: 2024-05-01T11:45:48.349Z (9 months ago)
- Topics: devops, laravel, measure, prometheus
- Language: PHP
- Homepage: https://freek.dev/2507-visualising-laravel-and-horizon-metrics-using-prometheus-and-grafana
- Size: 886 KB
- Stars: 119
- Watchers: 4
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Support: docs/support-us.md
Awesome Lists containing this project
README
# Export Laravel metrics to Prometheus
[](https://packagist.org/packages/spatie/laravel-prometheus)
[](https://github.com/spatie/laravel-prometheus/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/spatie/laravel-prometheus/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/spatie/laravel-prometheus)
This package can export key metrics of your app to [Prometheus](https://prometheus.io). It does this by providing an easy way to register metrics. Here's an example where we are going to export the user count to Prometheus.
```php
Prometheus::addGauge('User count')
->value(fn() => User::count());
```
These metrics will be exposed at the `/prometheus` endpoint. The package offers a way to add a security layer, so your key metrics don't become public.
You can configure your Prometheus instance to periodically crawl and import the metrics at the `/prometheus` endpoint of your app. Using [Grafana](https://grafana.com), you can visualize the data points that are stored in Prometheus.
## Support us
[
](https://spatie.be/github-ad-click/laravel-prometheus)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Documentation
You can find full documentation on [our dedicated documentation site](https://docs.spatie.be/laravel-prometheus).
## Testing
To run the horizon collector tests you need to install the redis extension.
On Ubuntu you can do so with the following command:
```bash
sudo apt-get install php-redis
```
On MacOS you can do so with the following command:
```bash
pecl install redis
```
To run the tests call `composer test`:
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
The Horizon collectors were heavily inspired on Lukas Kämmerling' excellent [laravel-horizon-prometheus-exporter](https://github.com/LKaemmerling/laravel-horizon-prometheus-exporter) package.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.