solid_observer 0.3.0 → 0.5.0

data/app/views/solid_observer/cache_operations/_confirm_clear.html.erb

@@ -0,0 +1,6 @@
+<%= button_to "Clear cache",
+      clear_cache_operations_path,
+      method: :post,
+      class: "so-btn so-btn--danger",
+      form: {class: "so-form--inline"},
+      data: {confirm: SolidObserver::Services::CacheOperations.message(:clear, :confirmation)} %>

data/app/views/solid_observer/cache_operations/index.html.erb

@@ -0,0 +1,60 @@
+<% content_for :title, "Cache controls" %>
+<% cache_operations = SolidObserver::Services::CacheOperations %>
+<% status_class = @cache_controls_available ? "so-badge--success" : "so-badge--warning" %>
+
+<div class="so-dashboard so-cache-controls">
+  <div class="so-content__header">
+    <h1>Cache controls</h1>
+    <div class="so-cache-controls__intro">
+      <span class="so-badge so-badge--pill <%= status_class %>">
+        <svg class="so-badge__dot" viewBox="0 0 6 6" aria-hidden="true">
+          <circle r="3" cx="3" cy="3" />
+        </svg>
+        <%= @cache_controls_available ? "Available" : "Unavailable" %>
+      </span>
+      <p class="so-cache-controls__hint">Clear or prune SolidCache safely. Cache keys and values are never shown.</p>
+    </div>
+  </div>
+
+  <% if @cache_controls_available %>
+    <section class="so-card so-card--section" aria-labelledby="so-cache-controls-title">
+      <header class="so-dashboard-section__header">
+        <h2 id="so-cache-controls-title" class="so-dashboard-section__title">Operational controls</h2>
+      </header>
+
+      <div class="so-cache-control-row">
+        <div class="so-cache-control-row__copy">
+          <h3 class="so-cache-control-row__title">Prune expired entries</h3>
+          <p class="so-cache-control-row__body">Removes expired SolidCache records only. Active cache entries remain eligible for hits.</p>
+        </div>
+
+        <div class="so-cache-control-row__action">
+          <%= button_to "Prune expired entries",
+                prune_cache_operations_path,
+                method: :post,
+                class: "so-btn",
+                form: {class: "so-form--inline"} %>
+        </div>
+      </div>
+
+      <div class="so-cache-control-row">
+        <div class="so-cache-control-row__copy">
+          <h3 class="so-cache-control-row__title">Clear all cache</h3>
+          <p class="so-cache-control-row__body">Evicts all cached application data. Requests may slow while the cache rebuilds.</p>
+        </div>
+
+        <div class="so-cache-control-row__action">
+          <%= render "confirm_clear" %>
+        </div>
+      </div>
+    </section>
+  <% else %>
+    <section class="so-card so-card--section" aria-labelledby="so-cache-controls-unavailable-title">
+      <header class="so-dashboard-section__header">
+        <h2 id="so-cache-controls-unavailable-title" class="so-dashboard-section__title">Operational controls</h2>
+      </header>
+
+      <p class="so-dashboard-section__meta so-dashboard-section__meta--idle"><%= cache_operations.unavailable_message %></p>
+    </section>
+  <% end %>
+</div>

data/app/views/solid_observer/dashboard/_queue_table.html.erb

@@ -8,6 +8,7 @@
     <% all_queue_names = (queues.keys | performed_by_queue.keys | failed_by_queue.keys).sort %>
     <% if all_queue_names.any? %>
       <table class="so-table so-table--card">
+        <caption class="sr-only">Queue throughput list</caption>
         <thead>
           <tr>
             <th>Queue</th>

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

@@ -1,18 +1,43 @@
 <% content_for :title, "Dashboard" %>
 
 <div class="so-dashboard">
