error_radar 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 486749dc9fc6c6e2cc617340f184cf8dbeb4196199c3017eb7bf6f667718fe74
-  data.tar.gz: 13da87d1772c71901b66fb4cd6b4d29a809b539b6fccaee5613defae97c0a04d
+  metadata.gz: 106881790c16306716c7588f317da722c0e589db0a0a2bbb6e7ad838c9a8d118
+  data.tar.gz: d4c9ccf1363b88637dc625418daf8553e15aad0796f42f79aadc6eafb3a4f554
 SHA512:
-  metadata.gz: 6a9fe7aa11d7668ca353e0c6331eac9a339c43263f93bc3650085bd72f2072968376006f7481661037c7d9f80fdca0057b8a28d9779a92050b931fb4eccd441f
-  data.tar.gz: f98150abaa5c7bd7695ddd38ba91d65db73bfe81ce7e739c9f91fac20c596b3303643fc282320b2366f9b1b6bd4da48c2bfca7bd8d182e1162c3a7786770384a
+  metadata.gz: c880963d54ef38274dbc226b970f848f7a9ced038c6d88ababffe1b3eb71ef2d8490695a0a256775a500e707a72b9af2a017a066e8af1f66b17ab842a18ac726
+  data.tar.gz: ba612e7cc8a547cd1bf7ffb8704347636bccc7f763fba3a73fbfe1919b86573421873b61c88f6c8b44da0ed661cf8cf73d4da62a54998828dfe1a767642580ad

