railscope 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 365fa77a20cf2375e26da9f92c52dae76d20ff8cce31a793f921e7e392208149
-  data.tar.gz: 838667bc52bf55f90c2372d713d4677407675f2ec8b27cdcc460eb701ea89931
+  metadata.gz: dc29cf9c10caee093f9522baf082ee343928f114a9eea9490caf1b5107b410e1
+  data.tar.gz: e705db77c3b666499073046ed0cccfcdbacc8871024bb6d8393d6a875b55a93b
 SHA512:
-  metadata.gz: 25d34d2449ae7cd8c9b0940438a93de8357cb4f5a73b85fab3f762bbd46cb0a41f87e905c474d467b15330f83ce7c35f3e7d9adbaf4a3bd88a8f0c0f8ee683b1
-  data.tar.gz: 392dfb08fe6a2fbda012364e0a0e705a913337626e4fef890deb1bff469cb009ee68e8bb851988e8814a7e7f578cd04df6295e0f821dd5364205b337af2c30b8
+  metadata.gz: 0d49c922528f889a0c751ff9865da540a92250097b29108f7eb43be36598fd12addad625a6651100cac745fe553d76d4030c90af718611c0d94672fabc14ea87
+  data.tar.gz: 78be37fbf93b9e6128be9135bc47995fbd65f6dc60cae1067c42b13ad2ee375e6365d92cb63cc698352d63d797e910869e19f060f352a77dbf42a80b88412b8f

data/README.md

@@ -13,7 +13,8 @@ Railscope provides insight into the requests, exceptions, database queries, jobs
 - **Context Correlation** - Link all events from the same request via `request_id`
 - **Sensitive Data Filtering** - Automatic masking of passwords, tokens, and secrets
 - **Dark Mode UI** - Beautiful GitHub-inspired dark interface
-- **Zero Dependencies** - Works with any Rails 7+ application
+- **Storage Backends** - Direct database writes or Redis buffer with batch flush
+- **Zero Dependencies** - Works with any Rails 7+ application (Redis optional)
 
 ## Installation
 
@@ -55,6 +56,9 @@ Create `config/initializers/railscope.rb`:
 
 ```ruby
 Railscope.configure do |config|
+  # Storage backend: :database (default) or :redis (buffer)
+  config.storage_backend = :database
+
   # Data retention (default: 7 days)
   config.retention_days = 30
 
@@ -66,11 +70,49 @@ Railscope.configure do |config|
 end
 ```
 
+### Storage Backends
+
+Railscope supports two storage modes:
+
+| Mode | Write | Read | Requires |
+|------|-------|------|----------|
+| `:database` | Direct INSERT (sync) | PostgreSQL | PostgreSQL |
+| `:redis` | Redis buffer (async) | PostgreSQL | PostgreSQL + Redis |
+
+**`:database`** (default) -- Entries are written directly to PostgreSQL during the request. Simplest setup, no Redis needed.
+
+**`:redis`** -- Entries are buffered in Redis (~0.1ms per write) and batch-flushed to PostgreSQL periodically. Reduces request latency in high-throughput applications.
+
+When using `:redis`, you need to flush the buffer periodically:
+
+```ruby
+# From a background job (Sidekiq, GoodJob, SolidQueue, etc.)
+class RailscopeFlushJob < ApplicationJob
+  queue_as :low
+
+  def perform
+    Railscope::FlushService.call
+  end
+end
+
+# From a cron/scheduler
+every 5.seconds do
+  runner "Railscope::FlushService.call"
+end
+
+# Or via rake
+# $ rake railscope:flush
+```
+
+> **Note:** Entries only appear in the dashboard after being flushed to PostgreSQL.
+
 ### Environment Variables
 
 | Variable | Description | Default |
 |----------|-------------|---------|
 | `RAILSCOPE_ENABLED` | Enable/disable recording | `false` |
