logister-ruby 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ffbd6d90538c5e0cf39deab256aaf1b0c5c15f5899051e67cfedc6657ac4b5
-  data.tar.gz: af860be23dab9bd73c8d394e9b1b91b6076f62a6a5f67272991afafba75d83a6
+  metadata.gz: 2f3f9f67b976e92e535974c8a243b14f011088bca57e5ab3dc0385de6ba4c003
+  data.tar.gz: d744d4996b00d27a2e51e54b5b91134f4c0ae049c76270a41c7ef93deec04189
 SHA512:
-  metadata.gz: 59875a74fdee52e22b697b80e4840ba070db495eb905b47d6522576f2e745d4f64081bf0fbf5f8e7cfc48917466c1a8724a389fe36f728b29080ff71dcb79165
-  data.tar.gz: fb8e6d1898621e57f2fdb9c66a3e08b655151f3f06ed830e5e2a8c96313c4b1e181c1281846a2a62ada0d7332d8a9631630bb5b9abe9bf7a4fc4f14e04a781a3
+  metadata.gz: 9a8dbbbdde7778369654c287f9076a89efaadf5a3d03bdd5cb064546bac2b2b72bd53d641b424d3b4bc3cefecfce0bfd1b0a9c50714a8c58506b21c6765b8902
+  data.tar.gz: 823a8c724d3aee752558e9936c23f924c774157c83a7b997885ba19a8dbf6aa835277506101f2eea341dde05923353f58127f6b94c0d8cbb6711823c5f43c946

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/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/version.rb

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

data/lib/logister.rb

@@ -28,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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Logister