Document queue exporters

Author: AlexVanderbist

docs/basic-usage/_index.md

@@ -2,3 +2,10 @@
 title: Basic usage
 weight: 1
 ---
+
+This section covers basic usage of the Laravel Prometheus package, including:
+
+- [Creating gauges]({{< ref "creating-gauges" >}}) - Learn how to create and register custom gauge metrics
+- [Using Horizon exporters]({{< ref "using-horizon-exporters" >}}) - Export Laravel Horizon metrics to Prometheus
+- [Using Queue exporters]({{< ref "using-queue-exporters" >}}) - Export Laravel queue metrics to Prometheus
+- [Using cached values]({{< ref "using-cached-values" >}}) - Optimize performance with cached metric values

docs/basic-usage/using-queue-exporters.md

@@ -0,0 +1,68 @@
+---
+title: Using Queue exporters
+weight: 3
+---
+
+> **Important**: If you are using Laravel Horizon, you should use the [Horizon exporters](./using-horizon-exporters.md) instead of these queue exporters. Horizon provides its own comprehensive queue monitoring and these two exporters should not be used together as they may conflict or provide duplicate metrics.
+
+We can export key metrics from Laravel's built-in queue system to Prometheus. To enable this feature, uncomment this line in the `app/Providers/PrometheusServiceProvider.php` file.
+
+```php
+$this->registerQueueCollectors(['default']);
+```
+
+This will register the following collectors for monitoring your Laravel queues:
+
+- `queue_size`: exports the total number of jobs in each queue
+- `queue_pending_jobs`: exports the number of pending jobs per queue
+- `queue_delayed_jobs`: exports the number of delayed jobs per queue (supported drivers)
+- `queue_reserved_jobs`: exports the number of reserved jobs per queue
+- `queue_oldest_pending_job_age`: exports the age of the oldest pending job in seconds (supported drivers)
+
+## Configuration
+
+### Basic Usage
+
+Register collectors for the default connection and default queue:
+
+```php
+$this->registerQueueCollectors(['default']);
+```
+
+### Custom Connection
+
+Monitor queues on a specific connection:
+
+```php
+$this->registerQueueCollectors(['high', 'low'], 'redis');
+```
+
+## Prometheus Metrics
+
+All metrics include `connection` and `queue` labels for filtering and aggregation:
+
+```
+# HELP app_queue_size The total number of jobs in the queue
+# TYPE app_queue_size gauge
+app_queue_size{connection="redis",queue="high"} 45
+app_queue_size{connection="redis",queue="low"} 12
+
+# HELP app_queue_delayed_jobs The number of delayed jobs in the queue
+# TYPE app_queue_delayed_jobs gauge
+app_queue_delayed_jobs{connection="redis",queue="high"} 3
+app_queue_delayed_jobs{connection="redis",queue="low"} 0
+```
+
+## Individual Collectors
+
+You can also register collectors individually with custom parameters in your `PrometheusServiceProvider`.
+
+```php
+use Spatie\Prometheus\Collectors\Queue\QueueSizeCollector;
+use Spatie\Prometheus\Collectors\Queue\QueueDelayedJobsCollector;
+
+Prometheus::registerCollectorClasses([
+    QueueSizeCollector::class,
+    QueueDelayedJobsCollector::class,
+], ['connection' => 'redis', 'queues' => ['critical', 'high', 'normal']]);
+```

docs/introduction.md

@@ -13,3 +13,23 @@ Prometheus::addGauge('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.
+
+## Built-in Collectors
+
+The package includes several built-in collectors for common Laravel functionality:
+
+### Queue Metrics
+Monitor your Laravel queues with comprehensive metrics including queue sizes, pending jobs, delayed jobs, and more. Supports all Laravel queue drivers (Redis, Database, SQS, etc.) with graceful fallbacks. If you're using Horizon, please use the Horizon collectors listed below instead!
+
+```php
+// Enable all queue collectors
+$this->registerQueueCollectors(['high', 'normal', 'low'], 'redis');
+```
+
+### Horizon Metrics
+Export Laravel Horizon metrics including supervisor status, workload distribution, job throughput, and failure rates.
+
+```php
+// Enable all Horizon collectors
+$this->registerHorizonCollectors();
+```