debugbundle 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b4c0b584220369f1090b505a818ba607e548173faca6018d24e26e4cb902c88
-  data.tar.gz: 4faa4b7b09b784f5f320f997f24fb8918106b3f88785ba795dbe0ae2a7a237c5
+  metadata.gz: 2233153d82d41df1121182d5e7f217f02c4b1a0c7348386505c0406e09db3e86
+  data.tar.gz: d1b0169d3968aa5c11a2eda1751bf9612afa63109818359d48e7ab1f94384c49
 SHA512:
-  metadata.gz: 5ceb4089417df9cc82cee9d5f0c3a9e7ea11e4bc69b517a2c9ab5dfeb637e6fb3c57f5bd01a2425cf52fdae66bda463f3b8eff638f37aa556202968478b4060f
-  data.tar.gz: 4f64e58b96b26f1808514010ade909e6a5b6423cd71fcb83037bb9e54c6cb25b71a2f279ef065a348050c1196ab5a8d6b89a503f26a4e72144d5b6a9215dad44
+  metadata.gz: 279871a9cf53e67fbbd269eaddc86c6003428993729d81c1b6586aa787780687c29b8a602716cbad9e1f33ca829564a9b936aaad282611c6594e66073d2654d1
+  data.tar.gz: 6b3b419131b880e0073322aff591c8dabfb5343374331246504b99fb31e1deeb1e79c17769c8a2ce7ad4288b81c186e0d0cd63eaa1ac631a709d13659f0f3554

data/README.md

@@ -314,7 +314,7 @@ This repository also ships a clean-install app-driven smoke harness that validat
 
 ```sh
 make smoke
-make smoke-published VERSION=1.0.0
+make smoke-published VERSION=1.1.2
 ```
 
 `make smoke` builds the gem, installs it into a fresh RubyGems home, drives a Rack request plus a browser relay batch through the public SDK surface, validates event envelope shape, and confirms the mock ingestion endpoint receives the expected service, environment, SDK metadata, and correlation fields.

data/lib/debugbundle/client.rb

@@ -2,6 +2,7 @@
 
 require 'digest'
 require 'time'
+require 'uri'
 
 require 'debugbundle/runtime'
 
@@ -23,7 +24,6 @@ module DebugBundle
     ].freeze
     BALANCED_IMMEDIATE_REQUEST_STATUSES = [408, 423, 424, 425, 429].freeze
     INVESTIGATIVE_IMMEDIATE_REQUEST_STATUSES = (BALANCED_IMMEDIATE_REQUEST_STATUSES + [409]).freeze
-    BALANCED_ANOMALY_REQUEST_STATUSES = [400, 401, 403, 404, 409, 410, 422].freeze
     LOCAL_ENVIRONMENTS = %w[development local test].freeze
     REQUEST_TRIGGER_DIRECTIVES_KEY = :__debugbundle_request_trigger_directives__
     THREAD_HOOK_MUTEX = Mutex.new
@@ -41,9 +41,7 @@ module DebugBundle
     class << self
       attr_accessor :thread_exception_client
 
-      def dispatch_thread_exception(error)
-        thread_exception_client&.__send__(:capture_thread_exception, error)
-      end
+      def dispatch_thread_exception(error) = thread_exception_client&.__send__(:capture_thread_exception, error)
 
       def install_thread_exception_hook!
         THREAD_HOOK_MUTEX.synchronize do
@@ -128,23 +126,20 @@ module DebugBundle
       }
 
       causes = exception_causes(error)
-      payload['causes'] = causes unless causes.empty?
 
       probe_data = probe_snapshot
       payload['probe_data'] = probe_data unless probe_data.empty?
 
       extra_context = merged_context.except('request', 'response', 'correlation')
-      payload['context'] = extra_context unless extra_context.empty?
+      extra_context['causes'] = causes unless causes.empty?
 
       suppression_key = [payload['name'], payload['message'], payload['stack']].join(':')
       return unless @suppression.should_capture(suppression_key, now: monotonic_now)
 
-      enqueue_event(base_event('backend_exception', payload, merged_context))
+      enqueue_event(base_event('backend_exception', payload, extra_context))
     end
 
-    def capture_error(error, context: nil, handled: true)
-      capture_exception(error, context: context, handled: handled)
-    end
+    def capture_error(error, context: nil, handled: true) = capture_exception(error, context: context, handled: handled)
 
     def capture_log(message, level: :warning, context: nil)
       return unless capture_enabled?
@@ -172,7 +167,7 @@ module DebugBundle
       sanitized_request = request_payload(request)
       sanitized_response = response_payload(response)
       response_status = (sanitized_response['status_code'] || 0).to_i