data/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2026-07-03
+
+### Added
+- **REST API** at `/api/*` for external integrations (CI/CD, dashboards, scripts):
+  - `GET  /api/errors` — paginated list with the same filters as the web UI
+    (`status`, `severity`, `category`, `q`, `from`, `to`, `sort`, `order`, `page`)
+  - `GET  /api/errors/:id` — full detail including context, backtrace, and
+    `github_issue_url` (if column is present)
+  - `PATCH /api/errors/:id` — update status; resolve accepts optional `note`
+    and `resolved_by` params
+  - `GET  /api/stats` — summary counts by status, severity, and category
+- **Bearer-token API auth**: set `config.api_token` to protect all `/api/*`
+  endpoints with `Authorization: Bearer <token>`.
+- **GitHub Issue integration**: "Create GitHub Issue" button on the error detail
+  page opens a pre-filled issue with error class, source, message, backtrace,
+  and a deep-link back to Error Radar. Requires `config.github_token` and
+  `config.github_repo`.
+- **`github_issue_url` column**: stored on the error row so the button becomes
+  "View GitHub Issue" once an issue exists. Requires running the upgrade
+  migration: `bin/rails generate error_radar:upgrade_v050 && bin/rails db:migrate`.
+- **`error_radar:upgrade_v050` generator**: generates the migration that adds
+  `github_issue_url` to `error_radar_error_logs`.
+
+### Notes
+- The GitHub column is optional — the integration is gracefully degraded when the
+  migration has not been run (button appears but URL is not persisted).
+- The API controllers live in `ErrorRadar::Api::*` to avoid polluting the host
+  app's controller namespace.
+
 ## [0.4.0] - 2026-07-03
 
 ### Added

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ErrorRadar
+  module Api
+    class BaseController < ActionController::Base
+      skip_before_action :verify_authenticity_token
+      before_action :authenticate_api!
+
+      private
+
+      def authenticate_api!
+        token = ErrorRadar.config.api_token
+        return if token.nil?
+
+        provided = request.headers['Authorization'].to_s.delete_prefix('Bearer ').strip
+        render json: { error: 'Unauthorized' }, status: :unauthorized unless provided == token
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module ErrorRadar
+  module Api
+    class ErrorsController < BaseController
+      PER_PAGE = 50
+
+      # GET /api/errors
+      def index
+        scope  = build_scope
+        total  = scope.count
+        page   = [params[:page].to_i, 1].max
+        total_pages = [(total.to_f / PER_PAGE).ceil, 1].max
+        page   = [page, total_pages].min
+
+        errors = scope.limit(PER_PAGE).offset((page - 1) * PER_PAGE)
+
+        render json: {
+          data: errors.map { |e| serialize(e) },
+          meta: { total: total, page: page, per_page: PER_PAGE, total_pages: total_pages }
+        }
+      end
+
+      # GET /api/errors/:id
+      def show
+        log = ErrorLog.find(params[:id])
+        render json: { data: serialize(log, detail: true) }
+      rescue ActiveRecord::RecordNotFound
+        render json: { error: 'Not found' }, status: :not_found
+      end
+
+      # PATCH /api/errors/:id
+      def update
+        log        = ErrorLog.find(params[:id])
+        new_status = params[:status].to_s
+
+        unless ErrorLog.statuses.key?(new_status)
+          return render json: { error: 'invalid status' }, status: :unprocessable_entity
+        end
+
+        if new_status == 'resolved'
+          log.resolve!(by: params[:resolved_by].presence, note: params[:note].presence)
+        else
+          log.update!(status: new_status, resolved_at: nil)
+        end
+
+        render json: { data: serialize(log) }
+      rescue ActiveRecord::RecordNotFound
+        render json: { error: 'Not found' }, status: :not_found
+      end
+
+      private
+
+      def build_scope
+        scope = ErrorLog.all
+        scope = scope.where(status: params[:status])     if params[:status].present?   && ErrorLog.statuses.key?(params[:status])
+        scope = scope.where(severity: params[:severity]) if params[:severity].present? && ErrorLog.severities.key?(params[:severity])
+        scope = scope.where(category: params[:category]) if params[:category].present? && ErrorLog.categories.key?(params[:category])
+
+        if params[:q].present?
+          q = "%#{params[:q].downcase}%"
+          scope = scope.where('lower(message) LIKE :q OR lower(error_class) LIKE :q OR lower(source) LIKE :q', q: q)
+        end
+
+        from = params[:from].present? ? (Date.parse(params[:from]) rescue nil) : nil
+        to   = params[:to].present?   ? (Date.parse(params[:to])   rescue nil) : nil
+        scope = scope.where('last_seen_at >= ?', from) if from
+        scope = scope.where('last_seen_at <= ?', to.end_of_day) if to
+
+        sort = %w[last_seen_at first_seen_at occurrences].include?(params[:sort]) ? params[:sort] : 'last_seen_at'
+        dir  = params[:order] == 'asc' ? :asc : :desc
+        scope.order(sort => dir)
+      end
+
+      def serialize(log, detail: false)
+        data = {
+          id:            log.id,
+          error_class:   log.error_class,
+          source:        log.source,
+          message:       log.message,
+          category:      log.category,
+          severity:      log.severity,
+          status:        log.status,
+          occurrences:   log.occurrences,
+          first_seen_at: log.first_seen_at&.iso8601,
+          last_seen_at:  log.last_seen_at&.iso8601,
+          resolved_at:   log.resolved_at&.iso8601,
+          resolved_by:   log.resolved_by
+        }
+
+        if detail
+          data.merge!(
+            fingerprint:     log.fingerprint,
+            resolution_note: log.resolution_note,
+            http_status:     log.http_status,
+            request_url:     log.request_url,
+            api_code:        log.api_code,
+            api_subcode:     log.api_subcode,
+            context:         log.context,
+            backtrace:       log.backtrace
+          )
+        end
+
+        if log.class.column_names.include?('github_issue_url')
+          data[:github_issue_url] = log.github_issue_url
+        end
+
+        data
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ErrorRadar
+  module Api
+    # GET /api/stats — summary counts for dashboards, CI gates, uptime monitors.
+    class StatsController < BaseController
+      def show
+        render json: {
+          total:       ErrorLog.count,
+          open:        ErrorLog.status_open.count,
+          in_progress: ErrorLog.status_in_progress.count,
+          resolved:    ErrorLog.status_resolved.count,
+          ignored:     ErrorLog.status_ignored.count,
+          unresolved:  ErrorLog.unresolved.count,
+          by_severity: ErrorLog.group(:severity).count,
+          by_category: ErrorLog.group(:category).count,
+          generated_at: Time.current.iso8601
+        }
+      end
+    end
+  end
+end

data/app/controllers/error_radar/errors_controller.rb

@@ -3,7 +3,7 @@
 module ErrorRadar
   class ErrorsController < ApplicationController
     before_action :authenticate_request!
