rails_error_dashboard 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e514a83af22b8b3938befb45429a46617ee0f547a6831d98cdb44e435f3e3a1c
-  data.tar.gz: 8329f6c148cfdd9c2d5fb9cd87e89e77f93c7a45beb55ec278218bb5f12e2dde
+  metadata.gz: af41ac0baefaf436b68c2db7ac1598a15f409cb76efbbf2eb8fb2daa9ceaab92
+  data.tar.gz: 22073a8675b855c06622dc34ae649608af129f57f5c391c9562c20bd95db53ec
 SHA512:
-  metadata.gz: 8bfe23263da657c250f8c982ec9271e1ad6158f28041db817a3fc9ee529a0dbdadc8045f30f7633a771265ae0592cc2e0903af215b63f447f449ed0dc478039c
-  data.tar.gz: 889dac2f878d6d31afa91c4efbd20be4432452046bcb5a1071f507e23b41d7b5bcdb07ae67468bf3f678917084dc5149492fa01733276918fc52c4daf6f0a766
+  metadata.gz: badaacf9fb78a5d93ee3d545d93877cc59c8685f8800567ad6f84979cec365baebd3f3193b905bbf73b67f99c70308c2480043bfb78c38f0a1b149637f1595c4
+  data.tar.gz: 548db884ddfcb084293083c3e8b787bdc50d0fd2128b8f68bdc315f578199ce9c36ef805a038657d437864055ee45e9f5bfc41ef6386be6e5b3c750be40ed238

data/README.md

@@ -116,7 +116,7 @@ Requires breadcrumbs to be enabled.
 </details>
 
 <details>
-<summary><strong>Operational Health Panels — Jobs, Database, Cache</strong></summary>
+<summary><strong>Operational Health Panels — Jobs, Database, Cache, ActionCable</strong></summary>
 
 **Job Health** — Auto-detects Sidekiq, SolidQueue, or GoodJob. Per-error table with adapter badge, failed count (color-coded), sorted worst-first.
 
@@ -130,6 +130,12 @@ Requires breadcrumbs to be enabled.
 
 ![Cache Health](docs/images/cache-health.png)
 