-      return unless capture_request_event?(response_status)
+      return unless capture_request_event?(response_status, sanitized_request)
 
       payload = {
         'method' => sanitized_request['method'],
@@ -183,8 +178,6 @@ module DebugBundle
         'response_status' => response_status,
         'duration_ms' => extract_duration_ms(merged_context, sanitized_response),
         'route_template' => merged_context['route_template'],
-        'controller' => merged_context['controller'],
-        'action' => merged_context['action'],
         'response_headers' => sanitized_response['headers'],
         'response_body' => sanitized_response['body']
       }
@@ -371,9 +364,7 @@ module DebugBundle
       :healthy
     end
 
-    def buffered_event_count
-      @buffer_mutex.synchronize { @buffer.length }
-    end
+    def buffered_event_count = @buffer_mutex.synchronize { @buffer.length }
 
     private
 
@@ -400,9 +391,7 @@ module DebugBundle
       )
     end
 
-    def capture_enabled?
-      config.enabled? && config.configured?
-    end
+    def capture_enabled? = config.enabled? && config.configured?
 
     def merge_context(context)
       merged = @context.merge(stringify_hash(context || {}))
@@ -420,8 +409,8 @@ module DebugBundle
     def request_payload(request)
       source = object_to_hash(request)
       {
-        'method' => source['method'],
-        'path' => source['path'],
+        'method' => source['method'] || 'UNKNOWN',
+        'path' => source['path'] || '/',
         'query' => @redactor.redact_value(source['query'] || {}),
         'headers' => sanitized_headers(source['headers'] || {}),
         'body' => @redactor.redact_value(source['body'] || {})
@@ -437,9 +426,7 @@ module DebugBundle
       }
     end
 
-    def runtime_payload
-      Runtime.payload
-    end
+    def runtime_payload = Runtime.payload
 
     def exception_causes(error)
       causes = []
@@ -502,7 +489,7 @@ module DebugBundle
     end
 
     def base_event(event_type, payload, context)
-      {
+      event = {
         'schema_version' => SCHEMA_VERSION,
         'event_id' => SecureRandom.uuid,
         'event_type' => event_type,
@@ -519,15 +506,14 @@ module DebugBundle
         'correlation' => correlation_payload(context),
         'payload' => @redactor.redact_value(payload)
       }
+      envelope_context = event_context(context)
+      event['context'] = envelope_context unless envelope_context.empty?
+      event
     end
 
-    def service_name
-      config.service || DEFAULT_SERVICE_NAME
-    end
+    def service_name = config.service || DEFAULT_SERVICE_NAME
 
-    def environment_name
-      config.environment || DEFAULT_ENVIRONMENT
-    end
+    def environment_name = config.environment || DEFAULT_ENVIRONMENT
 
     def correlation_payload(context)
       request = object_to_hash(context['request'])
@@ -540,6 +526,18 @@ module DebugBundle
       }
     end
 
+    def event_context(context)
+      object_to_hash(context).except(
+        'request',
+        'response',
+        'correlation',
+        'request_id',
+        'trace_id',
+        'session_id',
+        'user_id_hash'
+      )
+    end
+
     def object_to_hash(value)
       case value
       when Hash
@@ -591,14 +589,20 @@ module DebugBundle
       end
     end
 
-    def capture_request_event?(status_code)
+    def capture_request_event?(status_code, request)
       mode = @capture_policy.capture_request_events
-      immediate_statuses = immediate_request_statuses
-      anomaly_statuses = anomaly_request_statuses
 
       return true if mode == 'all'
-      return true if immediate_statuses.include?(status_code)
-      return true if mode == 'failures_only' && anomaly_statuses.include?(status_code)
+      return true if immediate_request_event?(status_code, request)
+      return true if mode == 'failures_only' && status_code >= 500
+
+      false
+    end
+
+    def immediate_request_event?(status_code, request)
+      return true if status_code >= 500
+      return true if immediate_request_statuses.include?(status_code)
+      return true if matching_immediate_client_error_path_rule?(status_code, request)
 
       false
     end
@@ -616,10 +620,34 @@ module DebugBundle
       statuses + Array(@capture_policy.immediate_client_error_statuses)
     end
 