+  <% queue_enabled = SolidObserver.config.solid_queue_enabled? %>
+  <% queue_status_class = queue_enabled ? "so-badge--success" : "so-badge--warning" %>
+
+  <div class="so-content__header">
+    <h1>Queue overview</h1>
+    <div class="so-queue-overview__intro">
+      <span class="so-badge so-badge--pill <%= queue_status_class %>">
+        <svg class="so-badge__dot" viewBox="0 0 6 6" aria-hidden="true">
+          <circle r="3" cx="3" cy="3" />
+        </svg>
+        <%= queue_enabled ? "Available" : "Unavailable" %>
+      </span>
+      <% if queue_enabled %>
+        <p class="so-queue-overview__hint">Selected range: <%= range_label(@range) %></p>
+      <% end %>
+    </div>
+  </div>
+
+  <% if !queue_enabled %>
+    <section class="so-card so-card--section" aria-labelledby="so-queue-unavailable-heading">
+      <h2 id="so-queue-unavailable-heading">Queue Unavailable</h2>
+      <p class="so-dashboard-section__meta so-dashboard-section__meta--idle">Queue component is disabled or not installed. Enable SolidQueue to access dashboard controls.</p>
+    </section>
+  <% else %>
   <%# Zone A: Toolbar — range selector, Refresh, Live toggle, help disclosure %>
-  <div class="so-dashboard-toolbar" data-so-live>
-    <div class="so-dashboard-toolbar__left">
+  <div class="so-dashboard-toolbar" data-so-live data-so-poll-url="<%= poll_data_path %>">
+    <form action="<%= request.path %>" method="get" class="so-dashboard-toolbar__left">
       <label for="so-range" class="so-card__label so-filters__label">Range</label>
-      <select id="so-range" name="range" data-so-range-select>
+      <select id="so-range" name="range" data-so-range-select onchange="this.form.submit()">
         <% SolidObserver::QueueStats::RANGES.each_key do |key| %>
           <option value="<%= key %>" <%= "selected" if key == @range %>><%= key %></option>
         <% end %>
       </select>
       <button type="button" class="so-btn so-btn--refresh" data-so-refresh aria-busy="false">Refresh data</button>
       <span class="so-toolbar-freshness" data-so-freshness aria-live="polite"></span>
-    </div>
+      <input type="hidden" name="live" value="<%= @live ? 'on' : '' %>">
+    </form>
     <div class="so-dashboard-toolbar__right">
       <label class="so-toggle so-toggle--pill <%= "so-toggle--on" if @live %>">
         <input type="checkbox" name="live" value="on" <%= "checked" if @live %> data-so-live-toggle>
@@ -83,6 +108,7 @@
       <div class="so-card">
         <div class="so-card__label">Recent Events</div>
         <table class="so-table so-table--card">
+          <caption class="sr-only">Recent queue events</caption>
           <thead>
             <tr>
               <th>Event</th>
@@ -110,4 +136,5 @@
       </div>
     <% end %>
   <% end %>
-</div>
+  <% end %>
+</div>

data/app/views/solid_observer/events/index.html.erb

@@ -25,6 +25,7 @@
 
 <% if @events.any? %>
   <table class="so-table so-table--listing">
+    <caption class="sr-only">Events list</caption>
     <thead>
       <tr>
         <th>Event</th>

data/app/views/solid_observer/jobs/index.html.erb

@@ -20,6 +20,7 @@
 
 <% if @jobs.any? %>
   <table class="so-table so-table--listing">
+    <caption class="sr-only">Jobs list</caption>
     <thead>
       <tr>
         <th>ID</th>

data/app/views/solid_observer/jobs/show.html.erb

@@ -52,16 +52,16 @@
       <tbody>
         <tr>
           <td>Error Class</td>
-          <td><code><%= @execution.error.exception_class %></code></td>
+          <td><code><%= @execution.error["exception_class"] %></code></td>
         </tr>
         <tr>
           <td>Message</td>