+**ActionCable Health** — Track WebSocket channel actions, transmissions, subscription confirmations, and rejections. Dashboard page at `/errors/actioncable_health_summary` with channel breakdown sorted by rejections. System health snapshot captures live connection count and adapter. No error tracker surfaces this alongside HTTP errors.
+
+```ruby
+config.enable_actioncable_tracking = true  # requires enable_breadcrumbs = true
+```
+
 [Complete documentation →](docs/FEATURES.md#job-health-page)
 </details>
 

data/app/controllers/rails_error_dashboard/errors_controller.rb

@@ -409,6 +409,27 @@ module RailsErrorDashboard
       @pagy, @events = pagy(:offset, all_events, limit: params[:per_page] || 25)
     end
 
+    def actioncable_health_summary
+      unless RailsErrorDashboard.configuration.enable_actioncable_tracking &&
+             RailsErrorDashboard.configuration.enable_breadcrumbs
+        flash[:alert] = "ActionCable tracking is not enabled. Enable enable_actioncable_tracking and enable_breadcrumbs in config/initializers/rails_error_dashboard.rb"
+        redirect_to errors_path
+        return
+      end
+
+      days = (params[:days] || 30).to_i
+      @days = days
+      result = Queries::ActionCableSummary.call(days, application_id: @current_application_id)
+      all_channels = result[:channels]
+
+      # Summary stats (computed before pagination)
+      @unique_channels = all_channels.size
+      @total_events = all_channels.sum { |c| c[:total_events] }
+      @total_rejections = all_channels.sum { |c| c[:rejection_count] }
+
+      @pagy, @channels = pagy(:offset, all_channels, limit: params[:per_page] || 25)
+    end
+
     def diagnostic_dumps
       unless RailsErrorDashboard.configuration.enable_diagnostic_dump
         flash[:alert] = "Diagnostic dumps are not enabled. Enable them in config/initializers/rails_error_dashboard.rb"

data/app/views/rails_error_dashboard/errors/actioncable_health_summary.html.erb

@@ -0,0 +1,132 @@
+<% content_for :page_title, "ActionCable Health" %>
+
+<div class="container-fluid py-4">
+  <div class="d-flex justify-content-between align-items-center mb-4">
+    <h1 class="h3 mb-0">
+      <i class="bi bi-broadcast me-2"></i>
+      ActionCable Health
+    </h1>
+
+    <div class="btn-group" role="group">
+      <%= link_to actioncable_health_summary_errors_path(days: 7), class: "btn btn-sm #{@days == 7 ? 'btn-primary' : 'btn-outline-primary'}" do %>
+        7 Days
+      <% end %>
+      <%= link_to actioncable_health_summary_errors_path(days: 30), class: "btn btn-sm #{@days == 30 ? 'btn-primary' : 'btn-outline-primary'}" do %>
+        30 Days
+      <% end %>
+      <%= link_to actioncable_health_summary_errors_path(days: 90), class: "btn btn-sm #{@days == 90 ? 'btn-primary' : 'btn-outline-primary'}" do %>
+        90 Days
+      <% end %>
+    </div>
+  </div>
+
+  <% if @unique_channels == 0 %>
+    <div class="text-center py-5">
+      <i class="bi bi-broadcast display-1 text-success mb-3"></i>
+      <h4 class="text-muted">No ActionCable Events Found</h4>
+      <p class="text-muted">
+        No ActionCable channel actions, transmissions, or subscription events were detected in error breadcrumbs over the last <%= @days %> days.
+      </p>
+      <div class="card mx-auto" style="max-width: 500px;">
+        <div class="card-body text-start">
+          <h6>How ActionCable tracking works:</h6>
+          <ul class="mb-0">
+            <li>Breadcrumbs must be enabled (<code>enable_breadcrumbs = true</code>)</li>
+            <li>ActionCable tracking must be enabled (<code>enable_actioncable_tracking = true</code>)</li>
+            <li>ActionCable must be configured in your app</li>
+            <li>Channel actions, transmissions, and subscription events are captured as breadcrumbs during requests that produce errors</li>
+          </ul>
+        </div>
+      </div>
+    </div>
+  <% else %>
+    <div class="row mb-4">
+      <div class="col-md-4">
+        <div class="card text-center">
+          <div class="card-body">
+            <div class="display-6 text-primary"><%= @unique_channels %></div>
+            <small class="text-muted">Active Channels</small>
+          </div>
+        </div>
+      </div>
+      <div class="col-md-4">
+        <div class="card text-center">
+          <div class="card-body">
+            <div class="display-6 text-info"><%= @total_events %></div>
+            <small class="text-muted">Total Events</small>
+          </div>
+        </div>
+      </div>
+      <div class="col-md-4">
+        <div class="card text-center">
+          <div class="card-body">
+            <div class="display-6 <%= @total_rejections > 0 ? 'text-danger' : 'text-success' %>"><%= @total_rejections %></div>
+            <small class="text-muted">Subscription Rejections</small>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <div class="card mb-4">
+      <div class="card-header bg-white d-flex justify-content-between align-items-center">
+        <h5 class="mb-0">
+          <i class="bi bi-broadcast text-primary me-2"></i>
+          ActionCable Events by Channel
+          <span class="badge bg-primary"><%= @unique_channels %></span>
+        </h5>
+        <small class="text-muted"><%== @pagy.info_tag %></small>
+      </div>
+      <div class="card-body p-0">
+        <div class="table-responsive">
+          <table class="table table-hover mb-0">
+            <thead class="table-light">
+              <tr>
+                <th>Channel</th>
+                <th width="100">Actions</th>
+                <th width="120">Transmissions</th>
+                <th width="120">Subscriptions</th>
+                <th width="100">Rejections</th>
+                <th width="80">Errors</th>
+                <th width="140">Last Seen</th>
+              </tr>
+            </thead>
+            <tbody>
+              <% @channels.each do |channel| %>
+                <tr>
+                  <td><code><%= channel[:channel] %></code></td>
+                  <td><%= channel[:perform_count] %></td>
+                  <td><%= channel[:transmit_count] %></td>
+                  <td><span class="text-success"><%= channel[:subscription_count] %></span></td>
+                  <td>
+                    <% if channel[:rejection_count] > 0 %>
+                      <span class="badge bg-danger"><%= channel[:rejection_count] %></span>
+                    <% else %>
+                      <span class="text-muted">0</span>
+                    <% end %>
+                  </td>
+                  <td><%= channel[:error_count] %></td>
+                  <td><%= local_time_ago(channel[:last_seen]) %></td>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="card-footer bg-white border-top d-flex justify-content-between align-items-center">
+        <div>
+          <small class="text-muted">
+            <i class="bi bi-lightbulb text-warning"></i> ActionCable events are captured when they coincide with errors. High rejection counts may indicate authentication or authorization issues.
+          </small>
+          <small class="ms-3">
+            <a href="https://guides.rubyonrails.org/action_cable_overview.html" target="_blank" rel="noopener" class="text-decoration-none">
+              <i class="bi bi-book"></i> ActionCable Guide <i class="bi bi-box-arrow-up-right" style="font-size: 0.7em;"></i>
+            </a>
+          </small>
+        </div>
+        <div>
+          <%== @pagy.series_nav(:bootstrap) if @pagy.pages > 1 %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+</div>

data/config/routes.rb

@@ -31,6 +31,7 @@ RailsErrorDashboard::Engine.routes.draw do
       get :database_health_summary
       get :swallowed_exceptions
       get :rack_attack_summary
+      get :actioncable_health_summary
       get :diagnostic_dumps
       post :create_diagnostic_dump
       post :batch_action

data/lib/rails_error_dashboard/configuration.rb

@@ -158,6 +158,9 @@ module RailsErrorDashboard
     # Rack Attack event tracking (requires enable_breadcrumbs = true)
     attr_accessor :enable_rack_attack_tracking          # Master switch (default: false)
 
+    # ActionCable event tracking (requires enable_breadcrumbs = true)
+    attr_accessor :enable_actioncable_tracking          # Master switch (default: false)
+
     # Notification callbacks (managed via helper methods, not set directly)
     attr_reader :notification_callbacks
 
@@ -300,6 +303,9 @@ module RailsErrorDashboard
       # Rack Attack event tracking defaults - OFF by default (opt-in, requires breadcrumbs)
       @enable_rack_attack_tracking = false
 
+      # ActionCable event tracking defaults - OFF by default (opt-in, requires breadcrumbs)
+      @enable_actioncable_tracking = false
+
       # Internal logging defaults - SILENT by default
       @enable_internal_logging = false  # Opt-in for debugging
       @log_level = :silent  # Silent by default, use :debug, :info, :warn, :error, or :silent
@@ -440,6 +446,13 @@ module RailsErrorDashboard
         @enable_rack_attack_tracking = false
       end
 
+      # Validate actioncable tracking requires breadcrumbs
+      if enable_actioncable_tracking && !enable_breadcrumbs
+        warnings << "enable_actioncable_tracking requires enable_breadcrumbs = true. " \
+                    "ActionCable tracking has been auto-disabled."
+        @enable_actioncable_tracking = false
+      end
+
       # Validate crash capture path (must exist if custom path specified)
       if enable_crash_capture && crash_capture_path
         unless Dir.exist?(crash_capture_path)

data/lib/rails_error_dashboard/engine.rb

@@ -77,6 +77,13 @@ module RailsErrorDashboard
         RailsErrorDashboard::Subscribers::RackAttackSubscriber.subscribe!
       end
 
+      # Subscribe to ActionCable AS::Notifications events (requires breadcrumbs + ActionCable)
+      if RailsErrorDashboard.configuration.enable_actioncable_tracking &&
+         RailsErrorDashboard.configuration.enable_breadcrumbs &&
+         defined?(ActionCable)
+        RailsErrorDashboard::Subscribers::ActionCableSubscriber.subscribe!
+      end
+
       # Enable TracePoint(:raise) for local variable and/or instance variable capture
       if RailsErrorDashboard.configuration.enable_local_variables ||
          RailsErrorDashboard.configuration.enable_instance_variables

data/lib/rails_error_dashboard/queries/action_cable_summary.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module RailsErrorDashboard
+  module Queries
+    # Query: Aggregate ActionCable events from breadcrumbs across all errors
+    # Scans error_logs breadcrumbs JSON, filters for "action_cable" category crumbs,
+    # and groups by channel name with counts by event type.
+    class ActionCableSummary
+      def self.call(days = 30, application_id: nil)
+        new(days, application_id: application_id).call
+      end
+
+      def initialize(days = 30, application_id: nil)
+        @days = days
+        @application_id = application_id
+        @start_date = days.days.ago
+      end
+
+      def call
+        {
+          channels: aggregated_channels
+        }
+      end
+
+      private
+
+      def base_query
+        scope = ErrorLog.where("occurred_at >= ?", @start_date)
+                        .where.not(breadcrumbs: nil)
+        scope = scope.where(application_id: @application_id) if @application_id.present?
+        scope
+      end
+
+      def aggregated_channels
+        results = {}
+
+        base_query.select(:id, :breadcrumbs, :occurred_at).find_each(batch_size: 500) do |error_log|
+          crumbs = parse_breadcrumbs(error_log.breadcrumbs)
+          next if crumbs.empty?
+
+          ac_crumbs = crumbs.select { |c| c["c"] == "action_cable" }
+          next if ac_crumbs.empty?
+
+          ac_crumbs.each do |crumb|
+            meta = crumb["meta"] || {}
+            channel = meta["channel"].to_s.presence || "Unknown"
+            event_type = meta["event_type"].to_s
+
+            results[channel] ||= {
+              channel: channel,
+              perform_count: 0,
+              transmit_count: 0,
+              subscription_count: 0,
+              rejection_count: 0,
+              error_ids: [],
+              last_seen: nil
+            }
+
+            entry = results[channel]
+
+            case event_type
+            when "perform_action"
+              entry[:perform_count] += 1
+            when "transmit"
+              entry[:transmit_count] += 1
+            when "transmit_subscription_confirmation"
+              entry[:subscription_count] += 1
+            when "transmit_subscription_rejection"
+              entry[:rejection_count] += 1
+            end
+
+            entry[:error_ids] << error_log.id
+            entry[:last_seen] = [ entry[:last_seen], error_log.occurred_at ].compact.max
+          end
+        end
+
+        results.values.each do |r|
+          r[:error_ids] = r[:error_ids].uniq
+          r[:error_count] = r[:error_ids].size
+          r[:total_events] = r[:perform_count] + r[:transmit_count] + r[:subscription_count] + r[:rejection_count]
+        end
+        results.values.sort_by { |r| [ -r[:rejection_count], -r[:total_events] ] }
+      rescue => e
+        Rails.logger.error("[RailsErrorDashboard] ActionCableSummary query failed: #{e.class}: #{e.message}")
+        []
+      end
+
+      def parse_breadcrumbs(raw)
+        return [] if raw.blank?
+        JSON.parse(raw)
+      rescue JSON::ParserError
+        []
+      end
+    end
+  end
+end

data/lib/rails_error_dashboard/services/system_health_snapshot.rb

@@ -36,6 +36,7 @@ module RailsErrorDashboard
           job_queue: job_queue_stats,
           ruby_vm: ruby_vm_stats,
           yjit: yjit_stats,
+          actioncable: actioncable_stats,
           captured_at: Time.current.iso8601
         }
       end