+| `RAILSCOPE_STORAGE` | Storage backend (`database` or `redis`) | `database` |
+| `RAILSCOPE_REDIS_URL` | Redis connection URL | Falls back to `REDIS_URL` |
 | `RAILSCOPE_RETENTION_DAYS` | Days to keep entries | `7` |
 
 ## Authorization
@@ -144,6 +186,16 @@ Entries are automatically tagged:
 - **Exceptions**: `exception`, exception class name
 - **Jobs**: `job`, `enqueue`/`perform`, queue name, `failed`
 
+### Rake Tasks
+
+```bash
+# Flush buffered entries from Redis to database (redis mode only)
+rake railscope:flush
+
+# Purge expired entries (older than retention_days)
+rake railscope:purge
+```
+
 ### Purging Old Entries
 
 Run the purge job to remove entries older than `retention_days`:
@@ -212,12 +264,20 @@ Railscope::Entry.expired
 
 Railscope is designed to have minimal impact:
 
-- Events are recorded synchronously but quickly
 - Ignored paths skip all processing
 - Sensitive data filtering is done once before save
 - Purge job removes old entries to control database size
 
+**With `:database` backend:**
+- Entries are written synchronously via INSERT during the request
+
+**With `:redis` backend:**
+- Writes go to Redis (~0.1ms per entry), near-zero impact on request latency
+- `Entry.insert_all` batches up to 1000 records per flush for efficient persistence
+- Flush is safe to run concurrently (Redis `LPOP` is atomic)
+
 For high-traffic production environments, consider:
+- Using `:redis` backend for lower request latency
 - Shorter retention periods
 - Adding high-traffic paths to ignore list
 - Running purge job more frequently

data/app/models/railscope/application_record.rb

@@ -4,9 +4,30 @@ module Railscope
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
 
-    # Support for separate database connection when RAILSCOPE_DATABASE_URL is configured
-    # This isolates Railscope's writes from the main application database,
-    # preventing lock contention during high-traffic periods.
-    connects_to database: { writing: :railscope, reading: :railscope } if ENV["RAILSCOPE_DATABASE_URL"].present?
+    # Support for separate database connection.
+    # Activated when a "railscope" database is defined in database.yml
+    # or when RAILSCOPE_DATABASE_URL is set.
+    #
+    # Example database.yml:
+    #   development:
+    #     primary:
+    #       <<: *default
+    #       database: myapp_development
+    #       migrations_paths: db/migrate
+    #     railscope:
+    #       <<: *default
+    #       database: myapp_railscope_development
+    #       migrations_paths: db/railscope_migrate
+    #
+    def self.railscope_separate_database?
+      return true if ENV["RAILSCOPE_DATABASE_URL"].present?
+
+      configs = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env)
+      configs.any? { |c| c.name == "railscope" }
+    rescue StandardError
+      false
+    end
+
+    connects_to database: { writing: :railscope, reading: :railscope } if railscope_separate_database?
   end
 end

data/app/views/layouts/railscope/application.html.erb

@@ -5,10 +5,11 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Railscope</title>
     <%= csrf_meta_tags %>
-    <link rel="stylesheet" href="<%= railscope.root_path %>assets/app.css">
+    <meta name="railscope-version" content="<%= Railscope::VERSION %>">
+    <link rel="stylesheet" href="<%= railscope.root_path %>assets/app.css?v=<%= Railscope::VERSION %>">
   </head>
   <body class="bg-[#0d1117] text-[#c9d1d9]">
     <%= yield %>
-    <script type="module" src="<%= railscope.root_path %>assets/app.js"></script>
+    <script type="module" src="<%= railscope.root_path %>assets/app.js?v=<%= Railscope::VERSION %>"></script>
   </body>
 </html>

data/client/src/components/Sidebar.tsx