-          <td><%= @execution.error.message %></td>
+          <td><%= @execution.error["message"] %></td>
         </tr>
       </tbody>
     </table>
     <div class="so-card__label">Backtrace</div>
-    <pre class="so-pre so-pre--error"><code><%= @execution.error.backtrace&.first(20)&.join("\n") || "No backtrace available" %></code></pre>
+    <pre class="so-pre so-pre--error"><code><%= @execution.error["backtrace"]&.first(20)&.join("\n") || "No backtrace available" %></code></pre>
   </div>
 
   <div class="so-actions">

data/app/views/solid_observer/storages/show.html.erb

@@ -1,39 +1,97 @@
 <% content_for :title, "Storage" %>
 
-<div class="so-content__header">
-  <h1>Storage</h1>
-</div>
-
-<% if @current_storage %>
-  <div class="so-stat-cards">
-    <%= render "solid_observer/shared/stat_card", label: "Database Size", value: number_to_human_size(@current_storage.db_size_bytes, precision: 1, significant: false, strip_insignificant_zeros: false) %>
-    <%= render "solid_observer/shared/stat_card", label: "Event Count", value: number_with_delimiter(@current_storage.event_count) %>
-    <%= render "solid_observer/shared/stat_card", label: "Last Updated", value: time_ago_in_words(@current_storage.recorded_at) + " ago" %>
+<div class="so-dashboard">
+  <div class="so-content__header">
+    <h1>Storage</h1>
   </div>
 
-  <% if @storage_history.any? %>
-    <div class="so-card so-card--section">
-      <div class="so-card__label">Recent Snapshots</div>
-      <table class="so-table so-table--card">
-        <thead>
-          <tr>
-            <th>Time</th>
-            <th>Size</th>
-            <th>Events</th>
-          </tr>
-        </thead>
-        <tbody>
-          <% @storage_history.each do |snapshot| %>
+  <% if @storage_components.any? %>
+    <section class="so-dashboard-section" aria-labelledby="component-health-title">
+      <header class="so-dashboard-section__header">
+        <h2 id="component-health-title" class="so-dashboard-section__title">Component health</h2>
+      </header>
+
+      <div class="so-stat-cards">
+        <% @storage_components.each do |component| %>
+        <% status_class = component[:available] ? "so-badge--success" : "so-badge--warning" %>
+        <% size_value = component[:available] && component[:db_size_bytes] ? number_to_human_size(component[:db_size_bytes], precision: 1, significant: false, strip_insignificant_zeros: false) : "—" %>
+        <% records_value = component[:available] && !component[:event_count].nil? ? number_with_delimiter(component[:event_count]) : "—" %>
+
+          <article class="so-card">
+            <div class="so-card__label"><%= component[:label] %></div>
+            <div class="so-card__subtitle">
+              <span class="so-badge so-badge--pill <%= status_class %>">
+                <svg class="so-badge__dot" viewBox="0 0 6 6" aria-hidden="true"><circle r="3" cx="3" cy="3"/></svg>
+                <%= component[:available] ? "Available" : "Unavailable" %>
+              </span>
+            </div>
+            <div class="so-card__value"><%= size_value %></div>
+            <div class="so-card__subtitle">
+              <% if component[:available] %>
+                <% if component[:component] == "solid_cable" %>
+                  <% parts = ["#{records_value} #{component[:record_label]}"] %>
+                  <% parts << "#{number_with_delimiter(component[:trimmable_count])} trimmable" unless component[:trimmable_count].nil? %>
+                  <% unless component[:oldest_message_age_seconds].nil? %>
+                    <% age = component[:oldest_message_age_seconds] %>
+                    <% if age < 3600 %>
+                      <% value = [age / 60, 1].max; unit = "m" %>
+                    <% elsif age < 86_400 %>
+                      <% value = age / 3600; unit = "h" %>
+                    <% else %>
+                      <% value = age / 86_400; unit = "d" %>
+                    <% end %>
+                    <% parts << "oldest #{value}#{unit}" %>
+                  <% end %>
+                  <%= parts.join(" · ") %>
+                <% else %>
+                  <%= records_value %> <%= component[:record_label] %>
+                <% end %>
+              <% else %>
+                <%= component[:unavailable_reason] %>
+              <% end %>
+            </div>
+          </article>
+        <% end %>
+      </div>
+    </section>
+
+    <% if @storage_history.any? %>
+      <div class="so-card so-card--section">
+        <div class="so-card__label">Recent Snapshots</div>
+        <table class="so-table so-table--card">
+          <caption class="sr-only">Recent storage snapshots by component</caption>
+          <thead>
             <tr>
