Updated README

Author: railspulse

README.md

@@ -22,6 +22,11 @@
   - [Installation](#installation)
   - [Quick Setup](#quick-setup)
   - [Basic Configuration](#basic-configuration)
+- [Background Job Monitoring](#background-job-monitoring)
+  - [Overview](#overview)
+  - [Supported Adapters](#supported-adapters)
+  - [Job Tracking Configuration](#job-tracking-configuration)
+  - [Privacy & Security](#privacy--security)
 - [Authentication](#authentication)
   - [Authentication Setup](#authentication-setup)
   - [Authentication Examples](#authentication-examples)
@@ -54,16 +59,24 @@ Rails Pulse is a comprehensive performance monitoring and debugging gem that pro
 - Interactive dashboard with response time charts and request analytics
 - SQL query performance tracking with slow query identification
 - Route-specific metrics with configurable performance thresholds
+- **Background job monitoring** with execution tracking and failure analysis
 - Week-over-week trend analysis with visual indicators
 
+### Background Job Tracking
+- **Universal job tracking** compatible with all ActiveJob adapters
+- Monitor job performance, failures, and retries
+- Track individual job executions with detailed metrics
+- View operations and SQL queries executed during jobs
+- Configurable privacy controls for job arguments
+
 ### Developer Experience
 - Zero configuration setup with sensible defaults
 - Beautiful responsive interface with dark/light mode
 - Smart caching with minimal performance overhead
 - Multiple database support (SQLite, PostgreSQL, MySQL)
 
 ### Organization & Filtering
-- Flexible tagging system for routes, requests, and queries
+- Flexible tagging system for routes, requests, queries, and jobs
 - Filter performance data by custom tags
 - Organize monitoring data by environment, priority, or custom categories
 
@@ -172,10 +185,21 @@ RailsPulse.configure do |config|
     critical: 1000
   }
 
+  # Set performance thresholds for background jobs (in milliseconds)
+  config.job_thresholds = {
+    slow: 5_000,      # 5 seconds
+    very_slow: 30_000, # 30 seconds
+    critical: 60_000   # 1 minute
+  }
+
   # Asset tracking configuration
   config.track_assets = false       # Ignore asset requests by default
   config.custom_asset_patterns = [] # Additional asset patterns to ignore
 
+  # Job tracking configuration
+  config.track_jobs = true          # Enable background job tracking
+  config.capture_job_arguments = false # Disable argument capture for privacy
+
   # Rails Pulse mount path (optional)
   # Specify if Rails Pulse is mounted at a custom path to prevent self-tracking
   config.mount_path = nil  # e.g., "/admin/monitoring"
@@ -184,18 +208,22 @@ RailsPulse.configure do |config|
   config.ignored_routes = []    # Array of strings or regex patterns
   config.ignored_requests = []  # Array of request patterns to ignore
   config.ignored_queries = []   # Array of query patterns to ignore
+  config.ignored_jobs = []      # Array of job class names to ignore
+  config.ignored_queues = []    # Array of queue names to ignore
 
   # Tagging system - define available tags for categorizing performance data
   config.tags = ["production", "staging", "critical", "needs-optimization"]
 
   # Data cleanup
-  config.archiving_enabled = true        # Enable automatic cleanup
-  config.full_retention_period = 2.weeks # Delete records older than this
-  config.max_table_records = {           # Maximum records per table
-    rails_pulse_requests: 10000,
-    rails_pulse_operations: 50000,
-    rails_pulse_routes: 1000,
-    rails_pulse_queries: 500
+  config.archiving_enabled = true         # Enable automatic cleanup
+  config.full_retention_period = 30.days  # Delete records older than this
+  config.max_table_records = {            # Maximum records per table
+    rails_pulse_operations: 100_000,
+    rails_pulse_requests: 50_000,
+    rails_pulse_job_runs: 50_000,
+    rails_pulse_queries: 10_000,
+    rails_pulse_routes: 1_000,
+    rails_pulse_jobs: 1_000
   }
 
   # Multiple database support (optional)
@@ -206,6 +234,117 @@ RailsPulse.configure do |config|
 end
 ```
 
+## Background Job Monitoring
+
+Rails Pulse provides comprehensive monitoring for ActiveJob background jobs, tracking performance, failures, and execution details across all major job adapters.
+
+### Overview
+
+Background job monitoring is **enabled by default** and works automatically with any ActiveJob adapter. Rails Pulse captures:
+
+- **Job execution metrics**: Duration, status, retry attempts
+- **Failure tracking**: Error class, error message, failure rates
+- **Performance analysis**: Slow jobs, aggregate metrics by job class
+- **Operation timeline**: SQL queries and operations during job execution
+- **Job arguments**: Optional capture for debugging (disabled by default for privacy)
+
+Access the jobs dashboard at `/rails_pulse/jobs` to view:
+- All job classes with aggregate metrics (total runs, failure rate, average duration)
+- Individual job executions with detailed performance data
+- Filtering by time range, status, queue, and performance thresholds
+- Tagging support for organizing jobs by team, priority, or category
+
+### Supported Adapters
+
+Rails Pulse works with all ActiveJob adapters through universal tracking:
+
+- **Sidekiq** - Enhanced tracking via custom middleware
+- **Solid Queue** - Universal ActiveJob tracking
+- **Good Job** - Universal ActiveJob tracking
+- **Delayed Job** - Enhanced tracking via custom plugin
+- **Resque** - Universal ActiveJob tracking
+- **Any ActiveJob adapter** - Falls back to universal tracking
+
+No additional configuration needed - job tracking works out of the box with your existing setup.
+
+### Job Tracking Configuration
+
+Customize job tracking in your Rails Pulse initializer:
+
+```ruby
+RailsPulse.configure do |config|
+  # Enable or disable job tracking (default: true)
+  config.track_jobs = true
+
+  # Set performance thresholds for jobs (in milliseconds)
+  config.job_thresholds = {
+    slow: 5_000,        # 5 seconds
+    very_slow: 30_000,  # 30 seconds
+    critical: 60_000    # 1 minute
+  }
+
+  # Ignore specific job classes from tracking
+  config.ignored_jobs = [
+    "ActiveStorage::AnalyzeJob",
+    "ActiveStorage::PurgeJob"
+  ]
+
+  # Ignore specific queues from tracking
+  config.ignored_queues = ["low_priority", "mailers"]
+
+  # Capture job arguments for debugging (default: false)
+  # WARNING: May expose sensitive data - use with caution
+  config.capture_job_arguments = false
+
+  # Configure adapter-specific settings
+  config.job_adapters = {
+    sidekiq: { enabled: true, track_queue_depth: false },
+    solid_queue: { enabled: true, track_recurring: false },
+    good_job: { enabled: true, track_cron: false },
+    delayed_job: { enabled: true },
+    resque: { enabled: true }
+  }
+end
+```
+
+**Disabling job tracking for specific jobs:**
+
+```ruby
+class MyBackgroundJob < ApplicationJob
+  # Skip Rails Pulse tracking for this job
+  def perform(*args)
+    RailsPulse.with_tracking_disabled do
+      # Job logic here
+    end
+  end
+end
+```
+
+### Privacy & Security
+
+**Job argument capture is disabled by default** to protect sensitive information. Job arguments may contain:
+- User credentials or tokens
+- Personal identifiable information (PII)
+- API keys or secrets
+- Sensitive business data
+
+Only enable `capture_job_arguments` in development or when explicitly needed for debugging. Consider using parameter filtering if you need to capture arguments:
+
+```ruby
+# In your job class
+class SensitiveJob < ApplicationJob
+  def perform(user_id:, api_key:)
+    # Rails Pulse will track execution but not arguments by default
+  end
+end
+```
+
+**Performance impact:**
+- Minimal overhead: ~1-2ms per job execution
+- No blocking of job processing
+- Configurable cleanup prevents database growth
+- Can be disabled per-job or globally
+
 ## Authentication
 
 Rails Pulse supports flexible authentication to secure access to your monitoring dashboard.
@@ -257,7 +396,7 @@ config.authentication_method = proc {
 
 ## Tagging System
 
-Rails Pulse includes a flexible tagging system that allows you to categorize and organize your performance data. Tag routes, requests, and queries with custom labels to better organize and filter your monitoring data.
+Rails Pulse includes a flexible tagging system that allows you to categorize and organize your performance data. Tag routes, requests, queries, jobs, and job runs with custom labels to better organize and filter your monitoring data.
 
 ### Configuring Tags
 
@@ -280,7 +419,7 @@ end
 
 **Tag from the UI:**
 
-1. Navigate to any route, request, or query detail page
+1. Navigate to any route, request, query, job, or job run detail page
 2. Click the "+ tag" button next to the record
 3. Select from your configured tags
 4. Remove tags by clicking the × button on any tag badge
@@ -297,6 +436,15 @@ route.add_tag("high-traffic")
 query = RailsPulse::Query.find_by(normalized_sql: "SELECT * FROM users WHERE id = ?")
 query.add_tag("needs-optimization")
 
+# Tag a job
+job = RailsPulse::Job.find_by(name: "UserNotificationJob")
+job.add_tag("high-priority")
+job.add_tag("user-facing")
+
+# Tag a specific job run
+job_run = RailsPulse::JobRun.find_by(run_id: "abc123")
+job_run.add_tag("investigated")
+
 # Remove a tag
 route.remove_tag("critical")