-    def anomaly_request_statuses
-      return [] if @capture_policy.preset == 'minimal'
+    def matching_immediate_client_error_path_rule?(status_code, request)
+      return false unless (400..499).cover?(status_code)
+
+      path = normalize_request_path(request['path'] || request['url'])
+      method = request['method'].to_s.upcase
+      Array(@capture_policy.immediate_client_error_path_rules).any? do |rule|
+        next false unless rule.status_code == status_code
+        next false if !rule.http_methods.empty? && !rule.http_methods.include?(method)
+
+        if rule.path_pattern.end_with?('*')
+          path.start_with?(rule.path_pattern.delete_suffix('*'))
+        else
+          path == rule.path_pattern
+        end
+      end
+    end
+
+    def normalize_request_path(value)
+      begin
+        uri = URI.parse(value.to_s)
+        return uri.path if uri.path && !uri.path.empty?
+      rescue URI::InvalidURIError
+        # Fall through to the lightweight path-only fallback.
+      end
+      fallback = value.to_s.split('?', 2).first.to_s.split('#', 2).first
+      return fallback if fallback.start_with?('/') && !fallback.empty?
 
-      BALANCED_ANOMALY_REQUEST_STATUSES
+      '/'
     end
 
     def matching_probe_directives(label)
@@ -630,9 +658,7 @@ module DebugBundle
       end
     end
 
-    def current_request_trigger_directives
-      Array(Thread.current[REQUEST_TRIGGER_DIRECTIVES_KEY])
-    end
+    def current_request_trigger_directives = Array(Thread.current[REQUEST_TRIGGER_DIRECTIVES_KEY])
 
     def matching_request_trigger_directives(label)
       current_request_trigger_directives.select do |directive|
@@ -671,13 +697,9 @@ module DebugBundle
       0
     end
 
-    def rate_limited?
-      @retry_at && @retry_at > now
-    end
+    def rate_limited? = @retry_at && @retry_at > now
 
-    def local_environment?
-      LOCAL_ENVIRONMENTS.include?(environment_name.to_s)
-    end
+    def local_environment? = LOCAL_ENVIRONMENTS.include?(environment_name.to_s)
 
     def poll_remote_config_if_due!
       return unless @config_fetcher
@@ -713,12 +735,8 @@ module DebugBundle
       nil
     end
 
-    def now
-      @time_provider.call
-    end
+    def now = @time_provider.call
 
-    def monotonic_now
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
+    def monotonic_now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
   end
 end

data/lib/debugbundle/remote_config.rb

@@ -11,9 +11,12 @@ module DebugBundle
       :capture_breadcrumbs,
       :capture_probe_events,
       :immediate_client_error_statuses,
+      :immediate_client_error_path_rules,
       keyword_init: true
     )
 
+    ImmediateClientErrorPathRule = Struct.new(:status_code, :path_pattern, :http_methods, keyword_init: true)
+
     Directive = Struct.new(:id, :label_pattern, :service, :environment, :expires_at, keyword_init: true) do
       def active?(label:, service:, environment:, now:)
         return false if expires_at <= now
@@ -69,7 +72,8 @@ module DebugBundle
         capture_request_events: 'failures_only',
         capture_breadcrumbs: 'local_only',
         capture_probe_events: 'buffer_only',
-        immediate_client_error_statuses: []
+        immediate_client_error_statuses: [],
+        immediate_client_error_path_rules: []
       )
     end
 
@@ -80,7 +84,8 @@ module DebugBundle
         capture_request_events: 'failures_only',
         capture_breadcrumbs: 'exception_only',
         capture_probe_events: 'buffer_only',
-        immediate_client_error_statuses: []
+        immediate_client_error_statuses: [],
+        immediate_client_error_path_rules: []
       )
     end
 
@@ -122,10 +127,48 @@ module DebugBundle
         capture_probe_events: payload['capture_probe_events'] || payload[:capture_probe_events] || 'buffer_only',
         immediate_client_error_statuses: Array(
           payload['immediate_client_error_statuses'] || payload[:immediate_client_error_statuses]
-        ).grep(Integer)
+        ).grep(Integer),
+        immediate_client_error_path_rules: parse_immediate_client_error_path_rules(
+          payload['immediate_client_error_path_rules'] || payload[:immediate_client_error_path_rules]
+        )
       )
     end
 
+    def self.parse_immediate_client_error_path_rules(value)
+      entries = Array(value)
+      return [] if entries.empty? || entries.length > 25
+
+      entries.filter_map do |entry|
+        next unless entry.is_a?(Hash)
+
+        status_code = entry['status_code'] || entry[:status_code]
+        path_pattern = entry['path_pattern'] || entry[:path_pattern]
+        raw_methods = Array(entry['methods'] || entry[:methods])
+        next unless status_code.is_a?(Integer) && (400..499).cover?(status_code)
+        next unless valid_path_pattern?(path_pattern)
+        next if raw_methods.length > 7
+
+        http_methods = raw_methods.map { |method| method.to_s.upcase }.uniq
+        next unless http_methods.all? { |method| %w[GET POST PUT PATCH DELETE HEAD OPTIONS].include?(method) }
+
+        ImmediateClientErrorPathRule.new(
+          status_code: status_code,
+          path_pattern: path_pattern,
+          http_methods: http_methods
+        )
+      end
+    end
+
+    def self.valid_path_pattern?(value)
+      return false unless value.is_a?(String)
+      return false if value.empty? || value.length > 256
+      return false unless value.start_with?('/')
+      return false if value.include?('?') || value.include?('#')
+
+      wildcard_index = value.index('*')
+      wildcard_index.nil? || wildcard_index == value.length - 1
+    end
+
     def self.parse_directive(payload)
       return nil unless payload.is_a?(Hash)
 

