error_radar 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdfb13eb6566d150855376a07e28a5a76a758b23526d7cf31de5a6adc17e5d27
-  data.tar.gz: 713dcf3fa8c7867b971b6e7da6dd7dbf56a6e4057ec284dbadb6a8818b83f6d6
+  metadata.gz: 57b3fa6a7576ae08baeb699b180048363846c84ecbb489fc93e16ea537939898
+  data.tar.gz: 67008613bd52755dad89b7ed1abbc9a86eb92c138f95cae8005f5272e8336594
 SHA512:
-  metadata.gz: b71979e7ef0ca2737d789f3f047a024c9933d8b2149e83e5d88fc734144213226dfb1a160b4080ee008104dd0c19dd35a1da06ce0fbeb2ae61a0a65455a65d0f
-  data.tar.gz: 1838775fea5865d76bc746c49bc51efb0a557d6f6caf0924bdcd489b081570ff8667715690e3ef1b8a32ca7af219d7a26a1fe312e17304c27e4a9025d0632bf4
+  metadata.gz: 2882f7be2a07a38bdafd4b44c8251774a470f37d44fcd3dc4403046cd2998eb1077ac576c97cd8aed6a43ab4a86153440598bafa5a6a47576f06bbc137a2528d
+  data.tar.gz: 8717757580e628dc988422df68c3a806bd7d9727f297439b5e7303cc049a48371f37035442dbfd12f7789cb8b480221b093720dda965f6ebeffc2c75ef3bcb57

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.7.0] - 2026-07-03
+
+### Added
+- **Occurrence history**: every individual error hit can now be stored in a
+  separate `error_radar_occurrences` table. Enable with
+  `config.track_occurrences = true` after running the upgrade migration:
+  `bin/rails generate error_radar:upgrade_v060 && bin/rails db:migrate`.
+- **`ErrorRadar::ErrorOccurrence` model**: columns `occurred_at`, `context`,
+  `backtrace`, `http_status`, `request_url`. Belongs to `ErrorLog` via
+  `error_log_id`. Indexed on `(error_log_id, occurred_at)` for fast retrieval.
+- **`config.max_occurrences_per_error`** (default: 200): automatically prunes
+  the oldest occurrences for a given error on each new hit so the table stays
+  bounded without manual cleanup.
+- **Occurrences panel on error detail page**: shows the 20 most recent
+  occurrences with timestamp, HTTP status badge, request URL, and expandable
+  "Context" / "Stack" toggles. Paginated at 20 per page.
+- **`GET /api/errors/:id`** now includes `recent_occurrences` (last 10 hits
+  with `occurred_at`, `http_status`, `request_url`, `context`) when
+  `track_occurrences` is enabled.
+- **`error_radar:upgrade_v060` generator**: generates the migration that creates
+  `error_radar_occurrences`.
+- **`ErrorLog#occurrences`** association: `has_many :occurrences, dependent: :delete_all`
+  so destroying an error log also removes its occurrence history.
+
+### Notes
+- `track_occurrences` defaults to `false` to avoid unexpected writes before the
+  migration is run. Set it to `true` after the migration has been applied.
+- Occurrences are recorded via `ErrorLog.record`, which is called by both the
+  synchronous capture path and `CaptureJob` (async path) — no extra
+  configuration needed once enabled.
+
 ## [0.6.0] - 2026-07-03
 
 ### Added

data/app/controllers/error_radar/api/errors_controller.rb

@@ -99,6 +99,22 @@ module ErrorRadar
             context:         log.context,
             backtrace:       log.backtrace
           )
+
+          if ErrorRadar.config.track_occurrences
+            begin
+              data[:recent_occurrences] = log.occurrences.recent.limit(10).map do |occ|
+                {
+                  id:           occ.id,
+                  occurred_at:  occ.occurred_at&.iso8601,
+                  http_status:  occ.http_status,
+                  request_url:  occ.request_url,
+                  context:      occ.context
+                }
+              end
+            rescue ActiveRecord::StatementInvalid
+              data[:recent_occurrences] = []
+            end
+          end
         end
 
         if log.class.column_names.include?('github_issue_url')

data/app/controllers/error_radar/errors_controller.rb

@@ -22,7 +22,23 @@ module ErrorRadar
       @pages        = pagination_pages(@page, @total_pages)
     end
 
