active_job_dash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d5c1ebe48cc6f8dfa5d7c04abb8dd8339593785697e354095675f07e12ff1b8
+  data.tar.gz: 7d6a81b1d9d4e90a79a2df8b97d5c3ea9d319e8fbf68d37bf601cf90e0e01222
+SHA512:
+  metadata.gz: 5e43b17afd3711f2f777c846056e18e488c2b37321e0bcda570bce71fe00f58996cafba28807c61c9d206c98c182451adb63bd01043a87e15dd0ee5bd3b3ca96
+  data.tar.gz: 7a2fd2f938e1287199d0cf046c65039246fc0a72530088d1885b57d9990bf3f276cf8f4bd3673d9f460d316c5c655e31e3e1933ef6cfa077752088505893b0ff

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-01-30
+
+### Added
+
+- Initial release
+- Job execution tracking for ActiveJob (perform, enqueue, retry, discard events)
+- Dashboard UI at `/admin/jobs` with job list, stats, and detail views
+- Success/failure rate metrics and duration tracking
+- Retry failed jobs from the dashboard
+- Filter by job class, queue, and status
+- Multi-region support with `REGION` environment variable
+- Configurable retention period for job history
+- Option to exclude specific jobs from tracking
+- Dashboard authentication hook
+- Programmatic access to stats via `ActiveJobDash.stats`
+- Rails generator for installation (`rails generate active_job_dash:install`)

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 BoringCache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# ActiveJobDash
+
+A dashboard and observability gem for ActiveJob. Monitor, track, and retry job executions with a built-in UI.
+
+## Requirements
+
+- Ruby >= 3.2
+- Rails >= 7.2
+
+## Features
+
+- Track all job executions (perform, enqueue, retry, discard)
+- View success/failure rates, duration metrics, and trends
+- Retry failed jobs from the UI
+- Filter by job class, queue, status
+- Multi-region support
+- Zero configuration required for basic usage
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'active_job_dash'
+```
+
+Then install:
+
+```bash
+bundle install
+rails generate active_job_dash:install
+rails db:migrate
+```
+
+## Usage
+
+Visit `/admin/jobs` to see the dashboard.
+
+### Configuration
+
+```ruby
+# config/initializers/active_job_dash.rb
+ActiveJobDash.configure do |config|
+  config.enabled = true
+  config.store_arguments = true
+  config.retention_days = 30
+  config.region = ENV['REGION']
+
+  # Exclude jobs from tracking
+  config.excluded_jobs = ['SomeNoisyJob']
+
+  # Dashboard authentication
+  config.dashboard_auth = -> {
+    authenticate_user!
+    redirect_to root_path unless current_user.admin?
+  }
+end
+```
+
+### Programmatic Access
+
+```ruby
+# Get stats for the last hour
+stats = ActiveJobDash.stats(period: 1.hour)
+stats.summary
+# => { total: 1523, success: 1500, failed: 23, avg_duration_ms: 45.2, failure_rate: 1.51 }
+
+# Stats by job class
+stats.by_job_class
+
+# Recent failures
+stats.recent_failures(limit: 10)
+
+# Retry a specific job
+execution = ActiveJobDash::JobExecution.find(id)
+execution.retry!
+```
+
+## License
+
+MIT

data/app/controllers/active_job_dash/application_controller.rb

@@ -0,0 +1,15 @@
+module ActiveJobDash
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    before_action :authenticate!
+
+    private
+
+    def authenticate!
+      return unless ActiveJobDash.configuration.dashboard_auth
+
+      instance_exec(&ActiveJobDash.configuration.dashboard_auth)
+    end
+  end
+end

data/app/controllers/active_job_dash/dashboard_controller.rb

@@ -0,0 +1,54 @@
+module ActiveJobDash
+  class DashboardController < ApplicationController
+    def index
+      @period = params[:period]&.to_i&.hours || 1.hour
+      @stats = ActiveJobDash.stats(period: @period)
+      @summary = @stats.summary
+      @by_job_class = @stats.by_job_class
+      @by_queue = @stats.by_queue
+      @recent_failures = @stats.recent_failures(limit: 10)
+      @timeline = @stats.timeline
+    end
+
+    def jobs
+      @job_class = params[:job_class]
+      @status = params[:status]
+      @period = params[:period]&.to_i&.hours || 24.hours
+
+      @executions = JobExecution.where(created_at: @period.ago..)
+      @executions = @executions.where(job_class: @job_class) if @job_class.present?
+      @executions = @executions.where(status: @status) if @status.present?
+      @executions = @executions.order(created_at: :desc).limit(100)
+    end
+
+    def show
+      @execution = JobExecution.find(params[:id])
+    end
+
+    def retry
+      @execution = JobExecution.find(params[:id])
+      @execution.retry!
+
+      redirect_to dashboard_path, notice: "Job #{@execution.job_class} re-enqueued"
+    rescue StandardError => e
+      redirect_to dashboard_path, alert: "Failed to retry: #{e.message}"
+    end
+
+    def retry_all
+      count = 0
+      JobExecution.pending_retry.where(created_at: 24.hours.ago..).find_each do |execution|
+        execution.retry!
+        count += 1
+      end
+
+      redirect_to dashboard_path, notice: "Re-enqueued #{count} jobs"
+    end
+
+    def purge
+      days = params[:days]&.to_i || ActiveJobDash.configuration.retention_days
+      deleted = JobExecution.where(created_at: ...days.days.ago).delete_all
+
+      redirect_to dashboard_path, notice: "Purged #{deleted} records older than #{days} days"
+    end
+  end
+end

data/app/jobs/active_job_dash/record_execution_job.rb

@@ -0,0 +1,9 @@
+module ActiveJobDash
+  class RecordExecutionJob < ActiveJob::Base
+    queue_as :low
+
+    def perform(attributes)
+      JobExecution.create!(attributes)
+    end
+  end
+end

data/app/models/active_job_dash/job_execution.rb

@@ -0,0 +1,51 @@
+module ActiveJobDash
+  class JobExecution < Record
+    self.table_name = "active_job_dash_executions"
+
+    validates :job_class, presence: true
+    validates :job_id, presence: true
+    validates :event_type, presence: true
+
+    scope :successful, -> { where(status: "success") }
+    scope :failed, -> { where(status: "failed") }
+    scope :pending_retry, -> { where(status: %w[failed exhausted]).where.not(arguments: nil) }
+    scope :performs, -> { where(event_type: "perform") }
+    scope :enqueues, -> { where(event_type: "enqueue") }
+
+    def retry!
+      return unless arguments.present?
+      return unless %w[failed exhausted discarded].include?(status)
+
+      job_class.constantize.perform_later(*parsed_arguments)
+      update!(status: "retried", retried_at: Time.current)
+    end
+
+    def parsed_arguments
+      return [] if arguments.blank?
+
+      JSON.parse(arguments)
+    rescue JSON::ParserError
+      []
+    end
+
+    def failed?
+      status == "failed"
+    end
+
+    def successful?
+      status == "success"
+    end
+
+    def duration_human
+      return nil unless duration_ms
+
+      if duration_ms < 1000
+        "#{duration_ms}ms"
+      elsif duration_ms < 60_000
+        "#{(duration_ms / 1000.0).round(2)}s"
+      else
+        "#{(duration_ms / 60_000.0).round(2)}m"
+      end
+    end
+  end
+end

data/app/models/active_job_dash/record.rb

@@ -0,0 +1,5 @@
+module ActiveJobDash
+  class Record < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/active_job_dash/dashboard/index.html.erb

@@ -0,0 +1,126 @@
+<div class="stats-grid">
+  <div class="stat-card">
+    <div class="stat-value"><%= number_with_delimiter(@summary[:total]) %></div>
+    <div class="stat-label">Total Jobs</div>
+  </div>
+  <% if (@summary[:queued] || 0) > 0 || (@summary[:running] || 0) > 0 %>
+    <div class="stat-card">
+      <div class="stat-value"><%= @summary[:queued] || 0 %> / <%= @summary[:running] || 0 %></div>
+      <div class="stat-label">Queued / Running</div>
+    </div>
+  <% end %>
+  <div class="stat-card success">
+    <div class="stat-value"><%= number_with_delimiter(@summary[:success]) %></div>
+    <div class="stat-label">Successful</div>
+  </div>
+  <div class="stat-card error">
+    <div class="stat-value"><%= number_with_delimiter(@summary[:failed]) %></div>
+    <div class="stat-label">Failed</div>
+  </div>
+  <div class="stat-card">
+    <div class="stat-value"><%= (@summary[:avg_duration_ms] || 0).round %>ms</div>
+    <div class="stat-label">Avg Duration</div>
+  </div>
+  <div class="stat-card <%= (@summary[:failure_rate] || 0) > 5 ? 'error' : '' %>">
+    <div class="stat-value"><%= number_to_percentage(@summary[:failure_rate] || 0, precision: 1) %></div>
+    <div class="stat-label">Failure Rate</div>
+  </div>
+</div>
+
+<div class="grid-2">
+  <div class="card">
+    <h2>Jobs by Class</h2>
+    <table>
+      <thead>
+        <tr>
+          <th>Job</th>
+          <th>Total</th>
+          <th>Success</th>
+          <th>Failed</th>
+          <th>Avg</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @by_job_class.each do |row| %>
+          <tr>
+            <td class="mono"><%= link_to row.job_class.gsub(/Job$/, ''), jobs_path(job_class: row.job_class) %></td>
+            <td><%= row.total %></td>
+            <td class="text-success"><%= row.success_count %></td>
+            <td class="text-error"><%= row.failed_count %></td>
+            <td class="text-muted"><%= row.avg_duration_ms&.round(0) %>ms</td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+
+  <div class="card">
+    <h2>Jobs by Queue</h2>
+    <table>
+      <thead>
+        <tr>
+          <th>Queue</th>
+          <th>Total</th>
+          <th>Success</th>
+          <th>Failed</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @by_queue.each do |row| %>
+          <tr>
+            <td class="mono"><%= row.queue_name || 'default' %></td>
+            <td><%= row.total %></td>
+            <td class="text-success"><%= row.success_count %></td>
+            <td class="text-error"><%= row.failed_count %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<div class="card">
+  <div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 12px;">
+    <h2 style="margin: 0;">Recent Failures</h2>
+    <% if @recent_failures.any? %>
+      <%= button_to "Retry All Failed", retry_all_path, method: :post, class: "btn btn-primary", form: { data: { turbo_confirm: "Retry all failed jobs from the last 24 hours?" } } %>
+    <% end %>
+  </div>
+  <table>
+    <thead>
+      <tr>
+        <th>Time</th>
+        <th>Job</th>
+        <th>Queue</th>
+        <th>Error</th>
+        <th>Duration</th>
+        <th></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @recent_failures.each do |exec| %>
+        <tr>
+          <td class="text-muted text-sm"><%= exec.created_at.strftime("%H:%M:%S") %></td>
+          <td class="mono"><%= exec.job_class.gsub(/Job$/, '') %></td>
+          <td class="text-muted"><%= exec.queue_name %></td>
+          <td>
+            <span class="badge failed"><%= exec.error_class&.split('::')&.last || 'Error' %></span>
+            <span class="text-muted text-sm"><%= truncate(exec.error_message, length: 60) %></span>
+          </td>
+          <td class="text-muted"><%= exec.duration_human %></td>
+          <td style="white-space: nowrap;">
+            <%= link_to "View", execution_path(exec), class: "btn" %>
+            <% if exec.arguments.present? %>
+              <%= button_to "Retry", retry_path(exec), method: :post, class: "btn btn-primary", form_class: "inline" %>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+      <% if @recent_failures.empty? %>
+        <tr>
+          <td colspan="6" class="text-muted" style="text-align: center; padding: 24px;">No failures in this period</td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/active_job_dash/dashboard/jobs.html.erb

@@ -0,0 +1,54 @@
+<div style="margin-bottom: 16px; display: flex; justify-content: space-between; align-items: center;">
+  <div>
+    <%= link_to "&larr; Dashboard".html_safe, dashboard_path, class: "btn" %>
+    <% if @job_class.present? %>
+      <span class="text-muted" style="margin-left: 12px;">Filtered: <%= @job_class %></span>
+    <% end %>
+  </div>
+  <div class="period-select">
+    <% [1, 6, 24, 168].each do |hours| %>
+      <%= link_to hours == 1 ? "1h" : hours == 6 ? "6h" : hours == 24 ? "24h" : "7d",
+          jobs_path(job_class: @job_class, status: @status, period: hours),
+          class: (@period == hours.hours ? "active" : "") %>
+    <% end %>
+  </div>
+</div>
+
+<div class="card">
+  <h2>Job Executions</h2>
+  <table>
+    <thead>
+      <tr>
+        <th>Time</th>
+        <th>Job</th>
+        <th>Event</th>
+        <th>Queue</th>
+        <th>Status</th>
+        <th>Duration</th>
+        <th>Region</th>
+        <th></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @executions.each do |exec| %>
+        <tr>
+          <td class="text-muted text-sm"><%= exec.created_at.strftime("%m/%d %H:%M:%S") %></td>
+          <td class="mono"><%= exec.job_class.gsub(/Job$/, '') %></td>
+          <td class="text-sm"><%= exec.event_type %></td>
+          <td class="text-muted"><%= exec.queue_name %></td>
+          <td><span class="badge <%= exec.status %>"><%= exec.status %></span></td>
+          <td class="text-muted"><%= exec.duration_human %></td>
+          <td class="text-muted"><%= exec.region %></td>
+          <td>
+            <%= link_to "View", execution_path(exec), class: "btn" %>
+          </td>
+        </tr>
+      <% end %>
+      <% if @executions.empty? %>
+        <tr>
+          <td colspan="8" class="text-muted" style="text-align: center; padding: 24px;">No job executions found</td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/active_job_dash/dashboard/show.html.erb

@@ -0,0 +1,77 @@
+<div style="margin-bottom: 16px;">
+  <%= link_to "&larr; Back to Dashboard".html_safe, dashboard_path, class: "btn" %>
+</div>
+
+<div class="card">
+  <h2>Job Execution Details</h2>
+
+  <table>
+    <tr>
+      <th style="width: 150px;">Job ID</th>
+      <td class="mono"><%= @execution.job_id %></td>
+    </tr>
+    <tr>
+      <th>Job Class</th>
+      <td class="mono"><%= @execution.job_class %></td>
+    </tr>
+    <tr>
+      <th>Queue</th>
+      <td><%= @execution.queue_name %></td>
+    </tr>
+    <tr>
+      <th>Event Type</th>
+      <td><%= @execution.event_type %></td>
+    </tr>
+    <tr>
+      <th>Status</th>
+      <td><span class="badge <%= @execution.status %>"><%= @execution.status %></span></td>
+    </tr>
+    <tr>
+      <th>Duration</th>
+      <td><%= @execution.duration_human || 'N/A' %></td>
+    </tr>
+    <tr>
+      <th>Executions</th>
+      <td><%= @execution.executions || 1 %></td>
+    </tr>
+    <tr>
+      <th>Region</th>
+      <td><%= @execution.region || 'N/A' %></td>
+    </tr>
+    <tr>
+      <th>Started At</th>
+      <td><%= @execution.started_at&.strftime("%Y-%m-%d %H:%M:%S.%L") %></td>
+    </tr>
+    <tr>
+      <th>Finished At</th>
+      <td><%= @execution.finished_at&.strftime("%Y-%m-%d %H:%M:%S.%L") %></td>
+    </tr>
+    <tr>
+      <th>Created At</th>
+      <td><%= @execution.created_at.strftime("%Y-%m-%d %H:%M:%S") %></td>
+    </tr>
+  </table>
+</div>
+
+<% if @execution.arguments.present? %>
+  <div class="card">
+    <h2>Arguments</h2>
+    <pre><%= JSON.pretty_generate(JSON.parse(@execution.arguments)) rescue @execution.arguments %></pre>
+  </div>
+<% end %>
+
+<% if @execution.error_class.present? %>
+  <div class="card">
+    <h2>Error</h2>
+    <div class="mb-2">
+      <span class="badge failed"><%= @execution.error_class %></span>
+    </div>
+    <pre style="white-space: pre-wrap;"><%= @execution.error_message %></pre>
+  </div>
+<% end %>
+
+<% if @execution.arguments.present? && @execution.failed? %>
+  <div style="margin-top: 16px;">
+    <%= button_to "Retry This Job", retry_path(@execution), method: :post, class: "btn btn-primary" %>
+  </div>
+<% end %>