@@ -154,6 +155,18 @@ module RailsErrorDashboard
         nil
       end
 
+      # ActionCable connection stats — read-only, <0.1ms
+      def actioncable_stats
+        return nil unless defined?(ActionCable) && defined?(ActionCable::Server)
+        server = ActionCable.server
+        {
+          connections: server.connections.count,
+          adapter: server.pubsub&.class&.name&.demodulize
+        }
+      rescue => e
+        nil
+      end
+
       # RubyVM::YJIT.runtime_stats — JIT compilation health
       # Cherry-picks diagnostic keys (full hash has 30+ entries)
       def yjit_stats

data/lib/rails_error_dashboard/subscribers/action_cable_subscriber.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module RailsErrorDashboard
+  module Subscribers
+    # Registers ActiveSupport::Notifications subscribers for ActionCable events.
+    #
+    # ActionCable emits:
+    # - perform_action.action_cable          — channel action executed
+    # - transmit.action_cable                — data transmitted to subscriber
+    # - transmit_subscription_confirmation.action_cable — subscription confirmed
+    # - transmit_subscription_rejection.action_cable    — subscription rejected
+    #
+    # Each event is captured as a breadcrumb with category "action_cable",
+    # allowing correlation between WebSocket events and error spikes.
+    #
+    # SAFETY RULES (HOST_APP_SAFETY.md):
+    # - Every subscriber wrapped in rescue => e; nil
+    # - Never raise from subscriber callbacks
+    # - Skip if buffer is nil (not in a request context)
+    class ActionCableSubscriber
+      EVENTS = %w[
+        perform_action.action_cable
+        transmit.action_cable
+        transmit_subscription_confirmation.action_cable
+        transmit_subscription_rejection.action_cable
+      ].freeze
+
+      # Event subscriptions managed by this class
+      @subscriptions = []
+
+      class << self
+        attr_reader :subscriptions
+
+        # Register all ActionCable event subscribers
+        # @return [Array] Array of subscription objects
+        def subscribe!
+          @subscriptions = []
+
+          EVENTS.each do |event_name|
+            @subscriptions << subscribe_event(event_name)
+          end
+
+          @subscriptions
+        end
+
+        # Remove all ActionCable subscribers
+        def unsubscribe!
+          @subscriptions.each do |sub|
+            ActiveSupport::Notifications.unsubscribe(sub) if sub
+          rescue => e
+            nil
+          end
+          @subscriptions = []
+        end
+
+        private
+
+        def subscribe_event(event_name)
+          ActiveSupport::Notifications.subscribe(event_name) do |*args|
+            event = ActiveSupport::Notifications::Event.new(*args)
+            handle_action_cable(event, event_name)
+          rescue => e
+            nil
+          end
+        end
+
+        def handle_action_cable(event, event_name)
+          return unless Services::BreadcrumbCollector.current_buffer
+
+          payload = event.payload || {}
+          channel = payload[:channel_class] || payload[:channel] || "Unknown"
+          channel = channel.to_s
+
+          event_type = event_name.split(".").first # "perform_action", "transmit", etc.
+          action = payload[:action].to_s
+
+          message = build_message(event_type, channel, action)
+
+          metadata = {
+            channel: channel,
+            event_type: event_type
+          }
+          metadata[:action] = action if action.present?
+
+          duration_ms = event.duration if event.respond_to?(:duration)
+
+          Services::BreadcrumbCollector.add("action_cable", message, duration_ms: duration_ms, metadata: metadata)
+        end
+
+        def build_message(event_type, channel, action)
+          case event_type
+          when "perform_action"
+            action.present? ? "perform: #{channel}##{action}" : "perform: #{channel}"
+          when "transmit"
+            "transmit: #{channel}"
+          when "transmit_subscription_confirmation"
+            "subscribed: #{channel}"
+          when "transmit_subscription_rejection"
+            "rejected: #{channel}"
+          else
+            "#{event_type}: #{channel}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_error_dashboard/version.rb