-    before_action :set_error, only: %i[show update_status destroy]
+    before_action :set_error, only: %i[show update_status destroy create_github_issue]
 
     rescue_from ActiveRecord::RecordNotFound do
       redirect_to errors_path, alert: 'Error not found.'
@@ -44,6 +44,35 @@ module ErrorRadar
       render json: { ok: true }
     end
 
+    def create_github_issue
+      unless github_configured?
+        return render json: { ok: false, error: 'GitHub not configured (set config.github_token and config.github_repo)' },
+                      status: :unprocessable_entity
+      end
+
+      if ErrorLog.column_names.include?('github_issue_url') && @error.github_issue_url.present?
+        return render json: { ok: false, error: 'Issue already created', url: @error.github_issue_url },
+                      status: :unprocessable_entity
+      end
+
+      require 'error_radar/integrations/github'
+      result = ErrorRadar::Integrations::Github.create_issue(
+        @error,
+        token: ErrorRadar.config.github_token,
+        repo:  ErrorRadar.config.github_repo
+      )
+
+      if result['html_url']
+        @error.update!(github_issue_url: result['html_url']) if ErrorLog.column_names.include?('github_issue_url')
+        render json: { ok: true, url: result['html_url'], number: result['number'] }
+      else
+        render json: { ok: false, error: result['message'] || 'GitHub API error' },
+               status: :unprocessable_entity
+      end
+    rescue StandardError => e
+      render json: { ok: false, error: e.message }, status: :internal_server_error
+    end
+
     def bulk
       ids = Array(params[:ids]).map(&:to_i).select(&:positive?)
       action = params[:bulk_action].to_s
@@ -115,6 +144,10 @@ module ErrorRadar
       ids.size
     end
 
+    def github_configured?
+      ErrorRadar.config.github_token.present? && ErrorRadar.config.github_repo.present?
+    end
+
     def active_filter_params
       params.permit(:q, :status, :severity, :category, :from, :to, :sort, :order).to_h
     end

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

@@ -104,11 +104,37 @@
   </div>
 </div>
 
