Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arcana-softworks/laravel-pulse-s3-metrics
Display S3 bucket metrics on your Laravel Pulse dashboard
https://github.com/arcana-softworks/laravel-pulse-s3-metrics
composer-package laravel laravel-framework laravel-package laravel-pulse php
Last synced: 3 days ago
JSON representation
Display S3 bucket metrics on your Laravel Pulse dashboard
- Host: GitHub
- URL: https://github.com/arcana-softworks/laravel-pulse-s3-metrics
- Owner: arcana-softworks
- License: mit
- Created: 2023-12-28T11:55:56.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-08T14:58:51.000Z (3 months ago)
- Last Synced: 2024-09-07T08:55:27.234Z (26 days ago)
- Topics: composer-package, laravel, laravel-framework, laravel-package, laravel-pulse, php
- Language: PHP
- Homepage:
- Size: 572 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# S3 Metrics Card for Laravel Pulse
[](https://packagist.org/packages/arcana/laravel-pulse-s3-metrics)
[](https://github.com/arcana-softworks/laravel-pulse-s3-metrics/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/arcana-softworks/laravel-pulse-s3-metrics/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/arcana/laravel-pulse-s3-metrics)
Fetch existing data usage and storage metrics from AWS CloudWatch for your S3 buckets and display them in a card on your [Laravel Pulse](https://pulse.laravel.com/) dashboard.
## Hire us
Developers at [Arcana Softworks](https://arcana-softworks.co.uk) have been building business-class PHP applications for more than 10 years. [Learn more about what we can do for you or your business](https://arcana-softworks.co.uk).
## Installation
You can install the package via composer:
```bash
composer require arcana/laravel-pulse-s3-metrics
```
You can optionally publish the config file with:
```bash
php artisan vendor:publish --tag="laravel-pulse-s3-metrics-config"
```
This is the contents of the published config file:
```php
return [
'enabled' => env('PULSE_S3_METRICS_ENABLED', true),
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION'),
'bucket' => env('AWS_BUCKET'),
'class' => env('AWS_STORAGE_CLASS', 'StandardStorage'),
];
```
By default, this package will fetch metrics for the S3 bucket specified in your `AWS_BUCKET` environment variable. You can override this by setting the `bucket` config value.
One variable you may be missing is the `AWS_STORAGE_CLASS` variable, which has been introduced by this package. This should be set to the storage class of your S3 bucket. The default value is `StandardStorage`, which is the default storage class for S3 buckets. If you have a different storage class, you should set this variable to the appropriate value.
The region should be the region where your S3 metrics are stored on CloudWatch.
### Install the Recorder
Publish the Laravel Pulse config so that you may add the S3 Metrics recorder:
```bash
php artisan vendor:publish --tag=pulse-config
```
This will publish the Pulse config to `config/pulse.php`
Add the S3 Metrics recorder to the `recorders` section of the Pulse config:
```php
'recorders' => [
// Existing recorders...
// ...
\Arcana\PulseS3Metrics\Recorders\S3Metrics::class => [
'enabled' => env('PULSE_S3_METRICS_ENABLED', true),
],
],
```
### Add the card to your Laravel Pulse dashboard
Publish the Laravel Pulse dashboard view:
```bash
php artisan vendor:publish --tag=pulse-dashboard
```
This will publish the Pulse dashboard view to `resources/views/vendor/pulse/dashboard.blade.php`
Add the S3 Metrics card to your dashboard (the card looks best at full width):
```blade
{{-- Existing cards... --}}
```
## Usage
The S3 Metrics card may not show metrics from your S3 bucket immediately. It may take up to 24 hours for metrics to be available on CloudWatch.
The recorder will run periodically whilst `php artisan pulse:work` is running. You can run this command in a terminal window to start the recorder:
```bash
php artisan pulse:check
```
## Testing
```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
- [Liam Anderson](https://github.com/liamja)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.