@@ -1,3 +1,3 @@
 module RailsErrorDashboard
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/rails_error_dashboard.rb

@@ -64,7 +64,9 @@ require "rails_error_dashboard/services/crash_capture"
 require "rails_error_dashboard/services/diagnostic_dump_generator"
 require "rails_error_dashboard/subscribers/breadcrumb_subscriber"
 require "rails_error_dashboard/subscribers/rack_attack_subscriber"
+require "rails_error_dashboard/subscribers/action_cable_subscriber"
 require "rails_error_dashboard/queries/co_occurring_errors"
+require "rails_error_dashboard/queries/action_cable_summary"
 require "rails_error_dashboard/queries/error_cascades"
 require "rails_error_dashboard/queries/baseline_stats"
 require "rails_error_dashboard/queries/platform_comparison"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_error_dashboard
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Anjan Jagirdar
@@ -290,6 +290,7 @@ files:
 - app/views/rails_error_dashboard/errors/_stats.html.erb
 - app/views/rails_error_dashboard/errors/_timeline.html.erb
 - app/views/rails_error_dashboard/errors/_user_errors_table.html.erb
+- app/views/rails_error_dashboard/errors/actioncable_health_summary.html.erb
 - app/views/rails_error_dashboard/errors/analytics.html.erb
 - app/views/rails_error_dashboard/errors/cache_health_summary.html.erb
 - app/views/rails_error_dashboard/errors/correlation.html.erb
