error_radar 0.1.0

data/lib/error_radar.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'error_radar/version'
+require 'error_radar/configuration'
+require 'error_radar/tracking'
+require 'error_radar/middleware'
+require 'error_radar/server_monitor'
+require 'error_radar/engine'
+
+# Public entry point for the gem.
+#
+#   ErrorRadar.configure do |c|
+#     c.authenticate  = ->(controller) { controller.send(:authenticate_admin!) }
+#     c.current_user  = ->(controller) { controller.current_admin&.email }
+#   end
+#
+#   ErrorRadar.capture(exception, source: 'SomeJob', context: { post_id: 1 })
+#   ErrorRadar.notify('Custom problem', category: :external_api, severity: :warning)
+#   ErrorRadar.monitor('NightlyRakeTask') { do_work }
+module ErrorRadar
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    # Reset configuration — mostly useful in tests.
+    def reset_config!
+      @config = Configuration.new
+    end
+
+    def capture(exception, **kwargs)
+      Tracking.capture(exception, **kwargs)
+    end
+
+    def notify(message, **kwargs)
+      Tracking.notify(message, **kwargs)
+    end
+
+    def monitor(source, **kwargs, &block)
+      Tracking.monitor(source, **kwargs, &block)
+    end
+  end
+end

data/lib/generators/error_radar/install/install_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ErrorRadar
+  module Generators
+    # Run `bin/rails generate error_radar:install` to drop an initializer and the
+    # error_radar_error_logs migration into the host app.
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/error_radar.rb'
+      end
+
+      def copy_migration
+        migration_template 'create_error_radar_error_logs.rb.tt',
+                           'db/migrate/create_error_radar_error_logs.rb'
+      end
+
+      def show_readme
+        say "\nError Radar installed.", :green
+        say '  1. Review config/initializers/error_radar.rb'
+        say '  2. Mount the dashboard in config/routes.rb, e.g.:'
+        say "       mount ErrorRadar::Engine, at: '/monitoring'", :yellow
+        say '  3. Run: bin/rails db:migrate'
+      end
+    end
+  end
+end

data/lib/generators/error_radar/install/templates/create_error_radar_error_logs.rb.tt

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class CreateErrorRadarErrorLogs < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :error_radar_error_logs do |t|
+      # Grouping / dedup key so repeated identical failures collapse into one task.
+      t.string  :fingerprint, null: false
+
+      # Classification
+      t.integer :category, null: false, default: 0
+      t.integer :severity, null: false, default: 2
+      t.integer :status,   null: false, default: 0
+
+      # What & where
+      t.string  :error_class
+      t.string  :source     # job / service / class that raised
+      t.text    :message
+      t.text    :backtrace
+      t.json    :context    # arbitrary structured payload
+
+      # API specifics (3rd-party APIs, etc.)
+      t.integer :http_status
+      t.string  :request_url, limit: 1000
+      t.integer :api_code
+      t.integer :api_subcode
+
+      # Occurrence tracking
+      t.integer  :occurrences,   null: false, default: 1
+      t.datetime :first_seen_at, null: false
+      t.datetime :last_seen_at,  null: false
+
+      # Task workflow
+      t.datetime :resolved_at
+      t.string   :resolved_by
+      t.text     :resolution_note
+
+      t.timestamps
+    end
+
+    add_index :error_radar_error_logs, :fingerprint, unique: true
+    add_index :error_radar_error_logs, %i[status severity]
+    add_index :error_radar_error_logs, :category
+    add_index :error_radar_error_logs, :last_seen_at
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Configuration for the error_radar gem. All keys are optional; sensible
+# defaults are shown. See https://github.com/chienbn9x/error_radar for details.
+ErrorRadar.configure do |config|
+  # Master switch. Turn off in environments where you don't want to persist
+  # errors (e.g. test).
+  config.enabled = !Rails.env.test?
+
+  # --- Integrations (auto-detected; flip off if you don't want them) ---
+  config.install_middleware  = true   # Rack: capture web-layer exceptions
+  config.install_sidekiq     = true   # capture Sidekiq job failures (if Sidekiq present)
+  config.install_rails_admin = true   # register the ErrorLog board (if RailsAdmin present)
+
+  # --- Dashboard access control ---
+  # Run as a before_action; raise/redirect inside to deny. Example with Devise:
+  # config.authenticate = ->(controller) { controller.send(:authenticate_admin!) }
+  # config.current_user = ->(controller) { controller.current_admin&.email }
+
+  # --- Custom classification ---
+  # Map your own exception types to a category. First non-nil wins.
+  # config.categorize { |e| :external_api if e.is_a?(MyApi::Error) }
+  #
+  # Pull extra columns (http_status / request_url / api_code / api_subcode) out
+  # of a custom exception:
+  # config.extract_details do |e|
+  #   next unless e.is_a?(MyApi::Error)
+  #   { http_status: e.status, request_url: e.url, api_code: e.code }
+  # end
+
+  # --- Sidekiq server health panel (optional) ---
+  # Leave empty to just list whatever processes are live. To assert that
+  # specific processes must always run, list them here:
+  # config.expected_servers = [
+  #   { key: 'web', name: 'Web', tag: 'sidekiq_web', host: 'web', queue_hint: 'low' }
+  # ]
+end
+
+# --- Optional: capture ActiveJob failures across ALL queue adapters ---
+# Add to app/jobs/application_job.rb (skip if you only use Sidekiq, since the
+# Sidekiq integration above already covers it):
+#
+#   class ApplicationJob < ActiveJob::Base
+#     include ErrorRadar::Integrations::ActiveJob
+#   end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: error_radar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chienbn9x
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Captures unhandled exceptions from controllers, Rack, Sidekiq and ActiveJob,
+  deduplicates them by fingerprint, and exposes a kanban dashboard (and optional RailsAdmin
+  board) to triage them as tasks.
+email:
+- chienbn9x@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/error_radar/application_controller.rb
+- app/controllers/error_radar/dashboard_controller.rb
+- app/models/error_radar/application_record.rb
+- app/models/error_radar/error_log.rb
+- app/views/error_radar/dashboard/index.html.erb
+- app/views/error_radar/dashboard/show.html.erb
+- app/views/layouts/error_radar/application.html.erb
+- config/routes.rb
+- lib/error_radar.rb
+- lib/error_radar/configuration.rb
+- lib/error_radar/engine.rb
+- lib/error_radar/integrations/active_job.rb
+- lib/error_radar/integrations/rails_admin.rb
+- lib/error_radar/integrations/sidekiq.rb
+- lib/error_radar/middleware.rb
+- lib/error_radar/server_monitor.rb
+- lib/error_radar/tracking.rb
+- lib/error_radar/version.rb
+- lib/generators/error_radar/install/install_generator.rb
+- lib/generators/error_radar/install/templates/create_error_radar_error_logs.rb.tt
+- lib/generators/error_radar/install/templates/initializer.rb
+homepage: https://github.com/chienbn9x/error_radar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chienbn9x/error_radar
+  source_code_uri: https://github.com/chienbn9x/error_radar
+  changelog_uri: https://github.com/chienbn9x/error_radar/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Drop-in error tracking & task board for Rails apps.
+test_files: []