queryable_logs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23b8ae959b8c34959d0db89adfcba5e50b38011264947b4de53f626bd4d1bb64
-  data.tar.gz: 1f9aeb0b1b2b5b8c40f0bb4245859ed06d72066f45abf6aac885f295cf0e6964
+  metadata.gz: 24a41e93a9b5a82d65308c7a0328fe06e09e258da2bbdecf22318787f8b7bd12
+  data.tar.gz: fa7a6fcb05f84ef1e93c46f615fd24e61a378b6a94b45654b3d5a67cffe8a9c1
 SHA512:
-  metadata.gz: 13c600df1ba652861169e0b9495dd1d98a71723d8e663a8b219a4c8ad872f04d906453e593cfc70e3b8ef7d8d927bdca53666c08fa268b0cd0637cf3736dcc41
-  data.tar.gz: 6cd4fb3c21e7e4e513e6df4a7aad840f34cb9512d5d79cc4d7004f83aa8896d89d66ad7ebb27dba3084e66421916c86c0e2ebbc856fd2062b84b2f3018db142a
+  metadata.gz: 7be44957dc9085326c0316c9f3494376886e6a486e930ea2d74e79456e10f33d4eb788ee45876bb46c3bb94f1dee20c69e9940d374a8c7b8a1587dfed8892def
+  data.tar.gz: 80ca1801204f4c5bda12e7a36a38563959b14aae1eb3cccf866da873ff9b0ee764153c0e91025ae150380cd1d7011a541b944eb7bde506b91573d3df7b9ee649

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    queryable_logs (0.1.0)
+    queryable_logs (0.1.1)
       rails (>= 4)
 
 GEM

data/README.md

@@ -21,12 +21,54 @@ Or install it yourself as:
 Run
     `rails g queryable_logs`.
 
-This will generate a migration file and an initializer file. queryable_logs also logs the current user id. Let the gem know which method you are using to get the current user. Default is set to `current_user`.
+This will generate a migration file.
+```ruby
+class CreateTrailLogs < ActiveRecord::Migration
+  def change
+    create_table :trail_logs do |t|
+      t.integer :user_id
+      t.string :ip_address
+      t.string :controller
+      t.string :action
+      t.string :format
+      t.string :http_verb
+      t.text :params_hash
+      t.datetime :logged_at
+      t.string :response_code
+      t.string :request_url
+      t.string :sig
+
+      t.timestamps null: false
+    end
+  end
+end
+```
+and an initializer file.
+```ruby
+class Trail
+  cattr_accessor :current_user_method, :logger, :saving_logs
+  LogFile = Rails.root.join('log', 'trail.log')
+  delegate :debug, :info, :warn, :error, :fatal, :to => :logger
+end
+
+Trail.logger = Logger.new(Trail::LogFile)
+Trail.logger.level = 'info' # could be debug, info, warn, error or fatal
+Trail.current_user_method = :current_user
+```
+queryable_logs also logs the current user id. Let the gem know which method you are using to get the current user. Default is set to `current_user`.
+
+Finally, include the `QueryableLogs::WriteLog` in the base controller, typically the `ApplicationController`.
+```ruby
+class ApplicationController < ActionController::Base
+  include QueryableLogs::WriteLog
+end
+```
+
+Enter the following task to your crontab `rake parse:logs_to_db`
+
+eg: `0 * * * * cd /Users/akshaytakkar/sample_rails_app && /Users/akshaytakkar/.rvm/wrappers/ruby-3.1.0/rake db:parse_log_and_save_trails >> /Users/akshaytakkar/sample_rails_app/log/worker.log 2>&1`
 
-Enter the following task to your crontab
-    `rake parse:logs_to_db`
-eg:
-    `* * * * * cd /Users/akshaytakkar/sample_rails_app && /Users/akshaytakkar/.rvm/wrappers/ruby-3.1.0/rake db:parse_log_and_save_trails >> /Users/akshaytakkar/sample_rails_app/log/worker.log 2>&1`
+This will run the `rake parse:logs_to_db` rake task every hour and log any errors or output from the task to `worker.log` file.
 
 ## Usage
 

data/lib/generators/templates/initializer.rb

@@ -6,5 +6,4 @@ end
 
 Trail.logger = Logger.new(Trail::LogFile)
 Trail.logger.level = 'info' # could be debug, info, warn, error or fatal
-Trail.current_user_method = :current_user
-Trail.saving_logs = false
+Trail.current_user_method = :current_user

data/lib/queryable_logs/version.rb

@@ -1,3 +1,3 @@
 module QueryableLogs
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queryable_logs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Akshay Takkar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails