README

Laravel Rate-Limit Dashboard

Visibility and operational controls for Laravel rate-limiting.

Laravel's built-in RateLimiter facade and throttle middleware allow you to define rate limits, but they provide no visual interface to monitor usage or adjust limits in production.

Laravel Rate-Limit Dashboard bridges this gap with instrumentation, persisted metrics, a secured dashboard, runtime limiter configuration, health checks, JSON endpoints, retention pruning, and threshold mail alerts.

Who is hitting the rate limits? Which endpoints are being abused? Can we adjust limits without redeploying?

The Problem

When users encounter HTTP 429 (Too Many Requests) errors, developers traditionally have no built-in way to:

• See the offending IP or API token
• Identify exactly which endpoint is being hammered
• Adjust the rate limits gracefully without redeploying code

This leads to support tickets, unchecked abuse, and misconfigured limits.

Features

Real-Time Visibility

• Dashboard showing total requests, throttled requests, utilisation, hourly volume, health checks, limiter activity, and recent events
• Top offenders grouped by IP, user ID, or API token through the JSON API

Dynamic Configuration

• Save package-managed limiter settings from the UI
• Apply per-user and per-IP overrides when using the package instrumenter middleware

Alerts, Checks, and Maintenance

• Built-in health checks for storage, dashboard protection, utilisation, decay settings, offenders, and unconfigured routes
• rate-limit:check-alerts mail notifications for configured threshold breaches
• rate-limit:prune retention cleanup for old raw events

Storage

• Uses the host application's configured SQL database through Eloquent
• Stores raw events, runtime limiter configuration, audit entries, and minute/hour/day summaries

Installation

composer require satheez/laravel-rate-limit-dashboard

Publish configuration and migrations:

php artisan vendor:publish --provider="Sa\RateLimitDashboard\RateLimitDashboardServiceProvider" --tag="rate-limit-dashboard-config"
php artisan vendor:publish --provider="Sa\RateLimitDashboard\RateLimitDashboardServiceProvider" --tag="rate-limit-dashboard-migrations"
php artisan migrate

Quick Start

Use the package middleware in place of Laravel's throttle middleware for routes you want to enforce and record:

Route::middleware(\Sa\RateLimitDashboard\Http\Middleware\RateLimitInstrumenter::class.':api')
    ->get('/api/search', SearchController::class);

Navigate to the dashboard route (default: /admin/rate-limits) after defining the viewRateLimitDashboard gate or using your own dashboard middleware.

Documentation

Security

See SECURITY.md for the vulnerability reporting policy.

License

MIT — see LICENSE.md.