Introduction
Queue Metrics for Laravel
Welcome to Queue Metrics for Laravel - a comprehensive package for queue monitoring and metrics collection in Laravel applications.
What is Queue Metrics for Laravel?
Queue Metrics for Laravel provides deep visibility into your Laravel queue operations, helping you monitor performance, identify bottlenecks, and optimize your background job processing.
Key Features
- Real-time Metrics: Track job execution times, success rates, and failure patterns
- Queue Health Monitoring: Monitor queue sizes, worker status, and system resources
- Multiple Storage Backends: Choose between Redis (recommended) or database storage
- Prometheus Integration: Export metrics for monitoring with Prometheus and Grafana
- Flexible API: HTTP endpoints and PHP facade for programmatic access
- Event System: React to metrics changes and integrate with your application
- Performance Optimized: Minimal overhead with efficient data structures
🚀 Need Deep Insight and Replay Capability?
While this package provides a high-level overview of your queue's health and performance via aggregated metrics, Queue Monitor for Laravel allows you to dive into individual job executions.
We recommend installing it if you need:
- 🕵️♂️ Debugging: View exact arguments (payload) for failed jobs and read the full stack trace.
- 🔁 Job Replay: Restart failed jobs directly from the database with a single click or command.
- 👤 Customer Support: Look up jobs based on tags (e.g., find all jobs for a specific user).
- 📜 Audit Log: Complete history of every job execution, including which server/PID processed it.
The two packages are designed to work together: Metrics tells you that something is wrong, while Monitor tells you what is wrong and lets you fix it.
Getting Started
Choose your path based on your needs:
Quick Start (5 Minutes)
Want to get up and running immediately? Follow the Quick Start Guide to install and start collecting metrics in minutes.
Complete Installation
For detailed installation instructions including storage backend selection and configuration options, see the Installation Guide.
Configuration
Need to customize behavior? Check the Configuration Reference for all available options.
Core Features
Basic Usage
Learn how to access metrics and integrate with your application:
- Facade API - Primary developer interface for programmatic access
- HTTP API - REST endpoints for metrics retrieval
- Artisan Commands - CLI tools for metrics management
Advanced Features
Deep dive into advanced capabilities:
- Architecture Overview - Understand how the package works internally
- Events System - React to metrics changes and lifecycle events
- Prometheus Integration - Export metrics for monitoring infrastructure
- Performance Tuning - Optimize for your specific workload
Need Help?
- Quick answers: See the Quick Start Guide
- Configuration issues: Check the Configuration Reference
- Found a bug?: Report it on GitHub Issues
Package Requirements
- PHP: 8.3 or higher
- Laravel: 11.0 or higher (12.0+ recommended, 13.0 supported)
- Storage: Redis (recommended) or Database
License
Queue Metrics for Laravel is open-source software licensed under the MIT license.