logister-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc4c81cdfeef4f713ac40e5324e8d845da2190dacfcaf9e295e0da5d4d1a75a1
-  data.tar.gz: 3fdb07135981647437afae77a787645c89143847619edc46969f121b750a0c90
+  metadata.gz: 2f3f9f67b976e92e535974c8a243b14f011088bca57e5ab3dc0385de6ba4c003
+  data.tar.gz: d744d4996b00d27a2e51e54b5b91134f4c0ae049c76270a41c7ef93deec04189
 SHA512:
-  metadata.gz: 3d53d3e80a01927a2ae08fec30d30eeb9d7d7987c3e5c1d624433c0683fc25b232675208e62ff7e563a9cbefcd1ae33e0bae32c9a6deb0fb084e307be0755e40
-  data.tar.gz: c869dc8bb9c120b90d7f13b05ee291f1a82053ff3523a2bd8a4eafdd4159ee8553f975d0afc2eda97f9441a3b25df6f5c0bbf2c813b575f23b01386147e8eec9
+  metadata.gz: 9a8dbbbdde7778369654c287f9076a89efaadf5a3d03bdd5cb064546bac2b2b72bd53d641b424d3b4bc3cefecfce0bfd1b0a9c50714a8c58506b21c6765b8902
+  data.tar.gz: 823a8c724d3aee752558e9936c23f924c774157c83a7b997885ba19a8dbf6aa835277506101f2eea341dde05923353f58127f6b94c0d8cbb6711823c5f43c946

data/README.md

@@ -56,6 +56,20 @@ end
 
 If Rails is present, the gem installs middleware that reports unhandled exceptions automatically.
 
