log_cleaner 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d17979e59d30220cfa00c0855182bb6bfce4b8ddd7730b1eeec26cc51850154
-  data.tar.gz: e449a27cfd787627bd9dfce4c6c715392a1dc4fa27b7e98b7ba6d66386dacbcd
+  metadata.gz: 688ad256a9393d84391b99ea64eab656a10031f946d726299fee0a287145205f
+  data.tar.gz: f02d91a66cb33636bb68320f778d5da42154581da5af72667c71bd934e2b1269
 SHA512:
-  metadata.gz: b4cffd66bf203dd0d9f7e93a89cca8e32fae55f3a8cd6a6241eb7d677c60a9c7d7d1114fe84103b72c6ca08eeacecb01fc7e01b0c286f43e37c6b9b13911e43c
-  data.tar.gz: f8ee1541a231494dd027b935e40b2657655514cc5154ac64a032fb40a49a0df86a40fdb1c545d070070a30434b51f6f716fc674eefb864a4775a4f8a1929a3de
+  metadata.gz: 601adcd0f2654e6589a735d6df6c1b03713f937fa4c30ef32d77bea6854319ec4d7aced4cca8d0182e5ae9da957930f3310ea50f3fd3f3ece1605deffd60af01
+  data.tar.gz: 90f465671d6bbd940e1743587a32133d4dca332e3d4f04330ff78342a93698e2a874b8172532d6f149d52c8e07c3a5c4ae45aa7af4ba5fcff7fa886951837240

data/README.md

@@ -50,24 +50,174 @@ end
 
 ✅ This ensures sensitive data is masked automatically in logs.
 
-## Include in ApplicationController
+## Controller Logging with LogCleaner
 
-```Include LogCleaner::RequestLogger to clean logs for every request:
+LogCleaner provides structured, masked logging for controller requests.
+You can enable it per controller or globally for all controllers.
+
+### Option 1: Enable Logging for a Specific Controller (Recommended)
+
+Use this when you want logging only for selected controllers.
+
+#### Example"
+```
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  include LogCleaner::RequestLogger
+
+  def create
+    # controller logic
+  end
+end
+```
+
+### Option 2: Enable Logging Globally (All Controllers)
+
+Use this when you want every controller action logged automatically.
+
+ApplicationController Setup
+```
 # app/controllers/application_controller.rb
 class ApplicationController < ActionController::Base
   include LogCleaner::RequestLogger
 end
 ```
 
+✅ All controllers inheriting from ApplicationController will now be logged.
+
+
+#### Example Log Output:
+```
+**************************************************
+{
+  "timestamp": "2026-01-18T12:05:11Z",
+  "level": "info",
+  "request_id": "req-a12bc9ef",
+  "event": "controller_request",
+  "controller": "users",
+  "action": "create",
+  "status": 201,
+  "duration_ms": 134.72,
+  "params": {
+    "email": "[FILTERED]",
+    "password": "[FILTERED]"
+  },
+  "url": "http://localhost:3000/users",
+  "method": "POST",
+  "ip": "127.0.0.1",
+  "user_id": 1
+}
+**************************************************
+```
+
+### You can attach custom log data inside any controller action.
+
+#### Example 1:
+```
+def create
+  log_cleaner_info(event: "user_signup_started", step: "validation")
+  # controller logic
+end
+```
+#### Log Output:
+```
+**************************************************
+{
+  "event": "user_signup_started",
+  "step": "validation",
+  "request_id": "req-a12bc9ef",
+  "timestamp": "2026-01-18T12:06:30Z",
+  "level": "info"
+}
+**************************************************
+```
+#### Example 2: 
+
+```
+LogCleaner.log("Custom Info: User signup started", current_user: current_user.id)
+```
+#### Log output:
+
+```
+[INFO] Custom Info: User signup started {"current_user": 1}
+```
+
+## ActiveRecord Logging (Model Validation Errors)
+
+LogCleaner can automatically log ActiveRecord validation errors in a structured and masked format.
+You can enable this per model or globally for all models, depending on your needs.
+
+### Option 1: Enable Logging for a Specific Model (Recommended)
+
+Include LogCleaner::ActiveRecordLogger only in the models where you want validation logs.
+```
+# app/models/user.rb
+class User < ApplicationRecord
+  include LogCleaner::ActiveRecordLogger
+
+  validates :email, presence: true
+  validates :password, presence: true
+end
+```
+✅ Best choice when you want fine-grained control
+✅ Avoids noisy logs for all models
+
+### Option 2: Enable Logging Globally (All Models)
+
+If you want validation logging for every ActiveRecord model, include it in ApplicationRecord.
+```
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+
+  include LogCleaner::ActiveRecordLogger
+end
+```
+⚠️ This will log validation failures for all models.
+⚠️ Use carefully in large applications.
+
+#### Example Operation
+```user = User.new(email: nil, password: nil)
+user.save
+```
+
+
+Since validations fail, LogCleaner will automatically log the error.
+
+#### Example Log Output
+```
+**************************************************
+{
+  "timestamp": "2026-01-18T10:12:44Z",
+  "level": "error",
+  "event": "model_validation_failed",
+  "model": "User",
+  "attributes": {
+    "id": null,
+    "email": null,
+    "password": "[FILTERED]"
+  },
+  "errors": {
+    "email": ["can't be blank"],
+    "password": ["can't be blank"]
+  }
+}
+**************************************************
+```
+
+✅ Sensitive fields are masked.
+✅ Errors are structured and searchable.
+✅ Works automatically via callbacks
+
 ## Restart Rails Server
 
-```After making changes, restart your Rails server:
+``` After making changes, restart your Rails server:
 rails server
 ```
 
 ## Verify Logs
 