-    def show; end
+    def show
+      @occurrences = []
+      return unless ErrorRadar.config.track_occurrences
+
+      begin
+        @occ_page       = [params[:occ_page].to_i, 1].max
+        occ_per_page    = 20
+        @occ_total      = @error.occurrences.count
+        @occ_total_pages = [(@occ_total.to_f / occ_per_page).ceil, 1].max
+        @occ_page       = [@occ_page, @occ_total_pages].min
+        @occurrences    = @error.occurrences.recent
+                                .limit(occ_per_page)
+                                .offset((@occ_page - 1) * occ_per_page)
+      rescue ActiveRecord::StatementInvalid
+        @occurrences = []
+      end
+    end
 
     def update_status
       new_status = params[:status].to_s

data/app/models/error_radar/error_log.rb

@@ -16,6 +16,10 @@ module ErrorRadar
 
     enum status: { open: 0, in_progress: 1, resolved: 2, ignored: 3 }, _prefix: :status
 
+    has_many :occurrences, class_name: 'ErrorRadar::ErrorOccurrence',
+                           foreign_key: :error_log_id,
+                           dependent: :delete_all
+
     validates :fingerprint, presence: true, uniqueness: true
     validates :first_seen_at, :last_seen_at, presence: true
 
@@ -60,6 +64,17 @@ module ErrorRadar
       log.last_seen_at = now
       log.save!
       log.instance_variable_set(:@new_fingerprint, new_fingerprint)
+
+      if ErrorRadar.config.track_occurrences
+        ErrorRadar::ErrorOccurrence.record_for(
+          log,
+          context:     context,
+          backtrace:   backtrace,
+          http_status: http_status,
+          request_url: request_url
+        )
+      end
+
       log
     rescue StandardError => e
       ErrorRadar::Tracking.warn_internal("ErrorLog.record failed: #{e.class}: #{e.message}")

data/app/models/error_radar/error_occurrence.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ErrorRadar
+  # One row per individual error hit. Linked to an ErrorLog (the deduplicated
+  # aggregate). Only recorded when config.track_occurrences is true and the
+  # upgrade_v060 migration has been run.
+  class ErrorOccurrence < ApplicationRecord
+    belongs_to :error_log
+
+    scope :recent, -> { order(occurred_at: :desc) }
+
+    def self.record_for(log, context: {}, backtrace: nil, http_status: nil, request_url: nil)
+      max = ErrorRadar.config.max_occurrences_per_error
+
+      create!(
+        error_log:   log,
+        occurred_at: Time.current,
+        context:     context.presence,
+        backtrace:   Array(backtrace).join("\n").presence,
+        http_status: http_status,
+        request_url: request_url
+      )
+
+      if max&.positive?
+        keep_ids = where(error_log_id: log.id).order(occurred_at: :desc).limit(max).pluck(:id)
+        where(error_log_id: log.id).where.not(id: keep_ids).delete_all if keep_ids.any?
+      end
+    rescue ActiveRecord::StatementInvalid
+      # Table not yet created — run: bin/rails generate error_radar:upgrade_v060 && bin/rails db:migrate
+    rescue StandardError => e
+      ErrorRadar::Tracking.warn_internal("ErrorOccurrence.record_for failed: #{e.class}: #{e.message}")
+    end
+
+    def context_pretty
+      return '{}' if context.blank?
+      JSON.pretty_generate(context.is_a?(Hash) ? context : JSON.parse(context.to_s))
+    rescue JSON::ParserError
+      context.to_s
+    end
+  end
+end

data/app/views/error_radar/errors/show.html.erb

@@ -104,6 +104,97 @@
   </div>
 </div>
 
