railscope 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259570e86e958b91b577337b9b1dd6f57f667f72999589a3976b9a86a3450c78
-  data.tar.gz: bbf6d0de9fdce6901383c8d60c39c07310a3da0d64593904d55a85412deba2b1
+  metadata.gz: '02218f15b1789991595d3aad2ee44e995246ac00be8cc2b10f3769c40b2305d5'
+  data.tar.gz: d17a705f4afc714006ca408a08342ba9798e993dc1ced98c6449ab36e913378d
 SHA512:
-  metadata.gz: 2d358d6d57809e3b6d30bebfab973060d8c3086a929c8d47dd3fc230be5ad72f0cca7ed84f0431466b80f3b5d863e8f1d37c0d26eb6df14301d7ef307fcc05a5
-  data.tar.gz: 41b79ac66a21145f5ca9fe18a07a6706bf06751a87eb26bd1739a816526d7e851c43d784146cb2bf6391ce47e7e73bbfe91443e883e8f868d45a039e30b66dec
+  metadata.gz: d18a4366d4a67a0f1a84f7ef105b164551e02a85fadf20c540f25591b6b8504712410567967ef99400d3e6976568f87132bc974462693a8b74fc902fd922fde9
+  data.tar.gz: 4b0e0e2c93a415ce579f0f0b3983fd4937c9c9d1bf1c49c93294c318c76292da963d6a3aadd960afe49c980fb025cad3b5e8c88b2a6be2f01397a583ef8226ef

data/README.md

@@ -65,6 +65,15 @@ Railscope.configure do |config|
   # Paths to ignore (defaults: /railscope, /assets, /packs, /cable)
   config.add_ignore_paths("/health", "/ping", "/metrics")
 
+  # Jobs to ignore (class names or regex patterns)
+  config.add_ignore_jobs("SomeFrequentJob", "Turbo::Streams::.*")
+
+  # Rake tasks to ignore (task names or regex patterns)
+  config.add_ignore_commands("db:.*", "assets:.*", "tmp:.*")
+
+  # Use an existing Redis connection (useful for SSL/connection sharing)
+  # config.redis = $redis
+
   # Additional sensitive keys to filter
   config.add_sensitive_keys(:cpf, :ssn, :bank_account)
 end