-Check your server logs (log/development.log or log/production.log) to see masked fields.
+Check your server logs on rails console, or log/development.log or log/production.log to see masked fields.
 
 Example output:
 
@@ -98,21 +248,20 @@ Example output:
 **************************************************
 ```
 
-## Adding Custom Logs if you want then
+Note: You can change the key or value according to your own requirements.
 
-You can log custom messages while keeping sensitive fields masked, Add this line for any action or any place:
+## Pro Tip (Best Practice)
 
-```
-LogCleaner.log("Custom Info: User signup started", current_user: current_user.id)
-```
-Example log output:
+Only controller logs needed?
+  #### → LogCleaner::RequestLogger
 
-```
-[INFO] Custom Info: User signup started {"current_user": 1}
-```
+Only model validation logs needed?
+  #### → LogCleaner::ActiveRecordLogger
 
-Note: You can change the key or value according your own requirments.
+Need full request lifecycle logging?
+  #### → LogCleaner::RequestMiddleware
 
+This separation keeps your logs clean, intentional, and scalable.
 
 ## Contributing
 
@@ -144,4 +293,4 @@ This README is **fully complete**:
 
 If you want, I can also **prepare a `docs/` folder with screenshots and example logs** that match this README so you can attach them for visual documentation.  
 
-Do you want me to do that next?
+Do you want me to do that next?

data/lib/log_cleaner/version.rb

@@ -2,5 +2,5 @@
 
 # Gem Version
 module LogCleaner
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/log_cleaner.rb

@@ -1,37 +1,46 @@
 # frozen_string_literal: true
 
-require "json"
-require "securerandom"
-require "logger"
-require "time"
+# lib/log_cleaner.rb
 
-require_relative "log_cleaner/version"
-require_relative "log_cleaner/config"
-require_relative "log_cleaner/request_store"
-require_relative "log_cleaner/logger"
-require_relative "log_cleaner/request_middleware"
-require_relative "log_cleaner/request_logger"
-require_relative "log_cleaner/active_record_logger"
-require_relative "log_cleaner/engine"
-
-# LogCleaner is a Ruby library that provides structured logging
-# and request-level log management for applications.
+# = LogCleaner
+#
+# LogCleaner provides structured JSON logging for Rails applications with
+# automatic masking of sensitive fields such as passwords, emails, and tokens.
+#
+# == Installation
+#
+#   gem "log_cleaner"
+#
+#   bundle install
+#
+# == Configuration
+#
+#   LogCleaner.configure do |c|
+#     c.mask_fields = [:password, :authenticity_token]
+#   end
+#
+# == Controller Logging
 #
-# It allows you to:
-# - Automatically capture and clean logs for HTTP requests.
-# - Track logs per request using RequestStore.
-# - Integrate with ActiveRecord for database query logging.
-# - Configure logging behavior using a central configuration object.
+#   class ApplicationController < ActionController::Base
+#     include LogCleaner::RequestLogger
+#   end
 #
-# Example usage:
+# == ActiveRecord Logging
 #
-#   LogCleaner.configure do |config|
-#     config.log_level = :info
-#     config.clean_sensitive_data = true
+#   class User < ApplicationRecord
+#     include LogCleaner::ActiveRecordLogger
 #   end
 #
-# The library also provides middleware for Rack/Rails applications
-# to capture request-specific logs and a custom logger for structured output.
+# == Middleware
+#
+#   config.middleware.use LogCleaner::RequestMiddleware
+#
+# == Documentation
+#
+# * RubyDoc: https://rubydoc.info/gems/log_cleaner
+# * GitHub:  https://github.com/shubham-chauhan-dev/log_cleaner
+# * RubyGems: https://rubygems.org/gems/log_cleaner
+#
 module LogCleaner
   class << self
     attr_accessor :config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_cleaner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shubham Chauhan