+<%# ── Occurrences History ── %>
+<% if ErrorRadar.config.track_occurrences %>
+  <div class="panel" style="margin-top:16px" id="occurrences-panel">
+    <div style="display:flex;justify-content:space-between;align-items:baseline;margin-bottom:12px">
+      <h2 style="margin:0">Occurrence History
+        <% if @occ_total.to_i > 0 %>
+          <span style="font-size:13px;font-weight:400;color:#6b7280">(<%= @occ_total %> total)</span>
+        <% end %>
+      </h2>
+    </div>
+
+    <% if @occurrences.empty? %>
+      <p style="font-size:13px;color:#9ca3af;margin:0">
+        <% if @occ_total.to_i == 0 %>
+          No occurrences recorded yet. New hits will appear here.
+        <% else %>
+          No occurrences on this page.
+        <% end %>
+      </p>
+    <% else %>
+      <table style="width:100%;border-collapse:collapse;font-size:13px">
+        <thead>
+          <tr style="border-bottom:2px solid #e5e7eb">
+            <th style="text-align:left;padding:6px 8px;color:#6b7280;width:170px">Time</th>
+            <th style="text-align:left;padding:6px 8px;color:#6b7280;width:70px">HTTP</th>
+            <th style="text-align:left;padding:6px 8px;color:#6b7280">Context / Request</th>
+            <th style="text-align:left;padding:6px 8px;color:#6b7280;width:80px">Backtrace</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @occurrences.each_with_index do |occ, i| %>
+            <tr style="border-bottom:1px solid #f3f4f6" class="occ-row">
+              <td style="padding:7px 8px;font-family:monospace;font-size:11px;white-space:nowrap">
+                <%= occ.occurred_at&.strftime('%Y-%m-%d %H:%M:%S') %>
+              </td>
+              <td style="padding:7px 8px">
+                <% if occ.http_status.present? %>
+                  <span class="badge" style="background:<%= occ.http_status.to_i >= 500 ? '#dc3545' : '#fd7e14' %>">
+                    <%= occ.http_status %>
+                  </span>
+                <% end %>
+              </td>
+              <td style="padding:7px 8px;max-width:400px">
+                <% if occ.request_url.present? %>
+                  <div style="font-size:11px;color:#6b7280;word-break:break-all;margin-bottom:4px"><%= occ.request_url.truncate(120) %></div>
+                <% end %>
+                <% unless (occ.context || {}).empty? %>
+                  <button onclick="toggleOcc('ctx-<%= i %>')"
+                          style="padding:2px 8px;font-size:11px;border:1px solid #d1d5db;border-radius:4px;background:#f9fafb;cursor:pointer">
+                    Context ▾
+                  </button>
+                  <div id="ctx-<%= i %>" style="display:none;margin-top:6px">
+                    <pre class="er-pre" style="max-height:200px;font-size:10px"><%= occ.context_pretty %></pre>
+                  </div>
+                <% end %>
+              </td>
+              <td style="padding:7px 8px">
+                <% if occ.backtrace.present? %>
+                  <button onclick="toggleOcc('bt-<%= i %>')"
+                          style="padding:2px 8px;font-size:11px;border:1px solid #d1d5db;border-radius:4px;background:#f9fafb;cursor:pointer">
+                    Stack ▾
+                  </button>
+                  <div id="bt-<%= i %>" style="display:none;position:absolute;z-index:10;background:#fff;border:1px solid #e5e7eb;border-radius:8px;padding:12px;width:600px;max-width:90vw;box-shadow:0 4px 16px rgba(0,0,0,.12)">
+                    <pre class="er-pre" style="max-height:300px"><%= occ.backtrace %></pre>
+                    <button onclick="toggleOcc('bt-<%= i %>')" style="margin-top:6px;font-size:11px;border:0;background:none;cursor:pointer;color:#6b7280">Close</button>
+                  </div>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+
+      <%# Pagination %>
+      <% if @occ_total_pages.to_i > 1 %>
+        <div style="margin-top:12px;display:flex;gap:6px;font-size:12px;align-items:center">
+          <% (1..@occ_total_pages).each do |p| %>
+            <% if p == @occ_page %>
+              <span style="padding:4px 10px;background:#2563eb;color:#fff;border-radius:6px"><%= p %></span>
+            <% else %>
+              <%= link_to p, error_path(@error, occ_page: p, anchor: 'occurrences-panel'),
+                    style: 'padding:4px 10px;border:1px solid #d1d5db;border-radius:6px;text-decoration:none;color:#374151' %>
+            <% end %>
+          <% end %>
+          <span style="color:#9ca3af">of <%= @occ_total_pages %> pages</span>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>
+
 <%# ── GitHub Issue ── %>
 <% if ErrorRadar.config.github_token.present? && ErrorRadar.config.github_repo.present? %>
   <div class="panel" style="margin-top:16px">
@@ -130,6 +221,11 @@
 <% end %>
 
 <script>