@@ -4,21 +4,11 @@ import { cn } from '@/lib/utils'
 const navigation = [
   { name: 'Requests', href: '/requests', icon: RequestIcon },
   { name: 'Commands', href: '/commands', icon: CommandIcon },
-  { name: 'Schedule', href: '/schedule', icon: ScheduleIcon },
   { name: 'Jobs', href: '/jobs', icon: JobIcon },
   { name: 'Exceptions', href: '/exceptions', icon: ExceptionIcon },
-  { name: 'Logs', href: '/logs', icon: LogIcon },
-  { name: 'Dumps', href: '/dumps', icon: DumpIcon },
   { name: 'Queries', href: '/queries', icon: QueryIcon },
   { name: 'Models', href: '/models', icon: ModelIcon },
-  { name: 'Events', href: '/events', icon: EventIcon },
-  { name: 'Mail', href: '/mail', icon: MailIcon },
-  { name: 'Notifications', href: '/notifications', icon: NotificationIcon },
-  { name: 'Gates', href: '/gates', icon: GateIcon },
-  { name: 'Cache', href: '/cache', icon: CacheIcon },
-  { name: 'Redis', href: '/redis', icon: RedisIcon },
   { name: 'Views', href: '/views', icon: ViewIcon },
-  { name: 'HTTP Client', href: '/client-requests', icon: ClientRequestIcon },
 ]
 
 export default function Sidebar() {
@@ -54,7 +44,7 @@ export default function Sidebar() {
       </nav>
 
       <div className="p-4 border-t border-dark-border text-xs text-dark-muted">
-        Railscope v0.1.0
+        Railscope v{document.querySelector('meta[name="railscope-version"]')?.getAttribute('content') || '0.0.0'}
       </div>
     </aside>
   )
@@ -76,14 +66,6 @@ function CommandIcon({ className }: { className?: string }) {
   )
 }
 