@@ -382,6 +383,7 @@ files:
 - lib/rails_error_dashboard/plugins/audit_log_plugin.rb
 - lib/rails_error_dashboard/plugins/jira_integration_plugin.rb
 - lib/rails_error_dashboard/plugins/metrics_plugin.rb
+- lib/rails_error_dashboard/queries/action_cable_summary.rb
 - lib/rails_error_dashboard/queries/analytics_stats.rb
 - lib/rails_error_dashboard/queries/baseline_stats.rb
 - lib/rails_error_dashboard/queries/cache_health_summary.rb
@@ -445,6 +447,7 @@ files:
 - lib/rails_error_dashboard/services/system_health_snapshot.rb
 - lib/rails_error_dashboard/services/variable_serializer.rb
 - lib/rails_error_dashboard/services/webhook_payload_builder.rb
+- lib/rails_error_dashboard/subscribers/action_cable_subscriber.rb
 - lib/rails_error_dashboard/subscribers/breadcrumb_subscriber.rb
 - lib/rails_error_dashboard/subscribers/rack_attack_subscriber.rb
 - lib/rails_error_dashboard/value_objects/error_context.rb
@@ -462,7 +465,7 @@ metadata:
   bug_tracker_uri: https://github.com/AnjanJ/rails_error_dashboard/issues
   funding_uri: https://buymeacoffee.com/anjanj
 post_install_message: "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n
-  \ Rails Error Dashboard v0.4.2\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\U0001F195
+  \ Rails Error Dashboard v0.5.0\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\U0001F195
   First time? Quick start:\n   rails generate rails_error_dashboard:install\n   rails
   db:migrate\n   # Add to config/routes.rb:\n   mount RailsErrorDashboard::Engine
   => '/error_dashboard'\n\n\U0001F504 Upgrading from v0.1.x?\n   rails db:migrate\n