+  window.toggleOcc = function (id) {
+    var el = document.getElementById(id);
+    if (el) el.style.display = el.style.display === 'none' ? 'block' : 'none';
+  };
+
 (function () {
   var CSRF       = document.querySelector('meta[name="csrf-token"]').content;
   var STATUS_URL = '<%= error_status_path(@error) %>';

data/lib/error_radar/configuration.rb

@@ -69,6 +69,14 @@ module ErrorRadar
       @error_callbacks << block
     end
 
+    # Occurrences ─────────────────────────────────────────────────────────────
+    # When true, each individual error hit is stored in error_radar_occurrences.
+    # Requires running: bin/rails generate error_radar:upgrade_v060 && bin/rails db:migrate
+    attr_accessor :track_occurrences
+    # Maximum occurrences to keep per ErrorLog. Oldest are pruned on each new hit.
+    # nil = keep all (not recommended for high-volume apps).
+    attr_accessor :max_occurrences_per_error
+
     # Performance ─────────────────────────────────────────────────────────────
     # When true, ErrorLog.record is enqueued via ActiveJob (non-blocking).
     # Requires ActiveJob to be configured. Falls back to sync if ActiveJob is absent.
@@ -148,6 +156,9 @@ module ErrorRadar
       @app_host             = nil
       @error_callbacks      = []
 
+      @track_occurrences        = false
+      @max_occurrences_per_error = 200
+
       @async_capture     = false
       @capture_job_queue = :default
       @retention_days    = nil

data/lib/error_radar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErrorRadar
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/generators/error_radar/install/templates/initializer.rb

@@ -84,6 +84,12 @@ ErrorRadar.configure do |config|
   # config.github_token = ENV['GITHUB_TOKEN']   # PAT with repo scope
   # config.github_repo  = 'myorg/myapp'         # "owner/repo" format
 
+  # --- Occurrence History ---
+  # Store each individual error hit so you can see context/backtrace per occurrence.
+  # Requires running: bin/rails generate error_radar:upgrade_v060 && bin/rails db:migrate
+  # config.track_occurrences         = true
+  # config.max_occurrences_per_error = 200  # keep last N per error (oldest pruned on each new hit)
+
   # --- Performance & Async Capture ---
   # Write ErrorLog records via ActiveJob so exceptions don't block the request.
   # Requires ActiveJob + a queue adapter (Sidekiq, Solid Queue, etc.).

data/lib/generators/error_radar/upgrade_v060/templates/create_error_radar_occurrences.rb.tt

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CreateErrorRadarOccurrences < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :error_radar_occurrences do |t|
+      t.references :error_log, null: false,
+                               foreign_key: { to_table: :error_radar_error_logs },
+                               index: false  # covered by composite index below
+
+      t.datetime :occurred_at, null: false
+
+      t.json    :context      # structured payload snapshot for this hit
+      t.text    :backtrace    # backtrace at the moment of this occurrence
+      t.integer :http_status
+      t.string  :request_url, limit: 2000
+
+      t.timestamps
+    end
+
+    # Fast per-error chronological listing
+    add_index :error_radar_occurrences, %i[error_log_id occurred_at],
+              name: 'idx_er_occurrences_log_time'
+  end
+end

data/lib/generators/error_radar/upgrade_v060/upgrade_v060_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module ErrorRadar
+  module Generators
+    class UpgradeV060Generator < ActiveRecord::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      argument :name, type: :string, default: 'upgrade_v060'
+
+      desc 'Creates the error_radar_occurrences table for per-hit occurrence history (v0.7.0).'
+
+      def create_migration
+        migration_template 'create_error_radar_occurrences.rb.tt',
+                           'db/migrate/create_error_radar_occurrences.rb'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_radar
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - chienbn9x
@@ -66,6 +66,7 @@ files:
 - app/mailers/error_radar/error_mailer.rb
 - app/models/error_radar/application_record.rb
 - app/models/error_radar/error_log.rb
+- app/models/error_radar/error_occurrence.rb
 - app/views/error_radar/dashboard/index.html.erb
 - app/views/error_radar/dashboard/show.html.erb
 - app/views/error_radar/error_mailer/new_error.html.erb
@@ -98,6 +99,8 @@ files:
 - lib/generators/error_radar/install/templates/initializer.rb
 - lib/generators/error_radar/upgrade_v050/templates/add_github_issue_to_error_radar_error_logs.rb.tt
 - lib/generators/error_radar/upgrade_v050/upgrade_v050_generator.rb
+- lib/generators/error_radar/upgrade_v060/templates/create_error_radar_occurrences.rb.tt
+- lib/generators/error_radar/upgrade_v060/upgrade_v060_generator.rb
 - lib/tasks/error_radar.rake
 homepage: https://github.com/chienbn9x/error_radar
 licenses: