rails_exception_log 1.0.0

data/lib/rails_exception_log/exception_loggable.rb

@@ -0,0 +1,89 @@
+require 'digest'
+
+module RailsExceptionLog
+  module ExceptionLoggable
+    extend ActiveSupport::Concern
+
+    included do
+      after_action :log_exception_to_db, if: :exception_loggable?
+    end
+
+    def log_exception_handler
+      log_exception_to_db
+      raise exception
+    end
+
+    private
+
+    def exception_loggable?
+      return false if exception.nil?
+      return false if is_a?(RailsExceptionLog::LoggedExceptionsController)
+      return false if ENV['RAILS_EXCEPTION_LOG_DISABLED'] == 'true'
+      return false unless rate_limit_allow?
+
+      true
+    end
+
+    def rate_limit_allow?
+      return true if Rails.env.development?
+
+      key = "exception_log_rate_limit:#{request&.remote_ip}"
+      count = Rails.cache.fetch(key, expires_in: 1.minute) do
+        0
+      end
+
+      max = RailsExceptionLog.max_requests_per_minute || 60
+      return false if count >= max
+
+      Rails.cache.write(key, count + 1, expires_in: 1.minute)
+      true
+    end
+
+    def log_exception_to_db
+      return unless exception || defined?(@exception) && @exception
+
+      exc = exception || @exception
+      return unless exc
+
+      begin
+        user = current_user if respond_to?(:current_user)
+
+        logged_exception = RailsExceptionLog::LoggedException.create_or_update_with_fingerprint!(
+          exc,
+          request,
+          user: user
+        )
+
+        if respond_to?(:exception_data)
+          data = exception_data.is_a?(Proc) ? instance_exec(self, &exception_data) : send(exception_data)
+          logged_exception.update!(exception_data: data) if data.present?
+        end
+
+        RailsExceptionLog.after_log_exception.call(logged_exception) if RailsExceptionLog.after_log_exception
+      rescue StandardError => e
+        Rails.logger.error "Failed to log exception: #{e.message}"
+      end
+    end
+
+    def request_params_without_passwords
+      return {} unless request&.params
+
+      params_hash = request.params.deep_dup
+      filter_passwords(params_hash)
+      params_hash
+    end
+
+    def filter_passwords(hash)
+      hash.each do |key, value|
+        if key.to_s =~ /password|secret|token/i
+          hash[key] = '[FILTERED]'
+        elsif value.is_a?(Hash)
+          filter_passwords(value)
+        elsif value.is_a?(Array)
+          value.each { |v| filter_passwords(v) if v.is_a?(Hash) }
+        end
+      end
+      hash
+    end
+  end
+end

data/lib/rails_exception_log/version.rb

@@ -0,0 +1,3 @@
+module RailsExceptionLog
+  VERSION = '1.0.0'
+end

data/lib/rails_exception_log.rb

@@ -0,0 +1,23 @@
+require 'rails_exception_log/engine'
+require 'rails_exception_log/version'
+
+module RailsExceptionLog
+  mattr_accessor :application_name, default: 'Rails Exception Log'
+
+  mattr_accessor :before_log_exception do |_controller|
+    true
+  end
+
+  mattr_accessor :after_log_exception do |logged_exception|
+  end
+
+  mattr_accessor :max_requests_per_minute, default: 60
+
+  mattr_accessor :enable_user_tracking, default: true
+
+  mattr_accessor :filter_parameters, default: %i[password secret token api_key]
+
+  def self.configure
+    yield self
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rails_exception_log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- "Tamiru Hailu\n  "
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A beautiful exception logging gem that stores Rails exceptions in a database
+  with a modern Tailwind UI dashboard
+email:
+- tamiruhailu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/assets/config/tailwind.config.js
+- app/assets/stylesheets/rails_exception_log/application.css
+- app/controllers/rails_exception_log/application_controller.rb
+- app/controllers/rails_exception_log/logged_exceptions_controller.rb
+- app/helpers/rails_exception_log/application_helper.rb
+- app/javascript/controllers/dropdown_controller.js
+- app/javascript/index.js
+- app/models/rails_exception_log/logged_exception.rb
+- app/views/rails_exception_log/logged_exceptions/index.html.erb
+- app/views/rails_exception_log/logged_exceptions/show.html.erb
+- config/routes.rb
+- db/migrate/20240101000000_create_rails_exception_log_logged_exceptions.rb
+- lib/generators/rails_exception_log/install_generator.rb
+- lib/rails_exception_log.rb
+- lib/rails_exception_log/engine.rb
+- lib/rails_exception_log/exception_loggable.rb
+- lib/rails_exception_log/version.rb
+homepage: https://github.com/tamiru/rails_exception_log
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/yourusername/rails_exception_log/issues
+  changelog_uri: https://github.com/tamiru/rails_exception_log/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/tamiru/rails_exception_log#readme
+  homepage_uri: https://github.com/tamiru/rails_exception_log
+  source_code_uri: https://github.com/tamiru/rails_exception_log
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.9
+specification_version: 4
+summary: Modern exception logging gem with Tailwind UI for Rails 7 and 8
+test_files: []