bugwatch-ruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4cb56c42da0cab5b2e855deca671231a744b1624b5fcbd6dbef365f30bc9d08
-  data.tar.gz: 92889ce7b6cec458ee2c75c15759756acbaa32981051704c9a3534a42e58fe1d
+  metadata.gz: 6d6a47f1c5176ec17f87160b5ab4a273e6ef68e76dee98f6e60ee5da474a61fd
+  data.tar.gz: 713ab0b06839f57c473a98c8f3e1cd46f2f43b2c9ccfef2b18d7ba0e3abb1076
 SHA512:
-  metadata.gz: 479c753810d0c158b339281f7f7c5c083134bfe4321cfe7739a28d24d14fc3c82fb26e17330de1bc92f13e41e66e2726c4fe0b42b2d5110301c3410e566fc564
-  data.tar.gz: 6b2a55bf2cdd3a01fd82bd96a51c75f50fbbc48a373b8102c7c6a301ab748c75f7434084402d56cbf3b2009a838648205fa95c4706eb07655a423ef290f35d49
+  metadata.gz: cb255c2fcfe9562b06320de183bc1ee141f394eacb327eb6ad71739a662aaeb435f5da3248404a7074b45e6a397612d86fe8d243918284196cb7e3892c193f8a
+  data.tar.gz: 9ce11bcc466b319298cb788f51cdb1c89f00f6b3126189d02c9a7838eeb6f087291bb0864bc5115734849a1af966f2995385a627a057befbf815c63354e122ee

data/README.md

@@ -181,6 +181,55 @@ Bugwatch.send_feedback(
 )
 ```
 
+## Database query tracking
+
+The gem automatically subscribes to `sql.active_record` notifications and reports query performance data to your BugWatch instance. DB tracking is **enabled by default** — no extra setup required.
+
+### Configuration
+
+```ruby
+# config/initializers/bugwatch.rb
+Bugwatch.configure do |c|
+  # ... existing config ...
+
+  c.enable_db_tracking      = true   # default: true — set false to disable
+  c.db_sample_rate          = 1.0    # 0.0–1.0 — fraction of requests to track (default: 1.0)
+  c.db_query_threshold_ms   = 0      # only collect queries slower than this (default: 0 = all)
+  c.max_queries_per_request = 200    # cap per request to limit overhead (default: 200)
+end
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `enable_db_tracking` | `true` | Master switch for DB tracking |
+| `db_sample_rate` | `1.0` | Fraction of requests whose queries are collected (0.0–1.0) |
+| `db_query_threshold_ms` | `0` | Minimum query duration (ms) to collect — set higher to focus on slow queries |
+| `max_queries_per_request` | `200` | Maximum queries stored per request |
+
+Schema operations and transaction bookkeeping (`BEGIN`, `COMMIT`, `ROLLBACK`) are automatically excluded. SQL literals are sanitized before sending, so no user data leaves your app.
+
+### Skipping tracking
+
+Wrap any code block with `Bugwatch.without_tracking` to suppress all performance tracking (DB queries and transaction recording) for queries executed inside it. This is useful when BugWatch monitors itself, or for any internal bookkeeping queries you don't want tracked.
+
+```ruby
+Bugwatch.without_tracking do
+  SomeModel.insert_all(records)  # not tracked
+end
+```
+
+In a controller:
+
+```ruby
+around_action :skip_tracking
+
+private
+
+def skip_tracking(&block)
+  Bugwatch.without_tracking(&block)
+end
+```
+
 ## How it works
 
 1. `Bugwatch::Middleware` wraps your entire Rack stack.

data/lib/bugwatch/db_tracker.rb

@@ -36,6 +36,8 @@ module Bugwatch
     end
 
     def handle_event(event)
+      return if Bugwatch.skip_tracking?
+
       state = Thread.current[THREAD_KEY]
       return unless state
 

data/lib/bugwatch/middleware.rb

@@ -5,6 +5,8 @@ module Bugwatch
     end
 
     def call(env)
+      return @app.call(env) if Bugwatch.skip_tracking?
+
       start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       BreadcrumbCollector.clear
       UserContext.clear

data/lib/bugwatch/version.rb

@@ -1,3 +1,3 @@
 module Bugwatch
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/bugwatch.rb

@@ -120,6 +120,17 @@ module Bugwatch
       end
     end
 
+    def without_tracking
+      Thread.current[:bugwatch_skip_tracking] = true
+      yield
+    ensure
+      Thread.current[:bugwatch_skip_tracking] = false
+    end
+
+    def skip_tracking?
+      Thread.current[:bugwatch_skip_tracking] == true
+    end
+
     def transaction_buffer
       @transaction_buffer ||= TransactionBuffer.new(config: configuration)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugwatch-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - BugWatch