-              <td><%= snapshot.recorded_at.strftime("%Y-%m-%d %H:%M") %></td>
-              <td><%= number_to_human_size(snapshot.db_size_bytes, precision: 1, significant: false, strip_insignificant_zeros: false) %></td>
-              <td><%= number_with_delimiter(snapshot.event_count) %></td>
+              <th>Time</th>
+              <th>Component</th>
+              <th>Size</th>
+              <th>Records</th>
             </tr>
-          <% end %>
-        </tbody>
-      </table>
-    </div>
+          </thead>
+          <tbody>
+            <% @storage_history.each do |snapshot| %>
+              <% record_label = case snapshot.component
+                when "solid_cache" then "cache rows"
+                when "solid_cable" then "messages"
+                else "observer events"
+                end %>
+              <% component_label = case snapshot.component
+                when "solid_cable" then "Solid Cable messages"
+                when "cable_observer" then "Cable telemetry"
+                else snapshot.component.humanize
+                end %>
+              <tr>
+                <td><%= snapshot.recorded_at.strftime("%Y-%m-%d %H:%M") %></td>
+                <td><%= component_label %></td>
+                <td><%= number_to_human_size(snapshot.db_size_bytes, precision: 1, significant: false, strip_insignificant_zeros: false) %></td>
+                <td><%= number_with_delimiter(snapshot.event_count) %> <%= record_label %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    <% end %>
+  <% else %>
+    <%= render "solid_observer/shared/empty_state", message: "No storage information available" %>
   <% end %>
-<% else %>
-  <%= render "solid_observer/shared/empty_state", message: "No storage information available" %>
-<% end %>
+</div>

data/config/routes.rb

@@ -2,6 +2,13 @@
 
 SolidObserver::Engine.routes.draw do
   root "dashboard#index"
+  get "queue", to: "dashboard#index", defaults: {component: "queue"}, as: :queue_dashboard
+  get "cache", to: "cache_dashboard#index", as: :cache_dashboard
+  get "cable", to: "cable_dashboard#index", as: :cable_dashboard
+  post "cable/trim", to: "cable_operations#trim", as: :trim_cable_operations
+  get "cache/controls", to: "cache_operations#index", as: :cache_operations
+  post "cache/controls/prune", to: "cache_operations#prune", as: :prune_cache_operations
+  post "cache/controls/clear", to: "cache_operations#clear", as: :clear_cache_operations
   get "poll_data", to: "dashboard#poll_data", as: :poll_data
   get "live_poll.js", to: "dashboard#live_poll", as: :live_poll_script
 

data/db/migrate/20260601000001_create_solid_observer_cache_events.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateSolidObserverCacheEvents < ActiveRecord::Migration[8.0]
+  def change
+    create_table :solid_observer_cache_events do |t|
+      t.string :event_type, null: false, limit: 64
+      t.string :key_digest, null: false, limit: 64
+      t.boolean :hit
+      t.float :duration
+      t.string :error_class, limit: 255
+      t.text :error_message
+      t.text :metadata
+      t.datetime :recorded_at, null: false
+
+      t.index :recorded_at
+      t.index :event_type
+      t.index :key_digest
+      t.index :hit
+      t.index :error_class
+    end
+  end
+end

