PHPackages                             arcana/laravel-pulse-s3-metrics - 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. [File &amp; Storage](/categories/file-storage)
4. /
5. arcana/laravel-pulse-s3-metrics

ActiveLibrary[File &amp; Storage](/categories/file-storage)

arcana/laravel-pulse-s3-metrics
===============================

Fetch existing data usage and storage metrics from AWS CloudWatch for your S3 bucket and display them in your Laravel Pulse dashboard.

1.0.0(2y ago)31.8k1[2 PRs](https://github.com/arcana-softworks/laravel-pulse-s3-metrics/pulls)MITPHPPHP ^8.1

Since Jan 1Pushed 1y ago1 watchersCompare

[ Source](https://github.com/arcana-softworks/laravel-pulse-s3-metrics)[ Packagist](https://packagist.org/packages/arcana/laravel-pulse-s3-metrics)[ Docs](https://github.com/arcana-softworks/laravel-pulse-s3-metrics)[ GitHub Sponsors](https://github.com/arcana-softworks)[ RSS](/packages/arcana-laravel-pulse-s3-metrics/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (17)Versions (4)Used By (0)

[![Screenshot of the S3 Metrics Pulse card](art%2Fheader.png)](art%2Fheader.png)

S3 Metrics Card for Laravel Pulse
=================================

[](#s3-metrics-card-for-laravel-pulse)

[![Latest Version on Packagist](https://camo.githubusercontent.com/7b93dc7c3e84431a2728c72e38ea411320987379ed1155629bb84bb2897720d9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f617263616e612f6c61726176656c2d70756c73652d73332d6d6574726963732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/arcana/laravel-pulse-s3-metrics)[![GitHub Tests Action Status](https://camo.githubusercontent.com/a1426958169e0924a064c18038aac50398d22c4cd2f1e6bd37deeee4a0c1834d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f617263616e612d736f6674776f726b732f6c61726176656c2d70756c73652d73332d6d6574726963732f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/arcana-softworks/laravel-pulse-s3-metrics/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/e67cc59eda13727fd95de58c85a0d837003c94ea946b1e4c59ec9cdbe53a1869/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f617263616e612d736f6674776f726b732f6c61726176656c2d70756c73652d73332d6d6574726963732f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/arcana-softworks/laravel-pulse-s3-metrics/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/6bf7e04d33006aed92c190d4fff56bd70e4e3c65aa3cae173d98c361b5c55e82/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f617263616e612f6c61726176656c2d70756c73652d73332d6d6574726963732e7376673f7374796c653d666c61742d737175617265)](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.

[![Screenshot of the S3 Metrics Pulse card](art%2Fscreenshot1.png)](art%2Fscreenshot1.png)

Hire us
-------

[](#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
------------

[](#installation)

You can install the package via composer:

```
composer require arcana/laravel-pulse-s3-metrics
```

You can optionally publish the config file with:

```
php artisan vendor:publish --tag="laravel-pulse-s3-metrics-config"
```

This is the contents of the published config file:

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

[](#install-the-recorder)

Publish the Laravel Pulse config so that you may add the S3 Metrics recorder:

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

```
'recorders' => [

    // Existing recorders...
    // ...

    \Arcana\PulseS3Metrics\Recorders\S3Metrics::class => [
        'enabled' => env('PULSE_S3_METRICS_ENABLED', true),
    ],

],
```

### Add the card to your Laravel Pulse dashboard

[](#add-the-card-to-your-laravel-pulse-dashboard)

Publish the Laravel Pulse dashboard view:

```
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):

```

    {{-- Existing cards... --}}

```

Usage
-----

[](#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:

```
php artisan pulse:check
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

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

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Liam Anderson](https://github.com/liamja)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 63.6% of commits — single point of failure

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

Unknown

Total

1

Last Release

862d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2b304a36b875e6fa9e36139500ae14fee0f5f7e0c3578520410604de3a54c063?d=identicon)[arcana-softworks](/maintainers/arcana-softworks)

---

Top Contributors

[![liamja](https://avatars.githubusercontent.com/u/962914?v=4)](https://github.com/liamja "liamja (7 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (2 commits)")

---

Tags

composer-packagelaravellaravel-frameworklaravel-packagelaravel-pulsephplaravels3awscloudwatchlaravel-pulsearcanaarcana-softworkslaravel-pulse-s3-metrics

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/arcana-laravel-pulse-s3-metrics/health.svg)

```
[![Health](https://phpackages.com/badges/arcana-laravel-pulse-s3-metrics/health.svg)](https://phpackages.com/packages/arcana-laravel-pulse-s3-metrics)
```

###  Alternatives

[aws/aws-sdk-php-laravel

A simple Laravel 9/10/11/12/13 service provider for including the AWS SDK for PHP.

1.7k35.6M75](/packages/aws-aws-sdk-php-laravel)[spatie/livewire-filepond

Upload files using Filepond in Livewire components

306452.7k3](/packages/spatie-livewire-filepond)[vinelab/cdn

Content Delivery Network (CDN) Package for Laravel

217240.8k1](/packages/vinelab-cdn)[mwguerra/filemanager

A full-featured file manager package for Laravel and Filament v5 with dual operating modes, drag-and-drop uploads, S3/MinIO support, and comprehensive security features.

718.5k1](/packages/mwguerra-filemanager)[mreduar/s3m

Multipart Uploads using Laravel and AWS S3

173.6k](/packages/mreduar-s3m)[unisharp/s3-presigned

An AWS S3 package for pre-signed upload purpose in Laravel and PHP.

151.8k](/packages/unisharp-s3-presigned)

PHPackages © 2026

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