+<%# ── GitHub Issue ── %>
+<% if ErrorRadar.config.github_token.present? && ErrorRadar.config.github_repo.present? %>
+  <div class="panel" style="margin-top:16px">
+    <h2>GitHub</h2>
+    <% has_col = @error.class.column_names.include?('github_issue_url') %>
+    <% if has_col && @error.github_issue_url.present? %>
+      <a href="<%= @error.github_issue_url %>" target="_blank" rel="noopener"
+         class="er-btn" style="background:#24292e;display:inline-block;text-decoration:none">
+        &#9651; View GitHub Issue
+      </a>
+    <% else %>
+      <button id="github-btn" class="er-btn" style="background:#24292e" onclick="createGithubIssue()">
+        &#9651; Create GitHub Issue
+      </button>
+      <span id="github-status" style="font-size:13px;color:#6b7280;margin-left:10px"></span>
+      <% unless has_col %>
+        <p style="font-size:12px;color:#9ca3af;margin:10px 0 0">
+          Run <code style="background:#f3f4f6;padding:2px 6px;border-radius:4px">bin/rails generate error_radar:upgrade_v050 &amp;&amp; bin/rails db:migrate</code>
+          to enable issue tracking.
+        </p>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>
+
 <script>
 (function () {
   var CSRF       = document.querySelector('meta[name="csrf-token"]').content;
   var STATUS_URL = '<%= error_status_path(@error) %>';
   var DELETE_URL = '<%= error_path(@error) %>';
+  var GITHUB_URL = '<%= error_github_issue_path(@error) %>';
 
   document.querySelectorAll('.status-btn').forEach(function (btn) {
     btn.addEventListener('click', function () { changeStatus(btn.dataset.status, null); });
@@ -154,6 +180,35 @@
     });
   };
 
+  window.createGithubIssue = function () {
+    var btn    = document.getElementById('github-btn');
+    var status = document.getElementById('github-status');
+    if (!btn) return;
+    btn.disabled    = true;
+    status.textContent = 'Creating issue…';
+
+    fetch(GITHUB_URL, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json', 'X-CSRF-Token': CSRF }
+    })
+    .then(function (r) { return r.json(); })
+    .then(function (d) {
+      if (d.ok) {
+        status.innerHTML = '✓ Created: <a href="' + d.url + '" target="_blank">#' + d.number + '</a>';
+        btn.style.display = 'none';
+        showToast('GitHub issue #' + d.number + ' created', true);
+      } else {
+        status.textContent = 'Error: ' + (d.error || 'failed');
+        btn.disabled = false;
+        showToast(d.error || 'GitHub error', false);
+      }
+    })
+    .catch(function () {
+      status.textContent = 'Network error';
+      btn.disabled = false;
+    });
+  };
+
   function showToast(msg, ok) {
     var t = document.getElementById('toast');
     t.textContent = msg;

data/config/routes.rb

@@ -3,9 +3,17 @@
 ErrorRadar::Engine.routes.draw do
   root to: 'dashboard#index'
 
-  get    'errors',            to: 'errors#index',         as: :errors
-  post   'errors/bulk',       to: 'errors#bulk',          as: :errors_bulk
-  get    'errors/:id',        to: 'errors#show',          as: :error
-  patch  'errors/:id/status', to: 'errors#update_status', as: :error_status
-  delete 'errors/:id',        to: 'errors#destroy'
+  # REST API — JSON endpoints for CI/CD, external dashboards, scripts
+  namespace :api, defaults: { format: :json } do
+    resources :errors, only: %i[index show update]
+    resource  :stats,  only: [:show]
+  end
+
+  # Web UI
+  get    'errors',                  to: 'errors#index',               as: :errors
+  post   'errors/bulk',             to: 'errors#bulk',                as: :errors_bulk
+  post   'errors/:id/github_issue', to: 'errors#create_github_issue', as: :error_github_issue
+  get    'errors/:id',              to: 'errors#show',                as: :error
+  patch  'errors/:id/status',       to: 'errors#update_status',       as: :error_status
+  delete 'errors/:id',              to: 'errors#destroy'
 end

data/lib/error_radar/configuration.rb

@@ -69,6 +69,16 @@ module ErrorRadar
       @error_callbacks << block
     end
 
+    # REST API ────────────────────────────────────────────────────────────────
+    # Bearer token for /api/* endpoints. nil = unauthenticated (not for prod).
+    attr_accessor :api_token
+
+    # GitHub integration ──────────────────────────────────────────────────────
+    # Personal access token with repo scope.
+    attr_accessor :github_token
+    # "owner/repo" string, e.g. "myorg/myapp".
+    attr_accessor :github_repo
+
     # Custom classification rules. Each is a callable `->(exception) { :category | nil }`.
     # The first rule that returns a non-nil category wins; built-in rules run after.
     attr_accessor :categorizers
@@ -124,6 +134,10 @@ module ErrorRadar
       @app_name             = nil
       @app_host             = nil
       @error_callbacks      = []
+
+      @api_token    = nil
+      @github_token = nil
+      @github_repo  = nil
       @categorizers       = []
       @detail_extractors  = []
       @expected_servers   = []

data/lib/error_radar/integrations/github.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module ErrorRadar
+  module Integrations
+    # Creates GitHub issues from ErrorLog records via the GitHub REST API.
+    # Requires a personal access token with the `repo` scope and a repo in
+    # "owner/repo" format.
+    module Github
+      API_BASE = 'https://api.github.com'
+
+      # Returns the parsed JSON response from GitHub.
+      # Raises StandardError on network/API failure.
+      def self.create_issue(error_log, token:, repo:)
+        owner, repo_name = repo.split('/', 2)
+        uri  = URI("#{API_BASE}/repos/#{owner}/#{repo_name}/issues")
+
+        http              = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl      = true
+        http.open_timeout = 10
+        http.read_timeout = 10
+
+        req = Net::HTTP::Post.new(uri)
+        req['Authorization']        = "Bearer #{token}"
+        req['Content-Type']         = 'application/json'
+        req['Accept']               = 'application/vnd.github+json'
+        req['X-GitHub-Api-Version'] = '2022-11-28'
+        req.body = {
+          title:  issue_title(error_log),
+          body:   issue_body(error_log),
+          labels: ['bug', 'error-radar']
+        }.to_json
+
+        response = http.request(req)
+        JSON.parse(response.body)
+      end
+
+      def self.issue_title(log)
+        short_msg = log.message.to_s.truncate(80).gsub(/\n/, ' ')
+        "[Error Radar] #{log.error_class}: #{short_msg}"
+      end
+
+      def self.issue_body(log)
+        url       = ErrorRadar::Notifier.error_url(log)
+        backtrace = log.backtrace.to_s.split("\n").first(20).join("\n")
+
+        parts = []
+        parts << "## Error Details\n"
+        parts << "| Field | Value |"
+        parts << "|-------|-------|"
+        parts << "| **Error Class** | `#{log.error_class}` |"
+        parts << "| **Source** | #{log.source || 'unknown'} |"
+        parts << "| **Category** | #{log.category} |"
+        parts << "| **Severity** | #{log.severity} |"
+        parts << "| **Occurrences** | #{log.occurrences} |"
+        parts << "| **First seen** | #{log.first_seen_at&.strftime('%Y-%m-%d %H:%M UTC')} |"
+        parts << "| **Last seen** | #{log.last_seen_at&.strftime('%Y-%m-%d %H:%M UTC')} |"
+        parts << "\n## Message\n\n```\n#{log.message.to_s.truncate(1000)}\n```"
+
+        unless backtrace.empty?
+          parts << "\n## Backtrace\n\n```\n#{backtrace}\n```"
+        end
+
+        parts << "\n## Link\n\n[View in Error Radar](#{url})" if url
+
+        parts << "\n---\n*Created automatically by [Error Radar](https://github.com/chienbn9x/error_radar)*"
+        parts.join("\n")
+      end
+    end
+  end
+end

data/lib/error_radar/version.rb

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

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

@@ -72,6 +72,17 @@ ErrorRadar.configure do |config|
   # config.expected_servers = [
   #   { key: 'web', name: 'Web', tag: 'sidekiq_web', host: 'web', queue_hint: 'low' }
   # ]
+
+  # --- REST API ---
+  # Protect /api/* endpoints with a Bearer token.
+  # config.api_token = ENV['ERROR_RADAR_API_TOKEN']
+  # curl -H "Authorization: Bearer $TOKEN" https://myapp.com/error_radar/api/stats
+
+  # --- GitHub Integration ---
+  # Creates GitHub issues directly from the error detail page.
+  # Requires running: bin/rails generate error_radar:upgrade_v050 && bin/rails db:migrate
+  # config.github_token = ENV['GITHUB_TOKEN']   # PAT with repo scope
+  # config.github_repo  = 'myorg/myapp'         # "owner/repo" format
 end
 
 # ActiveJob is now captured automatically via install_active_job = true above.

data/lib/generators/error_radar/upgrade_v050/templates/add_github_issue_to_error_radar_error_logs.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddGithubIssueToErrorRadarErrorLogs < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :error_radar_error_logs, :github_issue_url, :string, limit: 500
+  end
+end

data/lib/generators/error_radar/upgrade_v050/upgrade_v050_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module ErrorRadar
+  module Generators
+    class UpgradeV050Generator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Generates the migration for Error Radar v0.5.0 (adds github_issue_url column).'
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def create_migration_file
+        migration_template(
+          'add_github_issue_to_error_radar_error_logs.rb.tt',
+          'db/migrate/add_github_issue_to_error_radar_error_logs.rb'
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_radar
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - chienbn9x
@@ -57,6 +57,9 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/error_radar/api/base_controller.rb
+- app/controllers/error_radar/api/errors_controller.rb
+- app/controllers/error_radar/api/stats_controller.rb
 - app/controllers/error_radar/application_controller.rb
 - app/controllers/error_radar/dashboard_controller.rb
 - app/controllers/error_radar/errors_controller.rb
@@ -75,6 +78,7 @@ files:
 - lib/error_radar/configuration.rb
 - lib/error_radar/engine.rb
 - lib/error_radar/integrations/active_job.rb
+- lib/error_radar/integrations/github.rb
 - lib/error_radar/integrations/rails_admin.rb
 - lib/error_radar/integrations/rake.rb
 - lib/error_radar/integrations/sidekiq.rb
@@ -90,6 +94,8 @@ files:
 - 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
+- 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
 homepage: https://github.com/chienbn9x/error_radar
 licenses:
 - MIT