@@ -208,6 +217,51 @@ Railscope::PurgeJob.perform_now
 Railscope::PurgeJob.perform_later
 ```
 
+## Filtering Entries
+
+### Ignore Paths
+
+Requests matching these path prefixes will not be recorded:
+
+```ruby
+# Defaults: /railscope, /assets, /packs, /cable
+config.add_ignore_paths("/health", "/ping", "/metrics", "/up")
+```
+
+### Ignore Jobs
+
+Background jobs matching these patterns will not be recorded (enqueue, perform, or exceptions). Accepts exact class names or regex patterns:
+
+```ruby
+# Exact match
+config.add_ignore_jobs("HeartbeatJob")
+
+# Regex patterns
+config.add_ignore_jobs("SolidQueue::.*", "Turbo::Streams::.*", "ActionMailbox::.*")
+```
+
+### Ignore Commands
+
+Rake tasks matching these patterns will not be instrumented. Accepts exact task names or regex patterns:
+
+```ruby
+# Exact match
+config.add_ignore_commands("db:migrate")
+
+# Regex patterns — ignore entire namespaces
+config.add_ignore_commands("db:.*", "assets:.*", "tmp:.*", "log:.*")
+```
+
+### Custom Redis Connection
+
+By default, Railscope creates its own Redis connection from `RAILSCOPE_REDIS_URL` or `REDIS_URL`. If your app already has a configured Redis instance (e.g., with SSL on Heroku), you can pass it directly:
+
+```ruby
+config.redis = $redis
+```
+
+This avoids SSL certificate issues and shares the existing connection configuration.
+
 ## Filtered Parameters
 
 Railscope automatically filters sensitive data:
@@ -279,8 +333,11 @@ Railscope is designed to have minimal impact:
 For high-traffic production environments, consider:
 - Using `:redis` backend for lower request latency
 - Shorter retention periods
-- Adding high-traffic paths to ignore list
+- Ignoring noisy paths (`/health`, `/ping`, polling endpoints)
+- Ignoring high-frequency jobs (`SolidQueue::.*`, `Turbo::Streams::.*`)
+- Ignoring routine rake tasks (`db:.*`, `assets:.*`)
 - Running purge job more frequently
+- Using `config.redis = $redis` to share the app's existing Redis connection
 
 ## License
 

data/lib/generators/railscope/templates/initializer.rb

@@ -49,6 +49,28 @@ Railscope.configure do |config|
   #
   # config.add_ignore_paths("/health", "/ping", "/metrics")
 
+  # Ignored Jobs
+  # ------------
+  # Jobs matching these patterns will not be recorded.
+  # Accepts class names or regex patterns.
+  #
+  # config.add_ignore_jobs("SomeFrequentJob", "Turbo::Streams::.*")
+
+  # Ignored Commands
+  # ----------------
+  # Rake tasks matching these patterns will not be recorded.
+  # Accepts task names or regex patterns.
+  #
+  # config.add_ignore_commands("db:.*", "assets:.*", "tmp:.*")
+
+  # Redis Connection
+  # ----------------
+  # By default, Railscope creates its own Redis connection from
+  # RAILSCOPE_REDIS_URL or REDIS_URL. You can pass an existing
+  # Redis instance instead (useful for SSL/connection sharing):
+  #
+  # config.redis = $redis
+
   # Sensitive Keys
   # --------------
   # Additional parameter names to filter from payloads.

data/lib/railscope/subscribers/command_subscriber.rb

@@ -23,6 +23,7 @@ module Railscope
 
         def instrument_task(task)
           return if task.name.start_with?("railscope:")
+          return if Railscope.ignore_command?(task.name)
           return if instrumented_tasks.include?(task.name)
 
           instrumented_tasks << task.name

data/lib/railscope/subscribers/job_subscriber.rb

@@ -199,7 +199,7 @@ module Railscope
       end
 
       def ignore_job?(job)
-        job.class.name.start_with?("Railscope::")
+        job.class.name.start_with?("Railscope::") || Railscope.ignore_job?(job.class.name)
       end
 
       def setup_job_context(job)

data/lib/railscope/version.rb

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

data/lib/railscope.rb

@@ -27,7 +27,7 @@ module Railscope
   STORAGE_REDIS = :redis
 
   class << self
-    attr_writer :retention_days, :redis, :storage_backend, :ignore_paths
+    attr_writer :retention_days, :redis, :storage_backend, :ignore_paths, :ignore_jobs, :ignore_commands
     attr_accessor :authenticate_with
 
     def enabled=(value)
@@ -99,6 +99,30 @@ module Railscope
       @ignore_paths = ignore_paths.concat(paths.flatten).uniq
     end
 
+    def ignore_jobs
+      @ignore_jobs ||= []
+    end
+
+    def add_ignore_jobs(*job_classes)
+      @ignore_jobs = ignore_jobs.concat(job_classes.flatten.map(&:to_s)).uniq
+    end
+
+    def ignore_job?(job_class_name)
+      ignore_jobs.any? { |pattern| job_class_name.match?(pattern) }
+    end
+
+    def ignore_commands
+      @ignore_commands ||= []
+    end
+
+    def add_ignore_commands(*commands)
+      @ignore_commands = ignore_commands.concat(commands.flatten.map(&:to_s)).uniq
+    end
+
+    def ignore_command?(command_name)
+      ignore_commands.any? { |pattern| command_name.match?(pattern) }
+    end
+
     def context
       Context.current
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railscope
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Phelipe Tussolini