apm_bro 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d47832a9c956542a7b0e88d048d2f8760f7971df069a7e06fec92822ad79e67e
-  data.tar.gz: 2f536dfe0c55b9b46fae2a4f5b77f5c873b39c59ef71ec06052951d02192a4c7
+  metadata.gz: 7bf4fc110108b143a2f2e608090ae8c75a5882f8634ef1c01d0ddb949d41e54a
+  data.tar.gz: 7c5bd6915f805032ca63b73ab9325ce64b262d8489c2842b45c28a02e84b961d
 SHA512:
-  metadata.gz: 1e288923b2a58952d927cee3c85e3e242fe22baf79acccefd79ce0933a3b6c7db786faae7b4e96bd9f5687f9aed48c78e9bc493440809a65d27eaf9a31cb51d2
-  data.tar.gz: 02cd07fa51270bdda5a7ada77463435491cd99e7999ea4162864547454f99ce9846ed78b9cfc9c1df0e5095e7145da43d9822bd790786e1c77701f94a9705d34
+  metadata.gz: 601ed7213bb2dc1b551ba8d8e47944492bd67b727b0747aaad9c60b5ce13fb2b728b218a43eb0775e1479f5684ea1721dd0b9310bd25d2ccfcfcfad8cfc9e439
+  data.tar.gz: b8a2e25e5c0369d7bd58fe058ef7d524bdc42c7cc22739d30f9ad0956338370f63578aa10688869c817148451b46d7b9e1dab8835c4e7f33531cd9146a04ed88

data/README.md