data/db/migrate/20260601000002_create_solid_observer_cache_metrics.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateSolidObserverCacheMetrics < ActiveRecord::Migration[8.0]
+  def change
+    create_table :solid_observer_cache_metrics do |t|
+      t.string :event_type, null: false, limit: 64
+      t.datetime :period_start, null: false
+      t.bigint :operations_count, null: false, default: 0
+      t.bigint :hits_count, null: false, default: 0
+      t.bigint :misses_count, null: false, default: 0
+      t.bigint :errors_count, null: false, default: 0
+      t.float :duration_total, null: false, default: 0.0
+
+      t.index [:event_type, :period_start], unique: true, name: "idx_solid_observer_cache_metrics_unique"
+      t.index :period_start
+    end
+  end
+end

data/db/migrate/20260602000001_add_component_to_solid_observer_storage_infos.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddComponentToSolidObserverStorageInfos < ActiveRecord::Migration[8.0]
+  def change
+    add_column :solid_observer_storage_info, :component, :string, null: false, default: "queue_observer"
+    add_index :solid_observer_storage_info, :component
+  end
+end

data/db/migrate/20260612000001_add_event_type_recorded_at_index_to_cache_events.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class AddEventTypeRecordedAtIndexToCacheEvents < ActiveRecord::Migration[8.0]
+  disable_ddl_transaction!
+
+  def change
+    options = concurrent_supported? ? {algorithm: :concurrently} : {}
+
+    add_index :solid_observer_cache_events,
+      %i[event_type recorded_at],
+      order: {recorded_at: :desc},
+      if_not_exists: true,
+      **options
+  end
+
+  private
+
+  def concurrent_supported?
+    connection.adapter_name.match?(/postgres/i)
+  end
+end

data/db/migrate/20260619000001_create_solid_observer_cable_events.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateSolidObserverCableEvents < ActiveRecord::Migration[8.0]
+  def change
+    create_table :solid_observer_cable_events do |t|
+      t.string :event_type, null: false, limit: 64
+      t.string :channel_class, limit: 255
+      t.string :broadcasting_digest, limit: 64
+      t.float :duration
+      t.string :error_class, limit: 255
+      t.text :error_message
+      t.text :metadata
+      t.datetime :recorded_at, null: false
+
+      t.index :recorded_at
+      t.index :event_type
+      t.index :channel_class
+      t.index :broadcasting_digest
+      t.index :error_class
+    end
+  end
+end

data/db/migrate/20260619000002_create_solid_observer_cable_metrics.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateSolidObserverCableMetrics < ActiveRecord::Migration[8.0]
+  def change
+    create_table :solid_observer_cable_metrics do |t|
+      t.datetime :period_start, null: false
+      t.bigint :broadcasts_count, null: false, default: 0
+      t.bigint :transmissions_count, null: false, default: 0
+      t.bigint :confirmations_count, null: false, default: 0
+      t.bigint :rejections_count, null: false, default: 0
+      t.bigint :perform_actions_count, null: false, default: 0
+      t.bigint :errors_count, null: false, default: 0
+
+      t.index :period_start, unique: true, name: "idx_solid_observer_cable_metrics_unique"
+    end
+  end
+end

data/lib/generators/solid_observer/install_generator.rb

@@ -17,8 +17,11 @@ module SolidObserver
         %w[development test production].each do |env|
           config_block = <<-YAML
   solid_observer_queue:
-    <<: *default
+    adapter: sqlite3
+    pool: 5
+    timeout: 5000
     database: storage/#{env}_solid_observer_queue.sqlite3
+    migrations_paths: db/solid_observer_migrate
           YAML
           inject_into_file "config/database.yml", config_block, after: /^#{env}:\n(?:  .*\n)*/
         end
@@ -40,6 +43,10 @@ module SolidObserver
         say "  5. Restart your Rails server"
         say "  6. Visit /solid_observer to access the web dashboard"
         say "\n"