data/lib/debugbundle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DebugBundle
-  VERSION = '1.0.0'
+  VERSION = '1.1.2'
 end

data/spec/fixtures/event-envelope.schema.json

@@ -57,11 +57,16 @@
         "event_id": { "type": "string", "format": "uuid" },
         "event_type": { "type": "string", "minLength": 1 },
         "project_token": { "type": "string", "minLength": 1 },
+        "project_id": { "type": ["string", "null"], "format": "uuid" },
         "sdk_name": { "type": "string", "minLength": 1 },
         "sdk_version": { "type": "string", "minLength": 1 },
         "service": { "$ref": "#/$defs/service" },
         "occurred_at": { "type": "string", "format": "date-time" },
         "correlation": { "$ref": "#/$defs/correlation" },
+        "context": {
+          "type": "object",
+          "additionalProperties": true
+        },
         "payload": {}
       }
     },

data/spec/rack_integration_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe 'Rack integration' do
     client = DebugBundle::Client.new(project_token: 'dbundle_proj_test', service: 'rack-checkout', transport: transport)
     app = Rack::Builder.new do
       use DebugBundle::Rack::Middleware, client: client
-      run ->(_env) { [422, { 'Content-Type' => 'text/plain' }, ['ok']] }
+      run ->(_env) { [503, { 'Content-Type' => 'text/plain' }, ['ok']] }
     end.to_app
 
     response = Rack::MockRequest.new(app).get(
@@ -35,10 +35,10 @@ RSpec.describe 'Rack integration' do
     client.flush
     event = transport_events.fetch(0).fetch(:events).fetch(0)
 
-    expect(response.status).to eq(422)
+    expect(response.status).to eq(503)
     expect(response.body).to eq('ok')
     expect(event.fetch('event_type')).to eq('request_event')
     expect(event.fetch('correlation')).to include('request_id' => 'req-rack', 'trace_id' => 'trace-rack')
-    expect(event.fetch('payload')).to include('path' => '/checkout', 'method' => 'GET', 'response_status' => 422)
+    expect(event.fetch('payload')).to include('path' => '/checkout', 'method' => 'GET', 'response_status' => 503)
   end
 end

data/spec/rack_middleware_spec.rb

@@ -195,10 +195,14 @@ RSpec.describe DebugBundle::Rack::Middleware do
     )
 
     client.flush
-    payload = transport_events.fetch(0).fetch(:events).fetch(0).fetch('payload')
+    event = transport_events.fetch(0).fetch(:events).fetch(0)
+    payload = event.fetch('payload')
+    context = event.fetch('context')
 
     expect(payload).to include(
-      'route_template' => '/patients/:patient_id/checkouts',
+      'route_template' => '/patients/:patient_id/checkouts'
+    )
+    expect(context).to include(
       'controller' => 'checkouts',
       'action' => 'create'
     )

data/spec/sidekiq_integration_spec.rb

@@ -50,7 +50,7 @@ if defined?(Sidekiq)
 
       expect(event.fetch('event_type')).to eq('backend_exception')
       expect(event.fetch('correlation')).to include('trace_id' => 'trace-chain-1')
-      expect(event.fetch('payload').fetch('context').fetch('job')).to include(
+      expect(event.fetch('context').fetch('job')).to include(
         'class' => 'CheckoutWorker',
         'queue' => 'critical',
         'jid' => 'jid-chain-1'

data/spec/sidekiq_middleware_spec.rb

@@ -40,7 +40,7 @@ RSpec.describe DebugBundle::Sidekiq::ServerMiddleware do
 
     expect(event.fetch('event_type')).to eq('backend_exception')
     expect(event.fetch('correlation')).to include('trace_id' => 'trace-job-1')
-    expect(event.fetch('payload').fetch('context').fetch('job')).to include(
+    expect(event.fetch('context').fetch('job')).to include(
       'class' => 'CheckoutWorker',
       'queue' => 'critical',
       'jid' => 'jid-1',

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: debugbundle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - DebugBundle
 bindir: exe
 cert_chain: []
-date: 2026-05-31 00:00:00.000000000 Z
+date: 2026-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64