@@ -28,41 +28,6 @@ ApmBro.configure do |cfg|
 end
 ```
 
-## User Email Tracking
-
-ApmBro can track the email of the user making requests, which is useful for debugging user-specific issues and understanding user behavior patterns.
-
-### Configuration
-
-Enable user email tracking in your Rails configuration:
-
-```ruby
-# In config/application.rb or environments/*.rb
-ApmBro.configure do |config|
-  config.user_email_tracking_enabled = true
-end
-```
-
-### Default Email Extraction
-
-By default, ApmBro will try to extract user email from these sources (in order of priority):
-
-1. **`current_user.email`** - Most common in Rails apps with authentication
-2. **Request parameters** - `user_email` or `email` in params
-3. **HTTP headers** - `X-User-Email` or `HTTP_X_USER_EMAIL`
-4. **Session data** - `user_email` in session
-
-### Custom Email Extractor
-
-In progress
-
-### Security Considerations
-
-- User email tracking is **disabled by default** for privacy
-- Only enable when necessary for debugging or analytics
-- Consider your data privacy requirements and regulations
-- The email is included in all request payloads sent to our APM endpoint
-
 ## Request Sampling
 
 ApmBro supports configurable request sampling to reduce the volume of metrics sent to your APM endpoint, which is useful for high-traffic applications.
@@ -143,6 +108,54 @@ ApmBro automatically tracks SQL queries executed during each request and job. Ea
 - `cached` - Whether the query was cached
 - `connection_id` - Database connection ID
 - `trace` - Call stack showing where the query was executed
+- `explain_plan` - Query execution plan (when EXPLAIN ANALYZE is enabled, see below)
+
+## Automatic EXPLAIN ANALYZE for Slow Queries
+
+ApmBro can automatically run `EXPLAIN ANALYZE` on slow SQL queries to help you understand query performance and identify optimization opportunities. This feature runs in the background and doesn't block your application requests.
+
+### How It Works
+
+- **Automatic Detection**: When a query exceeds the configured threshold, ApmBro automatically captures its execution plan
+- **Background Execution**: EXPLAIN ANALYZE runs in a separate thread using a dedicated database connection, so it never blocks your application
+- **Database Support**: Works with PostgreSQL, MySQL, SQLite, and other databases
+- **Smart Filtering**: Automatically skips transaction queries (BEGIN, COMMIT, ROLLBACK) and other queries that don't benefit from EXPLAIN
+
+### Configuration
+
+- **`explain_analyze_enabled`** (default: `false`) - Set to `true` to enable automatic EXPLAIN ANALYZE
+- **`slow_query_threshold_ms`** (default: `500`) - Queries taking longer than this threshold will have their execution plan captured
+
+### Example Configuration
+
+```ruby
+ApmBro.configure do |config|
+  config.api_key = ENV['APM_BRO_API_KEY']
+  config.enabled = true
+  
+  # Enable EXPLAIN ANALYZE for queries slower than 500ms
+  config.explain_analyze_enabled = true
+  config.slow_query_threshold_ms = 500
+  
+  # Or use a higher threshold for production
+  # config.slow_query_threshold_ms = 1000  # Only explain queries > 1 second
+end
+```
+
+### What You Get
+
+When a slow query is detected, the `explain_plan` field in the SQL query data will contain:
+- **PostgreSQL**: Full EXPLAIN ANALYZE output with buffer usage statistics
+- **MySQL**: EXPLAIN ANALYZE output showing actual execution times
+- **SQLite**: EXPLAIN QUERY PLAN output
+- **Other databases**: Standard EXPLAIN output
+
+This execution plan helps you:
+- Identify missing indexes
+- Understand query execution order
+- Spot full table scans
+- Optimize JOIN operations
+- Analyze buffer and cache usage (PostgreSQL)
 
 ## View Rendering Tracking
 

data/lib/apm_bro/cache_subscriber.rb

@@ -19,18 +19,16 @@ module ApmBro
 
     def self.subscribe!
       EVENTS.each do |event_name|
-        begin
-          ActiveSupport::Notifications.subscribe(event_name) do |name, started, finished, _unique_id, data|
-            next unless Thread.current[THREAD_LOCAL_KEY]
+        ActiveSupport::Notifications.subscribe(event_name) do |name, started, finished, _unique_id, data|
+          next unless Thread.current[THREAD_LOCAL_KEY]
 
-            duration_ms = ((finished - started) * 1000.0).round(2)
-            event = build_event(name, data, duration_ms)
-            Thread.current[THREAD_LOCAL_KEY] << event if event
-          end
-        rescue StandardError
+          duration_ms = ((finished - started) * 1000.0).round(2)
+          event = build_event(name, data, duration_ms)
+          Thread.current[THREAD_LOCAL_KEY] << event if event
         end
+      rescue
       end
-    rescue StandardError
+    rescue
       # Never raise from instrumentation install
     end
 
@@ -47,7 +45,7 @@ module ApmBro
     def self.build_event(name, data, duration_ms)
       return nil unless data.is_a?(Hash)
 
-      base = {
+      {
         event: name,
         duration_ms: duration_ms,
         key: safe_key(data[:key]),
@@ -57,27 +55,23 @@ module ApmBro
         namespace: safe_namespace(data[:namespace]),
         at: Time.now.utc.to_i
       }
-
-      base
-    rescue StandardError
+    rescue
       nil
     end
 
     def self.safe_key(key)
       return nil if key.nil?
       s = key.to_s
-      s.length > 200 ? s[0, 200] + "…" : s
-    rescue StandardError
+      (s.length > 200) ? s[0, 200] + "…" : s
+    rescue
       nil
     end
 
     def self.safe_keys_count(keys)
       if keys.respond_to?(:size)
         keys.size
-      else
-        nil
       end
-    rescue StandardError
+    rescue
       nil
     end
 
@@ -88,13 +82,13 @@ module ApmBro
       else
         store.class.name
       end
-    rescue StandardError
+    rescue
       nil
     end
 
     def self.safe_namespace(ns)
       ns.to_s[0, 100]
-    rescue StandardError
+    rescue
       nil
     end
 
@@ -104,13 +98,9 @@ module ApmBro
         true
       when "cache_read.active_support"
         !!data[:hit]
-      else
-        nil
       end
-    rescue StandardError
+    rescue
       nil
     end
   end
 end
-
-

data/lib/apm_bro/circuit_breaker.rb

@@ -20,7 +20,7 @@ module ApmBro
       @failure_threshold = failure_threshold
       @recovery_timeout = recovery_timeout
       @retry_timeout = retry_timeout
-      
+
       @state = CLOSED
       @failure_count = 0
       @last_failure_time = nil
@@ -43,21 +43,13 @@ module ApmBro
       end
     end
 
-    def state
-      @state
-    end
+    attr_reader :state
 
-    def failure_count
-      @failure_count
-    end
+    attr_reader :failure_count
 
-    def last_failure_time
-      @last_failure_time
-    end
+    attr_reader :last_failure_time
 
-    def last_success_time
-      @last_success_time
-    end
+    attr_reader :last_success_time
 
     def reset!
       @state = CLOSED
@@ -76,7 +68,7 @@ module ApmBro
 
     def should_attempt_reset?
       return false unless @last_failure_time
-      
+
       # Try to reset after recovery timeout
       elapsed = Time.now - @last_failure_time
       elapsed >= @recovery_timeout
@@ -86,7 +78,7 @@ module ApmBro
 
     def execute_with_monitoring(&block)
       result = block.call
-      
+
       if success?(result)
         on_success
         result
@@ -94,7 +86,7 @@ module ApmBro
         on_failure
         result
       end
-    rescue StandardError => e
+    rescue => e
       on_failure
       raise e
     end
@@ -113,7 +105,7 @@ module ApmBro
     def on_failure
       @failure_count += 1
       @last_failure_time = Time.now
-      
+
       # If we're in half-open state and get a failure, go back to open
       if @state == HALF_OPEN
         @state = OPEN

data/lib/apm_bro/client.rb

@@ -23,7 +23,7 @@ module ApmBro
       end
 
       api_key = @configuration.resolve_api_key
-      
+
       if api_key.nil?
         return
       end
@@ -50,7 +50,7 @@ module ApmBro
 
     def create_circuit_breaker
       return nil unless @configuration.circuit_breaker_enabled
-      
+
       CircuitBreaker.new(
         failure_threshold: @configuration.circuit_breaker_failure_threshold,
         recovery_timeout: @configuration.circuit_breaker_recovery_timeout,
@@ -59,8 +59,8 @@ module ApmBro
     end
 
     def make_http_request(event_name, payload, api_key)
-      endpoint_url = @configuration.respond_to?(:ruby_dev) && @configuration.ruby_dev ?
-          'http://localhost:3100/apm/v1/metrics' :
+      endpoint_url = (@configuration.respond_to?(:ruby_dev) && @configuration.ruby_dev) ?
+          "http://localhost:3100/apm/v1/metrics" :
           "https://www.deadbro.com/apm/v1/metrics"
 
       uri = URI.parse(endpoint_url)
@@ -72,43 +72,37 @@ module ApmBro
       request = Net::HTTP::Post.new(uri.request_uri)
       request["Content-Type"] = "application/json"
       request["Authorization"] = "Bearer #{api_key}"
-      body = { event: event_name, payload: payload, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id }
+      body = {event: event_name, payload: payload, sent_at: Time.now.utc.iso8601, revision: @configuration.resolve_deploy_id}
       request.body = JSON.dump(body)
 
       # Fire-and-forget using a short-lived thread to avoid blocking the request cycle.
       Thread.new do
-        begin
-          response = http.request(request)
-
-          if response
-            # Update circuit breaker based on response
-            if @circuit_breaker && @configuration.circuit_breaker_enabled
-              if response.is_a?(Net::HTTPSuccess)
-                @circuit_breaker.send(:on_success)
-              else
-                @circuit_breaker.send(:on_failure)
-              end
-            end
-          else
-            # Treat nil response as failure for circuit breaker
-            if @circuit_breaker && @configuration.circuit_breaker_enabled
+        response = http.request(request)
+
+        if response
+          # Update circuit breaker based on response
+          if @circuit_breaker && @configuration.circuit_breaker_enabled
+            if response.is_a?(Net::HTTPSuccess)
+              @circuit_breaker.send(:on_success)
+            else
               @circuit_breaker.send(:on_failure)
             end
           end
-          
-          response
-        rescue Timeout::Error => e
-          
-          # Update circuit breaker on timeout
-          if @circuit_breaker && @configuration.circuit_breaker_enabled
-            @circuit_breaker.send(:on_failure)
-          end
-        rescue StandardError => e
-          
-          # Update circuit breaker on exception
-          if @circuit_breaker && @configuration.circuit_breaker_enabled
-            @circuit_breaker.send(:on_failure)
-          end
+        elsif @circuit_breaker && @configuration.circuit_breaker_enabled
+          # Treat nil response as failure for circuit breaker
+          @circuit_breaker.send(:on_failure)
+        end
+
+        response
+      rescue Timeout::Error
+        # Update circuit breaker on timeout
+        if @circuit_breaker && @configuration.circuit_breaker_enabled
+          @circuit_breaker.send(:on_failure)
+        end
+      rescue
+        # Update circuit breaker on exception
+        if @circuit_breaker && @configuration.circuit_breaker_enabled
+          @circuit_breaker.send(:on_failure)
         end
       end
 
@@ -124,5 +118,3 @@ module ApmBro
     end
   end
 end
-
-

data/lib/apm_bro/configuration.rb

@@ -2,9 +2,9 @@
 
 module ApmBro
   class Configuration
-    DEFAULT_ENDPOINT_PATH = "/v1/metrics".freeze
+    DEFAULT_ENDPOINT_PATH = "/v1/metrics"
 
-    attr_accessor :api_key, :endpoint_url, :open_timeout, :read_timeout, :enabled, :ruby_dev, :memory_tracking_enabled, :allocation_tracking_enabled, :circuit_breaker_enabled, :circuit_breaker_failure_threshold, :circuit_breaker_recovery_timeout, :circuit_breaker_retry_timeout, :user_email_tracking_enabled, :user_email_extractor, :sample_rate, :excluded_controllers, :excluded_jobs, :excluded_controller_actions, :deploy_id
+    attr_accessor :api_key, :endpoint_url, :open_timeout, :read_timeout, :enabled, :ruby_dev, :memory_tracking_enabled, :allocation_tracking_enabled, :circuit_breaker_enabled, :circuit_breaker_failure_threshold, :circuit_breaker_recovery_timeout, :circuit_breaker_retry_timeout, :sample_rate, :excluded_controllers, :excluded_jobs, :excluded_controller_actions, :deploy_id, :slow_query_threshold_ms, :explain_analyze_enabled
 
     def initialize
       @api_key = nil
@@ -19,13 +19,13 @@ module ApmBro
       @circuit_breaker_failure_threshold = 3
       @circuit_breaker_recovery_timeout = 60 # seconds
       @circuit_breaker_retry_timeout = 300 # seconds
-      @user_email_tracking_enabled = false
-      @user_email_extractor = nil
       @sample_rate = 100 # 100% sampling by default
       @excluded_controllers = []
       @excluded_jobs = []
       @excluded_controller_actions = []
       @deploy_id = resolve_deploy_id
+      @slow_query_threshold_ms = 500 # Default: 500ms
+      @explain_analyze_enabled = false # Enable EXPLAIN ANALYZE for slow queries by default
     end
 
     def resolve_api_key
@@ -81,6 +81,9 @@ module ApmBro
       end
 
       # Prefer explicit env var, then common platform-specific var
+      apm_bro_deploy_id = ENV["APM_BRO_DEPLOY_ID"]
+      return apm_bro_deploy_id if present?(apm_bro_deploy_id)
+
       env_val = ENV["GIT_REV"]
       return env_val if present?(env_val)
 
@@ -91,6 +94,12 @@ module ApmBro
       ApmBro.process_deploy_id
     end
 
+    def excluded_controller?(controller_name)
+      list = resolve_excluded_controllers
+      return false if list.nil? || list.empty?
+      list.any? { |pat| match_name_or_pattern?(controller_name, pat) }
+    end
+
     def excluded_job?(job_class_name)
       list = resolve_excluded_jobs
       return false if list.nil? || list.empty?
@@ -105,14 +114,58 @@ module ApmBro
     end
 
     def resolve_excluded_controller_actions
-      return @excluded_controller_actions if @excluded_controller_actions && !@excluded_controller_actions.empty?
+      # Collect patterns from @excluded_controller_actions
+      patterns = []
+      if @excluded_controller_actions && !@excluded_controller_actions.empty?
+        patterns.concat(Array(@excluded_controller_actions))
+      end
+
+      # Also check @excluded_controllers for patterns containing '#' (controller action patterns)
+      if @excluded_controllers && !@excluded_controllers.empty?
+        action_patterns = Array(@excluded_controllers).select { |pat| pat.to_s.include?("#") }
+        patterns.concat(action_patterns)
+      end
+
+      return patterns if !patterns.empty?
 
       if defined?(Rails)
         list = fetch_from_rails_settings(%w[apm_bro excluded_controller_actions])
-        return Array(list) if list
+        if list
+          rails_patterns = Array(list)
+          # Also check excluded_controllers from Rails settings for action patterns
+          controllers_list = fetch_from_rails_settings(%w[apm_bro excluded_controllers])
+          if controllers_list
+            action_patterns = Array(controllers_list).select { |pat| pat.to_s.include?("#") }
+            rails_patterns.concat(action_patterns)
+          end
+          return rails_patterns if !rails_patterns.empty?
+        end
       end
 
       env = ENV["APM_BRO_EXCLUDED_CONTROLLER_ACTIONS"]
+      if env && !env.strip.empty?
+        env_patterns = env.split(",").map(&:strip)
+        # Also check excluded_controllers env var for action patterns
+        controllers_env = ENV["APM_BRO_EXCLUDED_CONTROLLERS"]
+        if controllers_env && !controllers_env.strip.empty?
+          action_patterns = controllers_env.split(",").map(&:strip).select { |pat| pat.include?("#") }
+          env_patterns.concat(action_patterns)
+        end
+        return env_patterns if !env_patterns.empty?
+      end
+
+      []
+    end
+
+    def resolve_excluded_controllers
+      return @excluded_controllers if @excluded_controllers && !@excluded_controllers.empty?
+
+      if defined?(Rails)
+        list = fetch_from_rails_settings(%w[apm_bro excluded_controllers])
+        return Array(list) if list
+      end
+
+      env = ENV["APM_BRO_EXCLUDED_CONTROLLERS"]
       return env.split(",").map(&:strip) if env && !env.strip.empty?
 
       []
@@ -136,29 +189,23 @@ module ApmBro
       sample_rate = resolve_sample_rate
       return true if sample_rate >= 100
       return false if sample_rate <= 0
-      
+
       # Generate random number 1-100 and check if it's within sample rate
       rand(1..100) <= sample_rate
     end
 
     def sample_rate=(value)
-      unless value.is_a?(Integer) && value >= 1 && value <= 100
-        raise ArgumentError, "Sample rate must be an integer between 1 and 100, got: #{value.inspect}"
+      # Allow nil to use default/resolved value
+      if value.nil?
+        @sample_rate = nil
+        return
       end
-      @sample_rate = value
-    end
-
-    def extract_user_email(request_data)
-      ap request_data[:headers].class
-      return nil unless @user_email_tracking_enabled
 
-      # If a custom extractor is provided, use it
-      if @user_email_extractor.respond_to?(:call)
-        return @user_email_extractor.call(request_data)
+      # Allow 0 to disable sampling, or 1-100 for percentage
+      unless value.is_a?(Integer) && value >= 0 && value <= 100
+        raise ArgumentError, "Sample rate must be an integer between 0 and 100, got: #{value.inspect}"
       end
-
-      # Default extraction logic
-      extract_user_email_from_request(request_data)
+      @sample_rate = value
     end
 
     private
@@ -171,10 +218,18 @@ module ApmBro
       return false if name.nil? || pattern.nil?
       pat = pattern.to_s
       return !!(name.to_s == pat) unless pat.include?("*")
-      # Convert simple wildcard pattern (e.g., "Admin::*") to regex
-      regex = Regexp.new("^" + Regexp.escape(pat).gsub(/\\\*/,'[^:]*') + "$")
+      
+      # For controller action patterns (containing '#'), use .* to match any characters including colons
+      # For controller-only patterns, use [^:]* to match namespace segments
+      if pat.include?("#")
+        # Controller action pattern: allow * to match any characters including colons
+        regex = Regexp.new("^" + Regexp.escape(pat).gsub("\\*", ".*") + "$")
+      else
+        # Controller-only pattern: use [^:]* to match namespace segments
+        regex = Regexp.new("^" + Regexp.escape(pat).gsub("\\*", "[^:]*") + "$")
+      end
       !!(name.to_s =~ regex)
-    rescue StandardError
+    rescue
       false
     end
 
@@ -182,12 +237,16 @@ module ApmBro
       # Try Rails.application.config_for(:apm_bro)
       begin
         if Rails.respond_to?(:application) && Rails.application.respond_to?(:config_for)
-          config = Rails.application.config_for(:apm_bro) rescue nil
+          config = begin
+            Rails.application.config_for(:apm_bro)
+          rescue
+            nil
+          end
           if config && config.is_a?(Hash)
             return dig_hash(config, *Array(path_keys))
           end
         end
-      rescue StandardError
+      rescue
       end
 
       # Try Rails.application.credentials
@@ -198,7 +257,7 @@ module ApmBro
           value = dig_credentials(creds, *Array(path_keys))
           return value if present?(value)
         end
-      rescue StandardError
+      rescue
       end
 
       # Try Rails.application.config.x.apm_bro.api_key
@@ -208,7 +267,7 @@ module ApmBro
           config_x = x.apm_bro
           return config_x.public_send(Array(path_keys).last) if config_x.respond_to?(Array(path_keys).last)
         end
-      rescue StandardError
+      rescue
       end
 
       nil
@@ -248,42 +307,5 @@ module ApmBro
       path = "/#{path}" unless path.start_with?("/")
       base + path
     end
-
-    def extract_user_email_from_request(request_data)
-      # Try to get user email from various common sources
-      return nil unless request_data.is_a?(Hash)
-
-      # Check for current_user.email (common in Rails apps)
-      if request_data[:current_user]&.respond_to?(:email)
-        return request_data[:current_user].email
-      end
-
-      # Check for user.email in params
-      if request_data[:params]&.is_a?(Hash)
-        user_email = request_data[:params]["user_email"] || 
-                     request_data[:params][:user_email] ||
-                     request_data[:params]["email"] || 
-                     request_data[:params][:email]
-        return user_email if user_email.present?
-      end
-
-      # Check for user email in headers
-      if request_data[:request]&.respond_to?(:headers)
-        headers = request_data[:request].headers
-        return headers["X-User-Email"] if headers["X-User-Email"].present?
-        return headers["HTTP_X_USER_EMAIL"] if headers["HTTP_X_USER_EMAIL"].present?
-      end
-
-      # Check for user email in session
-      if request_data[:session]&.is_a?(Hash)
-        return request_data[:session]["user_email"] || request_data[:session][:user_email]
-      end
-
-      nil
-    rescue StandardError
-      nil
-    end
   end
 end
-
-