+        say "IMPORTANT: If your host app uses PostgreSQL or MySQL, review the", :yellow
+        say "solid_observer_queue entries in config/database.yml before running", :yellow
+        say "db:create. The generated config uses adapter: sqlite3 by default.", :yellow
+        say "\n"
         say "Documentation: https://solid.observer", :red
         say "GitHub: https://github.com/bart-oz/solid_observer", :red
         say "\n"

data/lib/generators/solid_observer/templates/initializer.rb.tt

@@ -9,22 +9,38 @@ SolidObserver.configure do |config|
   # Recommended: false in production, true in development/staging
   config.ui_enabled = !Rails.env.production?
 
-  # Authentication for web UI — set a username to enable HTTP Basic Auth
+  # Production dashboard exposure is the host app's responsibility. If you mount
+  # the dashboard in production, wrap the mount in your existing admin auth
+  # constraint, for example in config/routes.rb:
+  #
+  #   authenticate :user, ->(user) { user.admin? } do
+  #     mount SolidObserver::Engine, at: "/solid_observer"
+  #   end
+  #
+  # Built-in HTTP Basic Auth is enabled only when BOTH credentials are present.
+  # Setting only one credential disables Basic Auth and logs a boot warning.
   # config.ui_username = "admin"
   # config.ui_password = "secret"
 
-  # Base controller for UI (customize authorization)
+  # Base controller used only to detect API-only rendering compatibility
   # config.ui_base_controller = "ApplicationController"
 
   # === Queue Observability (v0.1.0) ===
   config.observe_queue = true
 
-  # === Cache Observability (Coming in v0.4.0+) ===
+  # === Cache Observability (v0.4.0) ===
+  # Enable SolidCache event capture and operational clear/prune controls
   # config.observe_cache = true
   # config.cache_sampling_rate = 0.1  # Sample 10% of cache operations
 
-  # === Cable Observability (Coming in v0.5.0+) ===
+  # === Cable Observability (v0.5.0) ===
+  # Enable SolidCable event capture and trim controls.
+  # Requires SolidCable in the host app; SolidObserver does not add it.
   # config.observe_cable = true
+  # config.cable_sampling_rate = 0.1          # Sample 10% of broadcast events
+  # config.cable_rejection_threshold = 0.05   # Rejection rate → Degraded stability
+  # config.cable_backlog_threshold = 0.10     # Backlog ratio threshold
+  # config.cable_error_threshold = 0.0        # Error rate threshold
 
   # Data Retention
   config.event_retention = 30.days    # How long to keep event records

data/lib/solid_observer/base_event.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidObserver
-  class BaseEvent < ActiveRecord::Base
+  class BaseEvent < BaseRecord
     self.abstract_class = true
 
     # connects_to is configured by the engine after Rails initializes

data/lib/solid_observer/base_metric.rb

@@ -7,7 +7,7 @@ module SolidObserver
   # will be configured by the Engine (similar to BaseEvent) when metrics are
   # fully implemented.
   #
-  class BaseMetric < ActiveRecord::Base
+  class BaseMetric < BaseRecord
     self.abstract_class = true
     self.table_name = "solid_observer_metrics"
 

data/lib/solid_observer/base_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SolidObserver
+  class BaseRecord < ActiveRecord::Base
+    self.abstract_class = true
+    # connects_to is configured by the engine after Rails initializes
+  end
+end

data/lib/solid_observer/cable_event_buffer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+require_relative "event_buffer_core"
+
+module SolidObserver
+  class CableEventBuffer
+    include Singleton
+    include EventBufferCore
+
+    INITIAL_METRICS = EventBufferCore::INITIAL_METRICS
+
+    def initialize
+      initialize_event_buffer
+    end
+
+    private
+
+    def flush_service
+      Services::FlushCableEventBuffer
+    end
+
+    def log_label
+      "Cable buffer"
+    end
+  end
+end