-function ScheduleIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M12 8v4l3 3m6-3a9 9 0 11-18 0 9 9 0 0118 0z" />
-    </svg>
-  )
-}
-
 function JobIcon({ className }: { className?: string }) {
   return (
     <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
@@ -100,22 +82,6 @@ function ExceptionIcon({ className }: { className?: string }) {
   )
 }
 
-function LogIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M9 12h6m-6 4h6m2 5H7a2 2 0 01-2-2V5a2 2 0 012-2h5.586a1 1 0 01.707.293l5.414 5.414a1 1 0 01.293.707V19a2 2 0 01-2 2z" />
-    </svg>
-  )
-}
-
-function DumpIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M19.428 15.428a2 2 0 00-1.022-.547l-2.387-.477a6 6 0 00-3.86.517l-.318.158a6 6 0 01-3.86.517L6.05 15.21a2 2 0 00-1.806.547M8 4h8l-1 1v5.172a2 2 0 00.586 1.414l5 5c1.26 1.26.367 3.414-1.415 3.414H4.828c-1.782 0-2.674-2.154-1.414-3.414l5-5A2 2 0 009 10.172V5L8 4z" />
-    </svg>
-  )
-}
-
 function QueryIcon({ className }: { className?: string }) {
   return (
     <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
@@ -132,54 +98,6 @@ function ModelIcon({ className }: { className?: string }) {
   )
 }
 
-function EventIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M13 10V3L4 14h7v7l9-11h-7z" />
-    </svg>
-  )
-}
-
-function MailIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M3 8l7.89 5.26a2 2 0 002.22 0L21 8M5 19h14a2 2 0 002-2V7a2 2 0 00-2-2H5a2 2 0 00-2 2v10a2 2 0 002 2z" />
-    </svg>
-  )
-}
-
-function NotificationIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M15 17h5l-1.405-1.405A2.032 2.032 0 0118 14.158V11a6.002 6.002 0 00-4-5.659V5a2 2 0 10-4 0v.341C7.67 6.165 6 8.388 6 11v3.159c0 .538-.214 1.055-.595 1.436L4 17h5m6 0v1a3 3 0 11-6 0v-1m6 0H9" />
-    </svg>
-  )
-}
-
-function GateIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M9 12l2 2 4-4m5.618-4.016A11.955 11.955 0 0112 2.944a11.955 11.955 0 01-8.618 3.04A12.02 12.02 0 003 9c0 5.591 3.824 10.29 9 11.622 5.176-1.332 9-6.03 9-11.622 0-1.042-.133-2.052-.382-3.016z" />
-    </svg>
-  )
-}
-
-function CacheIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M5 8h14M5 8a2 2 0 110-4h14a2 2 0 110 4M5 8v10a2 2 0 002 2h10a2 2 0 002-2V8m-9 4h4" />
-    </svg>
-  )
-}
-
-function RedisIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M4 7v10c0 2.21 3.582 4 8 4s8-1.79 8-4V7M4 7c0 2.21 3.582 4 8 4s8-1.79 8-4M4 7c0-2.21 3.582-4 8-4s8 1.79 8 4m0 5c0 2.21-3.582 4-8 4s-8-1.79-8-4" />
-    </svg>
-  )
-}
-
 function ViewIcon({ className }: { className?: string }) {
   return (
     <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
@@ -188,11 +106,3 @@ function ViewIcon({ className }: { className?: string }) {
     </svg>
   )
 }
-
-function ClientRequestIcon({ className }: { className?: string }) {
-  return (
-    <svg className={className} fill="none" viewBox="0 0 24 24" stroke="currentColor">
-      <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M21 12a9 9 0 01-9 9m9-9a9 9 0 00-9-9m9 9H3m9 9a9 9 0 01-9-9m9 9c1.657 0 3-4.03 3-9s-1.343-9-3-9m0 18c-1.657 0-3-4.03-3-9s1.343-9 3-9m-9 9a9 9 0 019-9" />
-    </svg>
-  )
-}

data/lib/railscope/engine.rb

@@ -29,8 +29,23 @@ module Railscope
 
     initializer "railscope.migrations" do |app|
       unless app.root.to_s.match?(root.to_s)
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
+        if railscope_separate_database?
+          # Separate database: copy migrations to db/railscope_migrate/
+          # so they only run against the railscope database
+          target_dir = app.root.join("db", "railscope_migrate")
+          config.paths["db/migrate"].expanded.each do |source_dir|
+            Dir[File.join(source_dir, "*.rb")].each do |migration|
+              target = target_dir.join(File.basename(migration))
+              next if target.exist?
+
+              FileUtils.mkdir_p(target_dir)
+              FileUtils.cp(migration, target)
+            end
+          end
+        else
+          config.paths["db/migrate"].expanded.each do |expanded_path|
+            app.config.paths["db/migrate"] << expanded_path
+          end
         end
       end
     end
@@ -84,5 +99,14 @@ module Railscope
       # Subscribe to rake tasks after they're loaded
       Railscope::Subscribers::CommandSubscriber.subscribe
     end
+
+    private
+
+    def railscope_separate_database?
+      configs = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env)
+      configs.any? { |c| c.name == "railscope" }
+    rescue StandardError
+      false
+    end
   end
 end

data/lib/railscope/storage/redis_buffer.rb

@@ -5,11 +5,13 @@ module Railscope
     class RedisBuffer < Base
       BUFFER_KEY = "railscope:buffer"
       UPDATES_KEY = "railscope:buffer:updates"
+      BUFFER_TTL = 4.hours.to_i
 
       # WRITE → Redis (fast, ~0.1ms)
       def write(attributes)
         entry = build_entry(attributes)
         redis.rpush(BUFFER_KEY, entry.to_json)
+        redis.expire(BUFFER_KEY, BUFFER_TTL)
         entry
       end
 
@@ -21,6 +23,7 @@ module Railscope
           payload_updates: payload_updates
         }
         redis.rpush(UPDATES_KEY, update.to_json)
+        redis.expire(UPDATES_KEY, BUFFER_TTL)
       end
 
       # READ → Database (source of truth)

data/lib/railscope/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Railscope
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end