+## Database load metrics (ActiveRecord)
+
+You can capture SQL timing metrics using ActiveSupport notifications:
+
+```ruby
+Logister.configure do |config|
+  config.capture_db_metrics = true
+  config.db_metric_min_duration_ms = 10.0
+  config.db_metric_sample_rate = 1.0
+end
+```
+
+This emits metric events with `message: "db.query"` and context fields such as `duration_ms`, `name`, `sql`, and `binds_count`.
+
 ## Manual reporting
 
 ```ruby

data/lib/generators/logister/templates/logister.rb

@@ -17,6 +17,11 @@ Logister.configure do |config|
   config.ignore_exceptions = []
   config.ignore_paths = []
 
+  # Optional ActiveRecord SQL instrumentation.
+  config.capture_db_metrics = false
+  config.db_metric_min_duration_ms = 10.0
+  config.db_metric_sample_rate = 1.0
+
   config.before_notify = lambda do |payload|
     payload
   end

data/lib/logister/configuration.rb

@@ -4,7 +4,8 @@ module Logister
   class Configuration
     attr_accessor :api_key, :endpoint, :environment, :service, :release, :enabled, :timeout_seconds, :logger,
                   :ignore_exceptions, :ignore_environments, :ignore_paths, :before_notify,
-                  :async, :queue_size, :max_retries, :retry_base_interval
+                  :async, :queue_size, :max_retries, :retry_base_interval,
+                  :capture_db_metrics, :db_metric_min_duration_ms, :db_metric_sample_rate
 
     def initialize
       @api_key = ENV['LOGISTER_API_KEY']
@@ -26,6 +27,10 @@ module Logister
       @queue_size = 1000
       @max_retries = 3
       @retry_base_interval = 0.5
+
+      @capture_db_metrics = false
+      @db_metric_min_duration_ms = 0.0
+      @db_metric_sample_rate = 1.0
     end
   end
 end

data/lib/logister/middleware.rb

@@ -1,3 +1,5 @@
+require 'socket'
+
 module Logister
   class Middleware
     def initialize(app)
@@ -10,12 +12,63 @@ module Logister
       Logister.report_error(
         e,
         context: {
-          request_id: env['action_dispatch.request_id'],
-          path: env['PATH_INFO'],
-          method: env['REQUEST_METHOD']
+          request: build_request_context(env),
+          app:     build_app_context
         }
       )
       raise
     end
+
+    private
+
+    def build_request_context(env)
+      ctx = {
+        id:     env['action_dispatch.request_id'],
+        path:   env['PATH_INFO'],
+        method: env['REQUEST_METHOD'],
+        ip:     remote_ip(env),
+        user_agent: env['HTTP_USER_AGENT']
+      }
+
+      # Params — available if ActionDispatch has already parsed them
+      if (params = env['action_dispatch.request.parameters'])
+        ctx[:params] = filter_params(params)
+      end
+
+      ctx.compact
+    end
+
+    def build_app_context
+      ctx = {
+        ruby:     RUBY_VERSION,
+        hostname: hostname
+      }
+      ctx[:rails] = Rails::VERSION::STRING if defined?(Rails::VERSION)
+      ctx
+    end
+
+    # Respect X-Forwarded-For set by proxies, fall back to REMOTE_ADDR
+    def remote_ip(env)
+      forwarded = env['HTTP_X_FORWARDED_FOR'].to_s.split(',').first&.strip
+      forwarded.nil? || forwarded.empty? ? env['REMOTE_ADDR'] : forwarded
+    end
+
+    # Remove sensitive parameter values the same way Rails does
+    SENSITIVE_PARAMS = %w[password password_confirmation token secret api_key
+                          credit_card cvv ssn].freeze
+
+    def filter_params(params)
+      params.each_with_object({}) do |(k, v), h|
+        h[k] = SENSITIVE_PARAMS.any? { |s| k.to_s.downcase.include?(s) } ? '[FILTERED]' : v
+      end
+    rescue StandardError
+      {}
+    end
+
+    def hostname
+      Socket.gethostname
+    rescue StandardError
+      'unknown'
+    end
   end
 end

data/lib/logister/railtie.rb

@@ -21,6 +21,9 @@ module Logister
         copy_setting(app, config, :queue_size)
         copy_setting(app, config, :max_retries)
         copy_setting(app, config, :retry_base_interval)
+        copy_setting(app, config, :capture_db_metrics)
+        copy_setting(app, config, :db_metric_min_duration_ms)
+        copy_setting(app, config, :db_metric_sample_rate)
       end
     end
 
@@ -28,6 +31,10 @@ module Logister
       app.middleware.use Logister::Middleware
     end
 
+    initializer 'logister.sql_subscriber' do
+      Logister::SqlSubscriber.install!
+    end
+
     private
 
     def copy_setting(app, config, key)

data/lib/logister/reporter.rb

@@ -14,12 +14,15 @@ module Logister
       return false if ignored_exception?(exception)
       return false if ignored_path?(context)
 
+      merged_context = context.dup
+      merged_context[:user] = current_user_context if current_user_context
+
       payload = build_payload(
         event_type: 'error',
         level: level,
         message: "#{exception.class}: #{exception.message}",
         fingerprint: fingerprint || default_fingerprint(exception),
-        context: context.merge(
+        context: merged_context.merge(
           exception: {
             class: exception.class.to_s,
             message: exception.message.to_s,
@@ -53,6 +56,20 @@ module Logister
       @client.publish(payload)
     end
 
+    # Store user info for the current thread so it is automatically attached to
+    # every error reported during this request.
+    #
+    #   Logister.set_user(id: current_user.id, email: current_user.email, name: current_user.name)
+    #
+    def set_user(id: nil, email: nil, name: nil, **extra)
+      ctx = { id: id, email: email, name: name }.merge(extra).compact
+      Thread.current[:logister_user] = ctx.empty? ? nil : ctx
+    end
+
+    def clear_user
+      Thread.current[:logister_user] = nil
+    end
+
     def flush(timeout: 2)
       @client.flush(timeout: timeout)
     end
@@ -63,6 +80,10 @@ module Logister
 
     private
 
+    def current_user_context
+      Thread.current[:logister_user]
+    end
+
     def build_payload(event_type:, level:, message:, fingerprint:, context:)
       {
         event_type: event_type,
@@ -118,7 +139,36 @@ module Logister
     end
 
     def default_fingerprint(exception)
-      Digest::SHA256.hexdigest("#{exception.class}|#{exception.message}")[0, 32]
+      # Prefer class + first backtrace location so that errors with dynamic
+      # values in their message (e.g. "Couldn't find User with 'id'=42") still
+      # group together across different IDs / UUIDs.
+      location = Array(exception.backtrace).first.to_s
+                                           .sub(/:in\s+.+$/, '')  # strip method name
+                                           .sub(/\A.*\/gems\//, 'gems/')  # normalise gem paths
+                                           .sub(/\A#{Regexp.escape(Dir.pwd.to_s)}\//, '')  # strip app root
+
+      if location.empty?
+        # No backtrace available — scrub common dynamic tokens from the message
+        # before hashing so that e.g. "id=42" and "id=99" hash the same way.
+        scrubbed = scrub_dynamic_values(exception.message.to_s)
+        Digest::SHA256.hexdigest("#{exception.class}|#{scrubbed}")[0, 32]
+      else
+        Digest::SHA256.hexdigest("#{exception.class}|#{location}")[0, 32]
+      end
+    end
+
+    # Strip values that tend to vary per-occurrence but carry no grouping signal:
+    #   - numeric IDs:     id=42, 'id'=42, id: 42
+    #   - UUIDs
+    #   - hex digests (≥8 hex chars)
+    #   - quoted string values in ActiveRecord-style messages
+    def scrub_dynamic_values(message)
+      message
+        .gsub(/\b(id['"]?\s*[=:]\s*)\d+/i,        '\1?')
+        .gsub(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i, '?')
+        .gsub(/\b[0-9a-f]{8,}\b/,                  '?')
+        .gsub(/'[^']{1,64}'/,                       '?')
+        .gsub(/\d+/,                                '?')
     end
   end
 end

data/lib/logister/sql_subscriber.rb

@@ -0,0 +1,57 @@
+module Logister
+  class SqlSubscriber
+    IGNORED_SQL_NAMES = %w[SCHEMA TRANSACTION].freeze
+
+    class << self
+      def install!
+        return if @installed
+
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |name, started, finished, _id, payload|
+          handle_sql_event(name, started, finished, payload)
+        end
+
+        @installed = true
+      end
+
+      private
+
+      def handle_sql_event(_name, started, finished, payload)
+        config = Logister.configuration
+        return unless config.capture_db_metrics
+        return if payload[:cached]
+        return if IGNORED_SQL_NAMES.include?(payload[:name].to_s)
+
+        duration_ms = (finished - started) * 1000.0
+        return if duration_ms < config.db_metric_min_duration_ms.to_f
+        return if sampled_out?(config.db_metric_sample_rate)
+
+        level = duration_ms >= 500 ? 'warn' : 'info'
+
+        Logister.report_metric(
+          message: 'db.query',
+          level: level,
+          context: {
+            duration_ms: duration_ms.round(2),
+            name: payload[:name].to_s,
+            sql: payload[:sql].to_s,
+            cached: false,
+            binds_count: Array(payload[:binds]).size
+          },
+          tags: {
+            category: 'database'
+          }
+        )
+      rescue StandardError => e
+        config.logger.warn("logister sql subscriber failed: #{e.class} #{e.message}")
+      end
+
+      def sampled_out?(sample_rate)
+        rate = sample_rate.to_f
+        return true if rate <= 0.0
+        return false if rate >= 1.0
+
+        rand > rate
+      end
+    end
+  end
+end

data/lib/logister/version.rb

@@ -1,3 +1,3 @@
 module Logister
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/logister.rb

@@ -3,6 +3,7 @@ require_relative 'logister/configuration'
 require_relative 'logister/client'
 require_relative 'logister/reporter'
 require_relative 'logister/middleware'
+require_relative 'logister/sql_subscriber'
 
 module Logister
   class << self
@@ -27,6 +28,14 @@ module Logister
       reporter.report_metric(**kwargs)
     end
 
+    def set_user(id: nil, email: nil, name: nil, **extra)
+      reporter.set_user(id: id, email: email, name: name, **extra)
+    end
+
+    def clear_user
+      reporter.clear_user
+    end
+
     def flush(timeout: 2)
       reporter.flush(timeout: timeout)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logister-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Logister
@@ -55,6 +55,7 @@ files:
 - lib/logister/middleware.rb
 - lib/logister/railtie.rb
 - lib/logister/reporter.rb
+- lib/logister/sql_subscriber.rb
 - lib/logister/version.rb
 - logister-ruby.gemspec
 homepage: https://logister.org